From b0cd6a95bd2e71db38ceef1d7f8be86ab1f0808d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Thu, 1 Aug 2024 07:10:03 +0000 Subject: [PATCH] feat(all): auto-regenerate discovery clients --- chat/v1/chat-api.json | 6 +- chat/v1/chat-gen.go | 6 +- chromepolicy/v1/chromepolicy-api.json | 4 +- chromepolicy/v1/chromepolicy-gen.go | 3 +- compute/v0.beta/compute-api.json | 151 ++-- compute/v0.beta/compute-gen.go | 169 +++-- compute/v0.beta/compute2-gen.go | 89 +-- compute/v0.beta/compute3-gen.go | 138 ++-- container/v1beta1/container-api.json | 4 +- container/v1beta1/container-gen.go | 2 +- discoveryengine/v1/discoveryengine-api.json | 260 +++++-- discoveryengine/v1/discoveryengine-gen.go | 584 ++++++++++++++-- .../v1alpha/discoveryengine-api.json | 183 +++-- .../v1alpha/discoveryengine-gen.go | 307 ++++++--- .../v1beta/discoveryengine-api.json | 307 +++++++-- discoveryengine/v1beta/discoveryengine-gen.go | 651 +++++++++++++++--- places/v1/places-api.json | 4 +- places/v1/places-gen.go | 6 +- 18 files changed, 2237 insertions(+), 637 deletions(-) diff --git a/chat/v1/chat-api.json b/chat/v1/chat-api.json index 124e779b833..c5db695ef3a 100644 --- a/chat/v1/chat-api.json +++ b/chat/v1/chat-api.json @@ -1241,7 +1241,7 @@ } } }, - "revision": "20240725", + "revision": "20240728", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -2368,7 +2368,7 @@ "type": "object" }, "GoogleAppsCardV1Columns": { - "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.", + "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Columns", "properties": { "columnItems": { @@ -2843,7 +2843,7 @@ "A set of radio buttons. Users can select one radio button.", "A set of switches. Users can turn on one or more switches.", "A dropdown menu. Users can select one item from the menu.", - "A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multiselect menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Multiselect for Google Workspace Add-ons are in Developer Preview." + "A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multiselect menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):" ], "type": "string" } diff --git a/chat/v1/chat-gen.go b/chat/v1/chat-gen.go index f4465648e1f..59110d20516 100644 --- a/chat/v1/chat-gen.go +++ b/chat/v1/chat-gen.go @@ -2096,8 +2096,7 @@ func (s GoogleAppsCardV1Column) MarshalJSON() ([]byte, error) { // or equal to 300 pt. * On Android devices, the second column wraps if the // screen width is less than or equal to 320 dp. To include more than 2 // columns, or to use rows, use the `Grid` widget. Google Workspace Add-ons and -// Chat apps (https://developers.google.com/workspace/extend): Columns for -// Google Workspace Add-ons are in Developer Preview. +// Chat apps (https://developers.google.com/workspace/extend): type GoogleAppsCardV1Columns struct { // ColumnItems: An array of columns. You can include up to 2 columns in a card // or dialog. @@ -2788,8 +2787,7 @@ type GoogleAppsCardV1SelectionInput struct { // multiselect menus, see [Add a multiselect // menu](https://developers.google.com/workspace/chat/design-interactive-card-di // alog#multiselect-menu). [Google Workspace Add-ons and Chat - // apps](https://developers.google.com/workspace/extend): Multiselect for - // Google Workspace Add-ons are in Developer Preview. + // apps](https://developers.google.com/workspace/extend): Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "ExternalDataSource") to // unconditionally include in API requests. By default, fields with empty or diff --git a/chromepolicy/v1/chromepolicy-api.json b/chromepolicy/v1/chromepolicy-api.json index 694e8b0abf6..e9dd08bedef 100644 --- a/chromepolicy/v1/chromepolicy-api.json +++ b/chromepolicy/v1/chromepolicy-api.json @@ -557,7 +557,7 @@ } } }, - "revision": "20240111", + "revision": "20240729", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { @@ -966,7 +966,7 @@ "type": "string" }, "scheduledToDeprecatePolicies": { - "description": "Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy. This field should not be manually set but will be set and exposed through PolicyAPI automatically.", + "description": "Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy.", "items": { "type": "string" }, diff --git a/chromepolicy/v1/chromepolicy-gen.go b/chromepolicy/v1/chromepolicy-gen.go index af4dd04140a..f90cbef5f0d 100644 --- a/chromepolicy/v1/chromepolicy-gen.go +++ b/chromepolicy/v1/chromepolicy-gen.go @@ -861,8 +861,7 @@ type GoogleChromePolicyVersionsV1PolicyApiLifecycle struct { PolicyApiLifecycleStage string `json:"policyApiLifecycleStage,omitempty"` // ScheduledToDeprecatePolicies: Corresponding to deprecated_in_favor_of, the // fully qualified namespace(s) of the old policies that will be deprecated - // because of introduction of this policy. This field should not be manually - // set but will be set and exposed through PolicyAPI automatically. + // because of introduction of this policy. ScheduledToDeprecatePolicies []string `json:"scheduledToDeprecatePolicies,omitempty"` // ForceSendFields is a list of field names (e.g. "DeprecatedInFavorOf") to // unconditionally include in API requests. By default, fields with empty or diff --git a/compute/v0.beta/compute-api.json b/compute/v0.beta/compute-api.json index 7895e57ae65..66e4e4ce316 100644 --- a/compute/v0.beta/compute-api.json +++ b/compute/v0.beta/compute-api.json @@ -6490,7 +6490,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6521,7 +6521,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6611,7 +6611,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6649,7 +6649,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6677,7 +6677,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -28824,7 +28824,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -28863,7 +28863,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -28969,7 +28969,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -41638,7 +41638,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -41677,7 +41677,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -41783,7 +41783,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -41911,7 +41911,7 @@ } } }, - "revision": "20240702", + "revision": "20240723", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -43165,6 +43165,10 @@ "format": "int32", "type": "integer" }, + "turboMode": { + "description": "Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode.", + "type": "string" + }, "visibleCoreCount": { "description": "The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.", "format": "int32", @@ -43262,6 +43266,26 @@ }, "type": "object" }, + "AllocationReservationSharingPolicy": { + "id": "AllocationReservationSharingPolicy", + "properties": { + "serviceShareType": { + "description": "Sharing config for all Google Cloud services.", + "enum": [ + "ALLOW_ALL", + "DISALLOW_ALL", + "SERVICE_SHARE_TYPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "Allow all Google Cloud managed services to share reservations.", + "[Default] Disallow sharing with all Google Cloud services.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "AllocationResourceStatus": { "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", @@ -43280,6 +43304,14 @@ "sourceInstanceTemplateId": { "description": "ID of the instance template used to populate reservation properties.", "type": "string" + }, + "utilizations": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", + "type": "object" } }, "type": "object" @@ -45114,7 +45146,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -55698,7 +55730,7 @@ "type": "array" }, "baseInstanceName": { - "description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", + "description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -56130,13 +56162,6 @@ "InstanceGroupManagerInstanceFlexibilityPolicy": { "id": "InstanceGroupManagerInstanceFlexibilityPolicy", "properties": { - "instanceSelectionLists": { - "additionalProperties": { - "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection" - }, - "description": "Named instance selections configuring properties that the group will use when creating new VMs.", - "type": "object" - }, "instanceSelections": { "additionalProperties": { "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection" @@ -63584,11 +63609,6 @@ "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.", "type": "string" }, - "instanceFlexibilityOverride": { - "$ref": "ManagedInstanceInstanceFlexibilityOverride", - "deprecated": true, - "description": "[Output Only] The overrides to instance properties resulting from InstanceFlexibilityPolicy." - }, "instanceHealth": { "description": "[Output Only] Health state of the instance per health-check.", "items": { @@ -63679,16 +63699,6 @@ }, "type": "object" }, - "ManagedInstanceInstanceFlexibilityOverride": { - "id": "ManagedInstanceInstanceFlexibilityOverride", - "properties": { - "machineType": { - "description": "The machine type to be used for this instance.", - "type": "string" - } - }, - "type": "object" - }, "ManagedInstanceInstanceHealth": { "id": "ManagedInstanceInstanceHealth", "properties": { @@ -66342,6 +66352,34 @@ "description": "A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.", "id": "NetworkRoutingConfig", "properties": { + "bgpAlwaysCompareMed": { + "description": "Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm.", + "type": "boolean" + }, + "bgpBestPathSelectionMode": { + "description": "The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be LEGACY (default) or STANDARD.", + "enum": [ + "LEGACY", + "STANDARD" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "bgpInterRegionCost": { + "description": "Allows to define a preferred approach for handling inter-region cost in the selection process when using the STANDARD BGP best path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED.", + "enum": [ + "ADD_COST_TO_MED", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "routingMode": { "description": "The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.", "enum": [ @@ -66423,6 +66461,11 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, "rules": { "description": "The rules that apply to the network.", "items": { @@ -66439,9 +66482,11 @@ "enum": [ "HIERARCHY", "NETWORK", + "SYSTEM", "UNSPECIFIED" ], "enumDescriptions": [ + "", "", "", "" @@ -73948,6 +73993,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "reservationSharingPolicy": { + "$ref": "AllocationReservationSharingPolicy", + "description": "Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services." + }, "resourcePolicies": { "additionalProperties": { "type": "string" @@ -75489,6 +75538,11 @@ "description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/", "type": "string" }, + "nextHopInterRegionCost": { + "description": "[Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.", + "format": "uint32", + "type": "integer" + }, "nextHopInterconnectAttachment": { "description": "[Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.", "type": "string" @@ -75497,10 +75551,29 @@ "description": "The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.", "type": "string" }, + "nextHopMed": { + "description": "[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.", + "format": "uint32", + "type": "integer" + }, "nextHopNetwork": { "description": "The URL of the local network if it should handle matching packets.", "type": "string" }, + "nextHopOrigin": { + "description": "[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.", + "enum": [ + "EGP", + "IGP", + "INCOMPLETE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, "nextHopPeering": { "description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.", "type": "string" @@ -85747,7 +85820,7 @@ "type": "string" }, "certificateMap": { - "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.", + "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.", "type": "string" }, "creationTimestamp": { @@ -85821,7 +85894,7 @@ "type": "string" }, "sslCertificates": { - "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.", + "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}. ", "items": { "type": "string" }, @@ -88774,7 +88847,7 @@ "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, "defaultService": { - "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", + "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "string" }, "defaultUrlRedirect": { diff --git a/compute/v0.beta/compute-gen.go b/compute/v0.beta/compute-gen.go index 23a0abfaf95..0b68eb02d6f 100644 --- a/compute/v0.beta/compute-gen.go +++ b/compute/v0.beta/compute-gen.go @@ -2694,6 +2694,10 @@ type AdvancedMachineFeatures struct { // simultaneous multithreading (SMT) set this to 1. If unset, the maximum // number of threads supported per core by the underlying processor is assumed. ThreadsPerCore int64 `json:"threadsPerCore,omitempty"` + // TurboMode: Turbo frequency mode to use for the instance. Supported modes + // include: * ALL_CORE_MAX Using empty string or not setting this field will + // use the platform-specific default turbo mode. + TurboMode string `json:"turboMode,omitempty"` // VisibleCoreCount: The number of physical cores to expose to an instance. // Multiply by the number of threads per core to compute the total number of // virtual CPUs to expose to the instance. If unset, the number of cores is @@ -2838,6 +2842,34 @@ func (s AllocationAggregateReservationReservedResourceInfoAccelerator) MarshalJS return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +type AllocationReservationSharingPolicy struct { + // ServiceShareType: Sharing config for all Google Cloud services. + // + // Possible values: + // "ALLOW_ALL" - Allow all Google Cloud managed services to share + // reservations. + // "DISALLOW_ALL" - [Default] Disallow sharing with all Google Cloud + // services. + // "SERVICE_SHARE_TYPE_UNSPECIFIED" + ServiceShareType string `json:"serviceShareType,omitempty"` + // ForceSendFields is a list of field names (e.g. "ServiceShareType") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ServiceShareType") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s AllocationReservationSharingPolicy) MarshalJSON() ([]byte, error) { + type NoMethod AllocationReservationSharingPolicy + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // AllocationResourceStatus: [Output Only] Contains output only fields. type AllocationResourceStatus struct { // SpecificSkuAllocation: Allocation Properties of this reservation. @@ -2866,6 +2898,9 @@ type AllocationResourceStatusSpecificSKUAllocation struct { // SourceInstanceTemplateId: ID of the instance template used to populate // reservation properties. SourceInstanceTemplateId string `json:"sourceInstanceTemplateId,omitempty"` + // Utilizations: Per service utilization breakdown. The Key is the Google Cloud + // managed service name. + Utilizations map[string]string `json:"utilizations,omitempty"` // ForceSendFields is a list of field names (e.g. "SourceInstanceTemplateId") // to unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See @@ -5156,11 +5191,13 @@ type BackendService struct { // - A regional backend service with the service_protocol set to HTTP, HTTPS, // or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global // backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, - // INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and - // this field is not set to MAGLEV or RING_HASH, session affinity settings will - // not take effect. Only ROUND_ROBIN and RING_HASH are supported when the - // backend service is referenced by a URL map that is bound to target gRPC - // proxy that has validateForProxyless field set to true. + // INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not + // configured—that is, if session affinity remains at the default value of + // NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If + // session affinity is set to a value other than NONE, then the default value + // for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported + // when the backend service is referenced by a URL map that is bound to target + // gRPC proxy that has validateForProxyless field set to true. // // Possible values: // "INVALID_LB_POLICY" @@ -17408,7 +17445,7 @@ type InstanceGroupManager struct { // more hash symbols. The hash symbols indicate the number of digits. For // example, a base instance name of "vm-###" results in "vm-001" as a VM name. // @pattern a-z - // (([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + // (([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?)) BaseInstanceName string `json:"baseInstanceName,omitempty"` // CreationTimestamp: [Output Only] The creation timestamp for this managed // instance group in RFC3339 text format. @@ -17836,24 +17873,21 @@ func (s InstanceGroupManagerAutoHealingPolicy) MarshalJSON() ([]byte, error) { } type InstanceGroupManagerInstanceFlexibilityPolicy struct { - // InstanceSelectionLists: Named instance selections configuring properties - // that the group will use when creating new VMs. - InstanceSelectionLists map[string]InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection `json:"instanceSelectionLists,omitempty"` // InstanceSelections: Named instance selections configuring properties that // the group will use when creating new VMs. InstanceSelections map[string]InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection `json:"instanceSelections,omitempty"` // ProvisioningModelMix: Provisioning model configuration used by this managed // instance group to create instances. ProvisioningModelMix *InstanceGroupManagerInstanceFlexibilityPolicyProvisioningModelMix `json:"provisioningModelMix,omitempty"` - // ForceSendFields is a list of field names (e.g. "InstanceSelectionLists") to + // ForceSendFields is a list of field names (e.g. "InstanceSelections") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "InstanceSelectionLists") to - // include in API requests with the JSON null value. By default, fields with - // empty values are omitted from API requests. See + // NullFields is a list of field names (e.g. "InstanceSelections") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -26412,9 +26446,6 @@ type ManagedInstance struct { // Instance: [Output Only] The URL of the instance. The URL can exist even if // the instance has not yet been created. Instance string `json:"instance,omitempty"` - // InstanceFlexibilityOverride: [Output Only] The overrides to instance - // properties resulting from InstanceFlexibilityPolicy. - InstanceFlexibilityOverride *ManagedInstanceInstanceFlexibilityOverride `json:"instanceFlexibilityOverride,omitempty"` // InstanceHealth: [Output Only] Health state of the instance per health-check. InstanceHealth []*ManagedInstanceInstanceHealth `json:"instanceHealth,omitempty"` // InstanceStatus: [Output Only] The status of the instance. This field is @@ -26506,27 +26537,6 @@ func (s ManagedInstanceAllInstancesConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -type ManagedInstanceInstanceFlexibilityOverride struct { - // MachineType: The machine type to be used for this instance. - MachineType string `json:"machineType,omitempty"` - // ForceSendFields is a list of field names (e.g. "MachineType") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "MachineType") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s ManagedInstanceInstanceFlexibilityOverride) MarshalJSON() ([]byte, error) { - type NoMethod ManagedInstanceInstanceFlexibilityOverride - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - type ManagedInstanceInstanceHealth struct { // DetailedHealthState: [Output Only] The current detailed instance health // state. @@ -29518,6 +29528,26 @@ func (s NetworkPerformanceConfig) MarshalJSON() ([]byte, error) { // network, and a flag indicating the type of routing behavior to enforce // network-wide. type NetworkRoutingConfig struct { + // BgpAlwaysCompareMed: Enable comparison of Multi-Exit Discriminators (MED) + // across routes with different neighbor ASNs when using the STANDARD BGP best + // path selection algorithm. + BgpAlwaysCompareMed bool `json:"bgpAlwaysCompareMed,omitempty"` + // BgpBestPathSelectionMode: The BGP best path selection algorithm to be + // employed within this network for dynamic routes learned by Cloud Routers. + // Can be LEGACY (default) or STANDARD. + // + // Possible values: + // "LEGACY" + // "STANDARD" + BgpBestPathSelectionMode string `json:"bgpBestPathSelectionMode,omitempty"` + // BgpInterRegionCost: Allows to define a preferred approach for handling + // inter-region cost in the selection process when using the STANDARD BGP best + // path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED. + // + // Possible values: + // "ADD_COST_TO_MED" + // "DEFAULT" + BgpInterRegionCost string `json:"bgpInterRegionCost,omitempty"` // RoutingMode: The network-wide routing mode to use. If set to REGIONAL, this // network's Cloud Routers will only advertise routes with subnets of this // network in the same region as the router. If set to GLOBAL, this network's @@ -29528,15 +29558,15 @@ type NetworkRoutingConfig struct { // "GLOBAL" // "REGIONAL" RoutingMode string `json:"routingMode,omitempty"` - // ForceSendFields is a list of field names (e.g. "RoutingMode") to + // ForceSendFields is a list of field names (e.g. "BgpAlwaysCompareMed") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "RoutingMode") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See + // NullFields is a list of field names (e.g. "BgpAlwaysCompareMed") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. NullFields []string `json:"-"` } @@ -29619,6 +29649,9 @@ type NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy struct { DisplayName string `json:"displayName,omitempty"` // Name: [Output Only] The name of the firewall policy. Name string `json:"name,omitempty"` + // Priority: [Output only] Priority of firewall policy association. Not + // applicable for type=HIERARCHY. + Priority int64 `json:"priority,omitempty"` // Rules: The rules that apply to the network. Rules []*FirewallPolicyRule `json:"rules,omitempty"` // ShortName: [Output Only] The short name of the firewall policy. @@ -29628,6 +29661,7 @@ type NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy struct { // Possible values: // "HIERARCHY" // "NETWORK" + // "SYSTEM" // "UNSPECIFIED" Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "DisplayName") to @@ -37812,6 +37846,10 @@ type Reservation struct { // must be a dash, lowercase letter, or digit, except the last character, which // cannot be a dash. Name string `json:"name,omitempty"` + // ReservationSharingPolicy: Specify the reservation sharing policy. If + // unspecified, the reservation will not be shared with Google Cloud managed + // services. + ReservationSharingPolicy *AllocationReservationSharingPolicy `json:"reservationSharingPolicy,omitempty"` // ResourcePolicies: Resource policies to be added to this reservation. The key // is defined by user, and the value is resource policy url. This is to define // placement policy with reservation. @@ -39503,6 +39541,10 @@ type Route struct { // You can specify this as a full or partial URL. For example: // https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ NextHopInstance string `json:"nextHopInstance,omitempty"` + // NextHopInterRegionCost: [Output only] Internal fixed region-to-region cost + // that Google Cloud calculates based on factors such as network performance, + // distance, and available bandwidth between regions. + NextHopInterRegionCost int64 `json:"nextHopInterRegionCost,omitempty"` // NextHopInterconnectAttachment: [Output Only] The URL to an // InterconnectAttachment which is the next hop for the route. This field will // only be populated for the dynamic routes generated by Cloud Router with a @@ -39515,9 +39557,20 @@ type Route struct { // addresses will be displayed using RFC 5952 compressed format (e.g. // 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. NextHopIp string `json:"nextHopIp,omitempty"` + // NextHopMed: [Output Only] Multi-Exit Discriminator, a BGP route metric that + // indicates the desirability of a particular route in a network. + NextHopMed int64 `json:"nextHopMed,omitempty"` // NextHopNetwork: The URL of the local network if it should handle matching // packets. NextHopNetwork string `json:"nextHopNetwork,omitempty"` + // NextHopOrigin: [Output Only] Indicates the origin of the route. Can be IGP + // (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. + // + // Possible values: + // "EGP" + // "IGP" + // "INCOMPLETE" + NextHopOrigin string `json:"nextHopOrigin,omitempty"` // NextHopPeering: [Output Only] The network peering name that should handle // matching packets, which should conform to RFC1035. NextHopPeering string `json:"nextHopPeering,omitempty"` @@ -50530,8 +50583,10 @@ type TargetHttpsProxy struct { AuthorizationPolicy string `json:"authorizationPolicy,omitempty"` // CertificateMap: URL of a certificate map that identifies a certificate map // associated with the given target proxy. This field can only be set for - // global target proxies. If set, sslCertificates will be ignored. Accepted - // format is //certificatemanager.googleapis.com/projects/{project + // Global external Application Load Balancer or Classic Application Load + // Balancer. For other products use Certificate Manager Certificates instead. + // If set, sslCertificates will be ignored. Accepted format is + // //certificatemanager.googleapis.com/projects/{project // }/locations/{location}/certificateMaps/{resourceName}. CertificateMap string `json:"certificateMap,omitempty"` // CreationTimestamp: [Output Only] Creation timestamp in RFC3339 text format. @@ -50621,9 +50676,19 @@ type TargetHttpsProxy struct { ServerTlsPolicy string `json:"serverTlsPolicy,omitempty"` // SslCertificates: URLs to SslCertificate resources that are used to // authenticate connections between users and the load balancer. At least one - // SSL certificate must be specified. Currently, you may specify up to 15 SSL - // certificates. sslCertificates do not apply when the load balancing scheme is - // set to INTERNAL_SELF_MANAGED. + // SSL certificate must be specified. SslCertificates do not apply when the + // load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer + // to a SSL Certificate resource or Certificate Manager Certificate resource. + // Mixing Classic Certificates and Certificate Manager Certificates is not + // allowed. Certificate Manager Certificates must include the + // certificatemanager API. Certificate Manager Certificates are not supported + // by Global external Application Load Balancer or Classic Application Load + // Balancer, use certificate_map instead. Currently, you may specify up to 15 + // Classic SSL Certificates. Certificate Manager Certificates accepted formats + // are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ + // location}/certificates/{resourceName}. - + // https://certificatemanager.googleapis.com/v1alpha1/projects/{project + // }/locations/{location}/certificates/{resourceName}. SslCertificates []string `json:"sslCertificates,omitempty"` // SslPolicy: URL of SslPolicy resource that will be associated with the // TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no @@ -53874,12 +53939,12 @@ type UrlMap struct { // defaultRouteAction is also specified, advanced routing actions, such as URL // rewrites, take effect before sending the request to the backend. However, if // defaultService is specified, defaultRouteAction cannot contain any - // weightedBackendServices. Conversely, if routeAction specifies any - // weightedBackendServices, service must not be specified. If defaultService is - // specified, then set either defaultUrlRedirect , or - // defaultRouteAction.weightedBackendService Don't set both. defaultService has - // no effect when the URL map is bound to a target gRPC proxy that has the - // validateForProxyless field set to true. + // defaultRouteAction.weightedBackendServices. Conversely, if + // defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, + // defaultService must not be specified. If defaultService is specified, then + // set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService + // Don't set both. defaultService has no effect when the URL map is bound to a + // target gRPC proxy that has the validateForProxyless field set to true. DefaultService string `json:"defaultService,omitempty"` // DefaultUrlRedirect: When none of the specified hostRules match, the request // is redirected to a URL specified by defaultUrlRedirect. If diff --git a/compute/v0.beta/compute2-gen.go b/compute/v0.beta/compute2-gen.go index d0209f40972..db74c4a686b 100644 --- a/compute/v0.beta/compute2-gen.go +++ b/compute/v0.beta/compute2-gen.go @@ -19255,22 +19255,23 @@ func (c *GlobalOperationsAggregatedListCall) Pages(ctx context.Context, f func(* } type GlobalOperationsDeleteCall struct { - s *Service - project string - operation string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header + s *Service + project string + operationid string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } // Delete: Deletes the specified Operations resource. // -// - operation: Name of the Operations resource to delete. -// - project: Project ID for this request. -func (r *GlobalOperationsService) Delete(project string, operation string) *GlobalOperationsDeleteCall { +// - operation: Name of the Operations resource to delete, or its unique +// numeric identifier. +// - project: Project ID for this request. +func (r *GlobalOperationsService) Delete(project string, operationid string) *GlobalOperationsDeleteCall { c := &GlobalOperationsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project - c.operation = operation + c.operationid = operationid return c } @@ -19311,7 +19312,7 @@ func (c *GlobalOperationsDeleteCall) doRequest(alt string) (*http.Response, erro req.Header = reqHeaders googleapi.Expand(req.URL, map[string]string{ "project": c.project, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -19333,7 +19334,7 @@ func (c *GlobalOperationsDeleteCall) Do(opts ...googleapi.CallOption) error { type GlobalOperationsGetCall struct { s *Service project string - operation string + operationid string urlParams_ gensupport.URLParams ifNoneMatch_ string ctx_ context.Context @@ -19342,12 +19343,13 @@ type GlobalOperationsGetCall struct { // Get: Retrieves the specified Operations resource. // -// - operation: Name of the Operations resource to return. -// - project: Project ID for this request. -func (r *GlobalOperationsService) Get(project string, operation string) *GlobalOperationsGetCall { +// - operation: Name of the Operations resource to return, or its unique +// numeric identifier. +// - project: Project ID for this request. +func (r *GlobalOperationsService) Get(project string, operationid string) *GlobalOperationsGetCall { c := &GlobalOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project - c.operation = operation + c.operationid = operationid return c } @@ -19399,7 +19401,7 @@ func (c *GlobalOperationsGetCall) doRequest(alt string) (*http.Response, error) req.Header = reqHeaders googleapi.Expand(req.URL, map[string]string{ "project": c.project, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -19649,12 +19651,12 @@ func (c *GlobalOperationsListCall) Pages(ctx context.Context, f func(*OperationL } type GlobalOperationsWaitCall struct { - s *Service - project string - operation string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header + s *Service + project string + operationid string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } // Wait: Waits for the specified Operation resource to return as `DONE` or for @@ -19669,12 +19671,13 @@ type GlobalOperationsWaitCall struct { // actually done when the method returns. Be prepared to retry if the operation // is not `DONE`. // -// - operation: Name of the Operations resource to return. -// - project: Project ID for this request. -func (r *GlobalOperationsService) Wait(project string, operation string) *GlobalOperationsWaitCall { +// - operation: Name of the Operations resource to return, or its unique +// numeric identifier. +// - project: Project ID for this request. +func (r *GlobalOperationsService) Wait(project string, operationid string) *GlobalOperationsWaitCall { c := &GlobalOperationsWaitCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project - c.operation = operation + c.operationid = operationid return c } @@ -19715,7 +19718,7 @@ func (c *GlobalOperationsWaitCall) doRequest(alt string) (*http.Response, error) req.Header = reqHeaders googleapi.Expand(req.URL, map[string]string{ "project": c.project, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -19758,19 +19761,20 @@ func (c *GlobalOperationsWaitCall) Do(opts ...googleapi.CallOption) (*Operation, } type GlobalOrganizationOperationsDeleteCall struct { - s *Service - operation string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header + s *Service + operationid string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } // Delete: Deletes the specified Operations resource. // -// - operation: Name of the Operations resource to delete. -func (r *GlobalOrganizationOperationsService) Delete(operation string) *GlobalOrganizationOperationsDeleteCall { +// - operation: Name of the Operations resource to delete, or its unique +// numeric identifier. +func (r *GlobalOrganizationOperationsService) Delete(operationid string) *GlobalOrganizationOperationsDeleteCall { c := &GlobalOrganizationOperationsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.operation = operation + c.operationid = operationid return c } @@ -19816,7 +19820,7 @@ func (c *GlobalOrganizationOperationsDeleteCall) doRequest(alt string) (*http.Re } req.Header = reqHeaders googleapi.Expand(req.URL, map[string]string{ - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -19837,7 +19841,7 @@ func (c *GlobalOrganizationOperationsDeleteCall) Do(opts ...googleapi.CallOption type GlobalOrganizationOperationsGetCall struct { s *Service - operation string + operationid string urlParams_ gensupport.URLParams ifNoneMatch_ string ctx_ context.Context @@ -19847,10 +19851,11 @@ type GlobalOrganizationOperationsGetCall struct { // Get: Retrieves the specified Operations resource. Gets a list of operations // by making a `list()` request. // -// - operation: Name of the Operations resource to return. -func (r *GlobalOrganizationOperationsService) Get(operation string) *GlobalOrganizationOperationsGetCall { +// - operation: Name of the Operations resource to return, or its unique +// numeric identifier. +func (r *GlobalOrganizationOperationsService) Get(operationid string) *GlobalOrganizationOperationsGetCall { c := &GlobalOrganizationOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.operation = operation + c.operationid = operationid return c } @@ -19907,7 +19912,7 @@ func (c *GlobalOrganizationOperationsGetCall) doRequest(alt string) (*http.Respo } req.Header = reqHeaders googleapi.Expand(req.URL, map[string]string{ - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } diff --git a/compute/v0.beta/compute3-gen.go b/compute/v0.beta/compute3-gen.go index 0b58abb6a25..9bf8314d681 100644 --- a/compute/v0.beta/compute3-gen.go +++ b/compute/v0.beta/compute3-gen.go @@ -18068,25 +18068,26 @@ func (c *RegionNotificationEndpointsTestIamPermissionsCall) Do(opts ...googleapi } type RegionOperationsDeleteCall struct { - s *Service - project string - region string - operation string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header + s *Service + project string + region string + operationid string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } // Delete: Deletes the specified region-specific Operations resource. // -// - operation: Name of the Operations resource to delete. -// - project: Project ID for this request. -// - region: Name of the region for this request. -func (r *RegionOperationsService) Delete(project string, region string, operation string) *RegionOperationsDeleteCall { +// - operation: Name of the Operations resource to delete, or its unique +// numeric identifier. +// - project: Project ID for this request. +// - region: Name of the region for this request. +func (r *RegionOperationsService) Delete(project string, region string, operationid string) *RegionOperationsDeleteCall { c := &RegionOperationsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project c.region = region - c.operation = operation + c.operationid = operationid return c } @@ -18128,7 +18129,7 @@ func (c *RegionOperationsDeleteCall) doRequest(alt string) (*http.Response, erro googleapi.Expand(req.URL, map[string]string{ "project": c.project, "region": c.region, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -18151,7 +18152,7 @@ type RegionOperationsGetCall struct { s *Service project string region string - operation string + operationid string urlParams_ gensupport.URLParams ifNoneMatch_ string ctx_ context.Context @@ -18160,14 +18161,15 @@ type RegionOperationsGetCall struct { // Get: Retrieves the specified region-specific Operations resource. // -// - operation: Name of the Operations resource to return. -// - project: Project ID for this request. -// - region: Name of the region for this request. -func (r *RegionOperationsService) Get(project string, region string, operation string) *RegionOperationsGetCall { +// - operation: Name of the Operations resource to return, or its unique +// numeric identifier. +// - project: Project ID for this request. +// - region: Name of the region for this request. +func (r *RegionOperationsService) Get(project string, region string, operationid string) *RegionOperationsGetCall { c := &RegionOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project c.region = region - c.operation = operation + c.operationid = operationid return c } @@ -18220,7 +18222,7 @@ func (c *RegionOperationsGetCall) doRequest(alt string) (*http.Response, error) googleapi.Expand(req.URL, map[string]string{ "project": c.project, "region": c.region, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -18474,13 +18476,13 @@ func (c *RegionOperationsListCall) Pages(ctx context.Context, f func(*OperationL } type RegionOperationsWaitCall struct { - s *Service - project string - region string - operation string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header + s *Service + project string + region string + operationid string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } // Wait: Waits for the specified Operation resource to return as `DONE` or for @@ -18495,14 +18497,15 @@ type RegionOperationsWaitCall struct { // actually done when the method returns. Be prepared to retry if the operation // is not `DONE`. // -// - operation: Name of the Operations resource to return. -// - project: Project ID for this request. -// - region: Name of the region for this request. -func (r *RegionOperationsService) Wait(project string, region string, operation string) *RegionOperationsWaitCall { +// - operation: Name of the Operations resource to return, or its unique +// numeric identifier. +// - project: Project ID for this request. +// - region: Name of the region for this request. +func (r *RegionOperationsService) Wait(project string, region string, operationid string) *RegionOperationsWaitCall { c := &RegionOperationsWaitCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project c.region = region - c.operation = operation + c.operationid = operationid return c } @@ -18544,7 +18547,7 @@ func (c *RegionOperationsWaitCall) doRequest(alt string) (*http.Response, error) googleapi.Expand(req.URL, map[string]string{ "project": c.project, "region": c.region, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -55042,25 +55045,26 @@ func (c *VpnTunnelsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*Te } type ZoneOperationsDeleteCall struct { - s *Service - project string - zone string - operation string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header + s *Service + project string + zone string + operationid string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } // Delete: Deletes the specified zone-specific Operations resource. // -// - operation: Name of the Operations resource to delete. -// - project: Project ID for this request. -// - zone: Name of the zone for this request. -func (r *ZoneOperationsService) Delete(project string, zone string, operation string) *ZoneOperationsDeleteCall { +// - operation: Name of the Operations resource to delete, or its unique +// numeric identifier. +// - project: Project ID for this request. +// - zone: Name of the zone for this request. +func (r *ZoneOperationsService) Delete(project string, zone string, operationid string) *ZoneOperationsDeleteCall { c := &ZoneOperationsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project c.zone = zone - c.operation = operation + c.operationid = operationid return c } @@ -55102,7 +55106,7 @@ func (c *ZoneOperationsDeleteCall) doRequest(alt string) (*http.Response, error) googleapi.Expand(req.URL, map[string]string{ "project": c.project, "zone": c.zone, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -55125,7 +55129,7 @@ type ZoneOperationsGetCall struct { s *Service project string zone string - operation string + operationid string urlParams_ gensupport.URLParams ifNoneMatch_ string ctx_ context.Context @@ -55134,14 +55138,15 @@ type ZoneOperationsGetCall struct { // Get: Retrieves the specified zone-specific Operations resource. // -// - operation: Name of the Operations resource to return. -// - project: Project ID for this request. -// - zone: Name of the zone for this request. -func (r *ZoneOperationsService) Get(project string, zone string, operation string) *ZoneOperationsGetCall { +// - operation: Name of the Operations resource to return, or its unique +// numeric identifier. +// - project: Project ID for this request. +// - zone: Name of the zone for this request. +func (r *ZoneOperationsService) Get(project string, zone string, operationid string) *ZoneOperationsGetCall { c := &ZoneOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project c.zone = zone - c.operation = operation + c.operationid = operationid return c } @@ -55194,7 +55199,7 @@ func (c *ZoneOperationsGetCall) doRequest(alt string) (*http.Response, error) { googleapi.Expand(req.URL, map[string]string{ "project": c.project, "zone": c.zone, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } @@ -55448,13 +55453,13 @@ func (c *ZoneOperationsListCall) Pages(ctx context.Context, f func(*OperationLis } type ZoneOperationsWaitCall struct { - s *Service - project string - zone string - operation string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header + s *Service + project string + zone string + operationid string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header } // Wait: Waits for the specified Operation resource to return as `DONE` or for @@ -55468,14 +55473,15 @@ type ZoneOperationsWaitCall struct { // guarantee that the operation is actually done when the method returns. Be // prepared to retry if the operation is not `DONE`. // -// - operation: Name of the Operations resource to return. -// - project: Project ID for this request. -// - zone: Name of the zone for this request. -func (r *ZoneOperationsService) Wait(project string, zone string, operation string) *ZoneOperationsWaitCall { +// - operation: Name of the Operations resource to return, or its unique +// numeric identifier. +// - project: Project ID for this request. +// - zone: Name of the zone for this request. +func (r *ZoneOperationsService) Wait(project string, zone string, operationid string) *ZoneOperationsWaitCall { c := &ZoneOperationsWaitCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.project = project c.zone = zone - c.operation = operation + c.operationid = operationid return c } @@ -55517,7 +55523,7 @@ func (c *ZoneOperationsWaitCall) doRequest(alt string) (*http.Response, error) { googleapi.Expand(req.URL, map[string]string{ "project": c.project, "zone": c.zone, - "operation": c.operation, + "operation": c.operationid, }) return gensupport.SendRequest(c.ctx_, c.s.client, req) } diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json index 06189b487ee..10e0f18574b 100644 --- a/container/v1beta1/container-api.json +++ b/container/v1beta1/container-api.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20240708", + "revision": "20240722", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -4387,7 +4387,7 @@ "id": "EnterpriseConfig", "properties": { "clusterTier": { - "description": "Output only. cluster_tier specifies the premium tier of the cluster.", + "description": "Output only. cluster_tier indicates the effective tier of the cluster.", "enum": [ "CLUSTER_TIER_UNSPECIFIED", "STANDARD", diff --git a/container/v1beta1/container-gen.go b/container/v1beta1/container-gen.go index 2998ec40b8c..d9bd4f26d70 100644 --- a/container/v1beta1/container-gen.go +++ b/container/v1beta1/container-gen.go @@ -2350,7 +2350,7 @@ type Empty struct { // EnterpriseConfig: EnterpriseConfig is the cluster enterprise configuration. type EnterpriseConfig struct { - // ClusterTier: Output only. cluster_tier specifies the premium tier of the + // ClusterTier: Output only. cluster_tier indicates the effective tier of the // cluster. // // Possible values: diff --git a/discoveryengine/v1/discoveryengine-api.json b/discoveryengine/v1/discoveryengine-api.json index 333e32d3595..33ee40d7636 100644 --- a/discoveryengine/v1/discoveryengine-api.json +++ b/discoveryengine/v1/discoveryengine-api.json @@ -287,6 +287,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "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": "v1/{+parent}/dataStores", @@ -2438,6 +2443,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "write": { "description": "Writes a single user event.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write", @@ -3486,6 +3519,11 @@ "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": "v1/{+parent}/dataStores", @@ -5359,6 +5397,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.dataStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "write": { "description": "Writes a single user event.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write", @@ -5785,7 +5851,7 @@ } } }, - "revision": "20240715", + "revision": "20240729", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5978,7 +6044,8 @@ "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -5986,7 +6053,8 @@ "The non-answer seeking query ignored case.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." ], "type": "string" }, @@ -6537,6 +6605,10 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo", "description": "Chunk information." }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." @@ -6561,7 +6633,7 @@ "description": "Document metadata." }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -6599,6 +6671,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo", @@ -6644,6 +6735,11 @@ "pageIdentifier": { "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" @@ -6768,7 +6864,7 @@ "type": "string" }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -9347,6 +9443,10 @@ "description": "Request message for DocumentService.PurgeDocuments method.", "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequest", "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeErrorConfig", + "description": "The desired location of errors incurred during the purge." + }, "filter": { "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", "type": "string" @@ -9354,6 +9454,28 @@ "force": { "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", "type": "boolean" + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1GcsSource", + "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource", + "description": "Inline source for the input content for purge." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource": { + "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource", + "properties": { + "documents": { + "description": "Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -9377,6 +9499,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1PurgeErrorConfig": { + "description": "Configuration of destination for Purge related errors.", + "id": "GoogleCloudDiscoveryengineV1PurgeErrorConfig", + "properties": { + "gcsPrefix": { + "description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", @@ -9419,6 +9552,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest", + "properties": { + "filter": { + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", + "type": "string" + }, + "force": { + "description": "The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1Query": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1Query", @@ -9719,7 +9867,7 @@ "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -9929,6 +10077,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" @@ -10325,15 +10477,19 @@ "NON_SUMMARY_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "LLM_ADDON_NOT_ENABLED" + "LLM_ADDON_NOT_ENABLED", + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", - "The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", + "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled." + "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", + "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`." ], "type": "string" }, @@ -10966,7 +11122,8 @@ "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -10974,7 +11131,8 @@ "The non-answer seeking query ignored case.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." ], "type": "string" }, @@ -11133,6 +11291,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "description": "Chunk information." }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." @@ -11157,7 +11319,7 @@ "description": "Document metadata." }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -11195,6 +11357,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", @@ -11240,6 +11421,11 @@ "pageIdentifier": { "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" @@ -11364,7 +11550,7 @@ "type": "string" }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -12447,7 +12633,7 @@ "description": "Required. The specification of the evaluation." }, "name": { - "description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "qualityMetrics": { @@ -12524,10 +12710,6 @@ "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", "properties": { - "outputResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", - "description": "Output result indicating where the data were exported to." - }, "status": { "$ref": "GoogleRpcStatus", "description": "The status of the export operation." @@ -13059,32 +13241,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaOutputResult": { - "description": "Output result that stores the information about where the exported data is stored.", - "id": "GoogleCloudDiscoveryengineV1alphaOutputResult", - "properties": { - "bigqueryResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", - "description": "The BigQuery location where the result is stored." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { - "description": "A BigQuery output result.", - "id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", - "properties": { - "datasetId": { - "description": "The ID of a BigQuery Dataset.", - "type": "string" - }, - "tableId": { - "description": "The ID of a BigQuery Table.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", @@ -13597,7 +13753,7 @@ "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -13901,6 +14057,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" @@ -15409,7 +15569,7 @@ "description": "Required. The specification of the evaluation." }, "name": { - "description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "qualityMetrics": { @@ -16087,7 +16247,7 @@ "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -16373,6 +16533,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" diff --git a/discoveryengine/v1/discoveryengine-gen.go b/discoveryengine/v1/discoveryengine-gen.go index 4818f2ea58c..683eb107849 100644 --- a/discoveryengine/v1/discoveryengine-gen.go +++ b/discoveryengine/v1/discoveryengine-gen.go @@ -1147,6 +1147,9 @@ type GoogleCloudDiscoveryengineV1Answer struct { // includes content that may be violent or toxic. // "NO_RELEVANT_CONTENT" - The no relevant content case. Google skips the // answer if there is no relevant content in the retrieved search results. + // "JAIL_BREAKING_QUERY_IGNORED" - The jail-breaking query ignored case. For + // example, "Reply in the tone of a competing company's CEO". Google skips the + // answer if the query is classified as a jail-breaking query. AnswerSkippedReasons []string `json:"answerSkippedReasons,omitempty"` // AnswerText: The textual answer. AnswerText string `json:"answerText,omitempty"` @@ -1899,6 +1902,8 @@ func (s GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificat type GoogleCloudDiscoveryengineV1AnswerReference struct { // ChunkInfo: Chunk information. ChunkInfo *GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo `json:"chunkInfo,omitempty"` + // StructuredDocumentInfo: Structured document information. + StructuredDocumentInfo *GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo `json:"structuredDocumentInfo,omitempty"` // UnstructuredDocumentInfo: Unstructured document information. UnstructuredDocumentInfo *GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo `json:"unstructuredDocumentInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "ChunkInfo") to @@ -1927,7 +1932,10 @@ type GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo struct { Content string `json:"content,omitempty"` // DocumentMetadata: Document metadata. DocumentMetadata *GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata `json:"documentMetadata,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -1993,6 +2001,31 @@ func (s GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata) Ma return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo: +// Structured search information. +type GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo struct { + // Document: Document resource name. + Document string `json:"document,omitempty"` + // StructData: Structured search data. + StructData googleapi.RawMessage `json:"structData,omitempty"` + // ForceSendFields is a list of field names (e.g. "Document") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Document") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo: // Unstructured document information. type GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo struct { @@ -2032,6 +2065,11 @@ type GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkCon Content string `json:"content,omitempty"` // PageIdentifier: Page identifier. PageIdentifier string `json:"pageIdentifier,omitempty"` + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. + RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -2050,6 +2088,20 @@ func (s GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunk return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +func (s *GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent + var s1 struct { + RelevanceScore gensupport.JSONFloat64 `json:"relevanceScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.RelevanceScore = float64(s1.RelevanceScore) + return nil +} + // GoogleCloudDiscoveryengineV1AnswerStep: Step information. type GoogleCloudDiscoveryengineV1AnswerStep struct { // Actions: Actions. @@ -2174,7 +2226,10 @@ type GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInf Chunk string `json:"chunk,omitempty"` // Content: Chunk textual content. Content string `json:"content,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -5865,19 +5920,26 @@ func (s GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata) MarshalJSON() ([]byt // GoogleCloudDiscoveryengineV1PurgeDocumentsRequest: Request message for // DocumentService.PurgeDocuments method. type GoogleCloudDiscoveryengineV1PurgeDocumentsRequest struct { + // ErrorConfig: The desired location of errors incurred during the purge. + ErrorConfig *GoogleCloudDiscoveryengineV1PurgeErrorConfig `json:"errorConfig,omitempty"` // Filter: Required. Filter matching documents to purge. Only currently // supported value is `*` (all items). Filter string `json:"filter,omitempty"` // Force: Actually performs the purge. If `force` is set to false, return the // expected purge count without deleting any documents. Force bool `json:"force,omitempty"` - // ForceSendFields is a list of field names (e.g. "Filter") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See + // GcsSource: Cloud Storage location for the input content. Supported + // `data_schema`: * `document_id`: One valid Document.id per line. + GcsSource *GoogleCloudDiscoveryengineV1GcsSource `json:"gcsSource,omitempty"` + // InlineSource: Inline source for the input content for purge. + InlineSource *GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource `json:"inlineSource,omitempty"` + // ForceSendFields is a list of field names (e.g. "ErrorConfig") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Filter") to include in API + // NullFields is a list of field names (e.g. "ErrorConfig") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -5889,6 +5951,32 @@ func (s GoogleCloudDiscoveryengineV1PurgeDocumentsRequest) MarshalJSON() ([]byte return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource: The inline +// source for the input config for DocumentService.PurgeDocuments method. +type GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource struct { + // Documents: Required. A list of full resource name of documents to purge. In + // the format + // `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. + // Recommended max of 100 items. + Documents []string `json:"documents,omitempty"` + // ForceSendFields is a list of field names (e.g. "Documents") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Documents") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1PurgeDocumentsResponse: Response message for // DocumentService.PurgeDocuments method. If the long running operation is // successfully done, then this message is returned by the @@ -5919,6 +6007,32 @@ func (s GoogleCloudDiscoveryengineV1PurgeDocumentsResponse) MarshalJSON() ([]byt return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1PurgeErrorConfig: Configuration of destination +// for Purge related errors. +type GoogleCloudDiscoveryengineV1PurgeErrorConfig struct { + // GcsPrefix: Cloud Storage prefix for purge errors. This must be an empty, + // existing Cloud Storage directory. Purge errors are written to sharded files + // in this directory, one per line, as a JSON-encoded `google.rpc.Status` + // message. + GcsPrefix string `json:"gcsPrefix,omitempty"` + // ForceSendFields is a list of field names (e.g. "GcsPrefix") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "GcsPrefix") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1PurgeErrorConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1PurgeErrorConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata: Metadata // related to the progress of the PurgeSuggestionDenyListEntries operation. // This is returned by the google.longrunning.Operation.metadata field. @@ -5976,6 +6090,46 @@ func (s GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse) Mars return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1PurgeUserEventsRequest: Request message for +// PurgeUserEvents method. +type GoogleCloudDiscoveryengineV1PurgeUserEventsRequest struct { + // Filter: Required. The filter string to specify the events to be deleted with + // a length limit of 5,000 characters. The eligible fields for filtering are: * + // `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in + // ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying + // this will delete all events associated with a visitor. * `userId`: Double + // quoted string. Specifying this will delete all events associated with a + // user. Examples: * Deleting all events in a time range: `eventTime > + // "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * + // Deleting specific eventType: `eventType = "search" * Deleting all events + // for a specific visitor: `userPseudoId = "visitor1024" * Deleting all events + // inside a DataStore: `*` The filtering fields are assumed to have an implicit + // AND. + Filter string `json:"filter,omitempty"` + // Force: The `force` field is currently not supported. Purge user event + // requests will permanently delete all purgeable events. Once the development + // is complete: If `force` is set to false, the method will return the expected + // purge count without deleting any user events. This field will default to + // false if not included in the request. + Force bool `json:"force,omitempty"` + // ForceSendFields is a list of field names (e.g. "Filter") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Filter") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1PurgeUserEventsRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1Query: Defines a user inputed query. type GoogleCloudDiscoveryengineV1Query struct { // QueryId: Unique Id for the query. @@ -6455,9 +6609,12 @@ type GoogleCloudDiscoveryengineV1SearchRequest struct { // OrderBy: The order in which documents are returned. Documents can be ordered // by a field in an Document object. Leave it unset if ordered by relevance. // `order_by` expression is case-sensitive. For more information on ordering - // for retail search, see Ordering - // (https://cloud.google.com/retail/docs/filter-and-order#order) If this field - // is unrecognizable, an `INVALID_ARGUMENT` is returned. + // the website search results, see Order web search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + // For more information on ordering the healthcare search results, see Order + // healthcare search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the @@ -6813,6 +6970,12 @@ type GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec struc // skip generating summaries for adversarial queries and return fallback // messages instead. IgnoreAdversarialQuery bool `json:"ignoreAdversarialQuery,omitempty"` + // IgnoreLowRelevantContent: Specifies whether to filter out queries that have + // low relevance. The default value is `false`. If this field is set to + // `false`, all search results are used regardless of relevance to generate + // answers. If set to `true`, only queries with high relevance search results + // will generate answers. + IgnoreLowRelevantContent bool `json:"ignoreLowRelevantContent,omitempty"` // IgnoreNonSummarySeekingQuery: Specifies whether to filter out queries that // are not summary-seeking. The default value is `false`. Google employs // search-query classification to detect summary-seeking queries. No summary is @@ -7452,10 +7615,10 @@ type GoogleCloudDiscoveryengineV1SearchResponseSummary struct { // "SUMMARY_SKIPPED_REASON_UNSPECIFIED" - Default value. The summary skipped // reason is not specified. // "ADVERSARIAL_QUERY_IGNORED" - The adversarial query ignored case. Only - // populated when SummarySpec.ignore_adversarial_query is set to `true`. + // used when SummarySpec.ignore_adversarial_query is set to `true`. // "NON_SUMMARY_SEEKING_QUERY_IGNORED" - The non-summary seeking query - // ignored case. Only populated when - // SummarySpec.ignore_non_summary_seeking_query is set to `true`. + // ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is + // set to `true`. // "OUT_OF_DOMAIN_QUERY_IGNORED" - The out-of-domain query ignored case. // Google skips the summary if there are no high-relevance search results. For // example, the data store contains facts about company A but the user query is @@ -7465,6 +7628,12 @@ type GoogleCloudDiscoveryengineV1SearchResponseSummary struct { // includes content that may be violent or toxic. // "LLM_ADDON_NOT_ENABLED" - The LLM addon not enabled case. Google skips the // summary if the LLM addon is not enabled. + // "NO_RELEVANT_CONTENT" - The no relevant content case. Google skips the + // summary if there is no relevant content in the retrieved search results. + // "JAIL_BREAKING_QUERY_IGNORED" - The jail-breaking query ignored case. For + // example, "Reply in the tone of a competing company's CEO". Only used when + // [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is + // set to `true`. SummarySkippedReasons []string `json:"summarySkippedReasons,omitempty"` // SummaryText: The summary content. SummaryText string `json:"summaryText,omitempty"` @@ -8386,6 +8555,9 @@ type GoogleCloudDiscoveryengineV1alphaAnswer struct { // includes content that may be violent or toxic. // "NO_RELEVANT_CONTENT" - The no relevant content case. Google skips the // answer if there is no relevant content in the retrieved search results. + // "JAIL_BREAKING_QUERY_IGNORED" - The jail-breaking query ignored case. For + // example, "Reply in the tone of a competing company's CEO". Google skips the + // answer if the query is classified as a jail-breaking query. AnswerSkippedReasons []string `json:"answerSkippedReasons,omitempty"` // AnswerText: The textual answer. AnswerText string `json:"answerText,omitempty"` @@ -8540,6 +8712,8 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassi type GoogleCloudDiscoveryengineV1alphaAnswerReference struct { // ChunkInfo: Chunk information. ChunkInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo `json:"chunkInfo,omitempty"` + // StructuredDocumentInfo: Structured document information. + StructuredDocumentInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo `json:"structuredDocumentInfo,omitempty"` // UnstructuredDocumentInfo: Unstructured document information. UnstructuredDocumentInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo `json:"unstructuredDocumentInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "ChunkInfo") to @@ -8569,7 +8743,10 @@ type GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo struct { Content string `json:"content,omitempty"` // DocumentMetadata: Document metadata. DocumentMetadata *GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata `json:"documentMetadata,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -8635,6 +8812,31 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadat return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo: +// Structured search information. +type GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo struct { + // Document: Document resource name. + Document string `json:"document,omitempty"` + // StructData: Structured search data. + StructData googleapi.RawMessage `json:"structData,omitempty"` + // ForceSendFields is a list of field names (e.g. "Document") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Document") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo: // Unstructured document information. type GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo struct { @@ -8674,6 +8876,11 @@ type GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChu Content string `json:"content,omitempty"` // PageIdentifier: Page identifier. PageIdentifier string `json:"pageIdentifier,omitempty"` + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. + RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -8692,6 +8899,20 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +func (s *GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent + var s1 struct { + RelevanceScore gensupport.JSONFloat64 `json:"relevanceScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.RelevanceScore = float64(s1.RelevanceScore) + return nil +} + // GoogleCloudDiscoveryengineV1alphaAnswerStep: Step information. type GoogleCloudDiscoveryengineV1alphaAnswerStep struct { // Actions: Actions. @@ -8815,7 +9036,10 @@ type GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChu Chunk string `json:"chunk,omitempty"` // Content: Chunk textual content. Content string `json:"content,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -10313,7 +10537,7 @@ type GoogleCloudDiscoveryengineV1alphaEvaluation struct { ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // EvaluationSpec: Required. The specification of the evaluation. EvaluationSpec *GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec `json:"evaluationSpec,omitempty"` - // Name: Immutable. The full resource name of the Evaluation, in the format of + // Name: Identifier. The full resource name of the Evaluation, in the format of // `projects/{project}/locations/{location}/evaluations/{evaluation}`. This // field must be a UTF-8 encoded string with a length limit of 1024 characters. Name string `json:"name,omitempty"` @@ -10436,17 +10660,15 @@ func (s GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata) MarshalJSON() // this message is returned by the google.longrunning.Operations.response // field. type GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse struct { - // OutputResult: Output result indicating where the data were exported to. - OutputResult *GoogleCloudDiscoveryengineV1alphaOutputResult `json:"outputResult,omitempty"` // Status: The status of the export operation. Status *GoogleRpcStatus `json:"status,omitempty"` - // ForceSendFields is a list of field names (e.g. "OutputResult") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See + // ForceSendFields is a list of field names (e.g. "Status") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "OutputResult") to include in API + // NullFields is a list of field names (e.g. "Status") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -11132,54 +11354,6 @@ func (s GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse) MarshalJSON() return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1alphaOutputResult: Output result that stores the -// information about where the exported data is stored. -type GoogleCloudDiscoveryengineV1alphaOutputResult struct { - // BigqueryResult: The BigQuery location where the result is stored. - BigqueryResult *GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult `json:"bigqueryResult,omitempty"` - // ForceSendFields is a list of field names (e.g. "BigqueryResult") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BigqueryResult") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaOutputResult) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaOutputResult - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult: A -// BigQuery output result. -type GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult struct { - // DatasetId: The ID of a BigQuery Dataset. - DatasetId string `json:"datasetId,omitempty"` - // TableId: The ID of a BigQuery Table. - TableId string `json:"tableId,omitempty"` - // ForceSendFields is a list of field names (e.g. "DatasetId") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DatasetId") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleCloudDiscoveryengineV1alphaProject: Metadata and configurations for a // Google Cloud project in the service. type GoogleCloudDiscoveryengineV1alphaProject struct { @@ -11853,9 +12027,12 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // OrderBy: The order in which documents are returned. Documents can be ordered // by a field in an Document object. Leave it unset if ordered by relevance. // `order_by` expression is case-sensitive. For more information on ordering - // for retail search, see Ordering - // (https://cloud.google.com/retail/docs/filter-and-order#order) If this field - // is unrecognizable, an `INVALID_ARGUMENT` is returned. + // the website search results, see Order web search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + // For more information on ordering the healthcare search results, see Order + // healthcare search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the @@ -12355,6 +12532,12 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec // skip generating summaries for adversarial queries and return fallback // messages instead. IgnoreAdversarialQuery bool `json:"ignoreAdversarialQuery,omitempty"` + // IgnoreLowRelevantContent: Specifies whether to filter out queries that have + // low relevance. The default value is `false`. If this field is set to + // `false`, all search results are used regardless of relevance to generate + // answers. If set to `true`, only queries with high relevance search results + // will generate answers. + IgnoreLowRelevantContent bool `json:"ignoreLowRelevantContent,omitempty"` // IgnoreNonSummarySeekingQuery: Specifies whether to filter out queries that // are not summary-seeking. The default value is `false`. Google employs // search-query classification to detect summary-seeking queries. No summary is @@ -14485,7 +14668,7 @@ type GoogleCloudDiscoveryengineV1betaEvaluation struct { ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // EvaluationSpec: Required. The specification of the evaluation. EvaluationSpec *GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec `json:"evaluationSpec,omitempty"` - // Name: Immutable. The full resource name of the Evaluation, in the format of + // Name: Identifier. The full resource name of the Evaluation, in the format of // `projects/{project}/locations/{location}/evaluations/{evaluation}`. This // field must be a UTF-8 encoded string with a length limit of 1024 characters. Name string `json:"name,omitempty"` @@ -15415,9 +15598,12 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // OrderBy: The order in which documents are returned. Documents can be ordered // by a field in an Document object. Leave it unset if ordered by relevance. // `order_by` expression is case-sensitive. For more information on ordering - // for retail search, see Ordering - // (https://cloud.google.com/retail/docs/filter-and-order#order) If this field - // is unrecognizable, an `INVALID_ARGUMENT` is returned. + // the website search results, see Order web search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + // For more information on ordering the healthcare search results, see Order + // healthcare search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the @@ -15904,6 +16090,12 @@ type GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec s // skip generating summaries for adversarial queries and return fallback // messages instead. IgnoreAdversarialQuery bool `json:"ignoreAdversarialQuery,omitempty"` + // IgnoreLowRelevantContent: Specifies whether to filter out queries that have + // low relevance. The default value is `false`. If this field is set to + // `false`, all search results are used regardless of relevance to generate + // answers. If set to `true`, only queries with high relevance search results + // will generate answers. + IgnoreLowRelevantContent bool `json:"ignoreLowRelevantContent,omitempty"` // IgnoreNonSummarySeekingQuery: Specifies whether to filter out queries that // are not summary-seeking. The default value is `false`. Google employs // search-query classification to detect summary-seeking queries. No summary is @@ -17501,6 +17693,18 @@ func (c *ProjectsLocationsCollectionsDataStoresCreateCall) DataStoreId(dataStore return c } +// SkipDefaultSchemaCreation sets the optional parameter +// "skipDefaultSchemaCreation": 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. +func (c *ProjectsLocationsCollectionsDataStoresCreateCall) SkipDefaultSchemaCreation(skipDefaultSchemaCreation bool) *ProjectsLocationsCollectionsDataStoresCreateCall { + c.urlParams_.Set("skipDefaultSchemaCreation", fmt.Sprint(skipDefaultSchemaCreation)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. @@ -25510,6 +25714,114 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsImportCall) Do(opts ... return ret, nil } +type ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall struct { + s *Service + parent string + googleclouddiscoveryenginev1purgeusereventsrequest *GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Purge: Deletes permanently all user events specified by the filter provided. +// Depending on the number of events specified by the filter, this operation +// could take hours or days to complete. To test a filter, use the list command +// first. +// +// - parent: The resource name of the catalog under which the events are +// created. The format is +// `projects/${projectId}/locations/global/collections/{$collectionId}/dataSto +// res/${dataStoreId}`. +func (r *ProjectsLocationsCollectionsDataStoresUserEventsService) Purge(parent string, googleclouddiscoveryenginev1purgeusereventsrequest *GoogleCloudDiscoveryengineV1PurgeUserEventsRequest) *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall { + c := &ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddiscoveryenginev1purgeusereventsrequest = googleclouddiscoveryenginev1purgeusereventsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) Context(ctx context.Context) *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddiscoveryenginev1purgeusereventsrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/userEvents:purge") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.dataStores.userEvents.purge" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + type ProjectsLocationsCollectionsDataStoresUserEventsWriteCall struct { s *Service parent string @@ -29275,6 +29587,18 @@ func (c *ProjectsLocationsDataStoresCreateCall) DataStoreId(dataStoreId string) return c } +// SkipDefaultSchemaCreation sets the optional parameter +// "skipDefaultSchemaCreation": 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. +func (c *ProjectsLocationsDataStoresCreateCall) SkipDefaultSchemaCreation(skipDefaultSchemaCreation bool) *ProjectsLocationsDataStoresCreateCall { + c.urlParams_.Set("skipDefaultSchemaCreation", fmt.Sprint(skipDefaultSchemaCreation)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. @@ -36245,6 +36569,114 @@ func (c *ProjectsLocationsDataStoresUserEventsImportCall) Do(opts ...googleapi.C return ret, nil } +type ProjectsLocationsDataStoresUserEventsPurgeCall struct { + s *Service + parent string + googleclouddiscoveryenginev1purgeusereventsrequest *GoogleCloudDiscoveryengineV1PurgeUserEventsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Purge: Deletes permanently all user events specified by the filter provided. +// Depending on the number of events specified by the filter, this operation +// could take hours or days to complete. To test a filter, use the list command +// first. +// +// - parent: The resource name of the catalog under which the events are +// created. The format is +// `projects/${projectId}/locations/global/collections/{$collectionId}/dataSto +// res/${dataStoreId}`. +func (r *ProjectsLocationsDataStoresUserEventsService) Purge(parent string, googleclouddiscoveryenginev1purgeusereventsrequest *GoogleCloudDiscoveryengineV1PurgeUserEventsRequest) *ProjectsLocationsDataStoresUserEventsPurgeCall { + c := &ProjectsLocationsDataStoresUserEventsPurgeCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddiscoveryenginev1purgeusereventsrequest = googleclouddiscoveryenginev1purgeusereventsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresUserEventsPurgeCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) Context(ctx context.Context) *ProjectsLocationsDataStoresUserEventsPurgeCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddiscoveryenginev1purgeusereventsrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/userEvents:purge") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.dataStores.userEvents.purge" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + type ProjectsLocationsDataStoresUserEventsWriteCall struct { s *Service parent string diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 668cc35314d..cac602c4aee 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -423,6 +423,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "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", @@ -4215,6 +4220,11 @@ "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", @@ -6874,7 +6884,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, @@ -6899,7 +6909,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, @@ -6960,7 +6970,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, @@ -7060,7 +7070,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "required": true, @@ -7085,7 +7095,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "required": true, @@ -7174,7 +7184,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "required": true, @@ -7355,7 +7365,7 @@ } } }, - "revision": "20240715", + "revision": "20240729", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -9117,7 +9127,8 @@ "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -9125,7 +9136,8 @@ "The non-answer seeking query ignored case.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." ], "type": "string" }, @@ -9680,6 +9692,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "description": "Chunk information." }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." @@ -9704,7 +9720,7 @@ "description": "Document metadata." }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -9742,6 +9758,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", @@ -9787,6 +9822,11 @@ "pageIdentifier": { "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" @@ -9911,7 +9951,7 @@ "type": "string" }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -11406,6 +11446,10 @@ "description": "AclRestriction to model complex inheritance restrictions. Example: Modeling a \"Both Permit\" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --\u003e Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ] } ] } } Page_P ACL Restriction. { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_2\" }, { \"group_id\": \"group_3\" }, { \"user_id\": \"user_2\" } ], }, { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ], } ] } }", "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction", "properties": { + "idpWide": { + "description": "All users within the Identity Provider.", + "type": "boolean" + }, "principals": { "description": "List of principals.", "items": { @@ -12050,7 +12094,7 @@ "description": "Required. The specification of the evaluation." }, "name": { - "description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "qualityMetrics": { @@ -12127,10 +12171,6 @@ "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", "properties": { - "outputResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", - "description": "Output result indicating where the data were exported to." - }, "status": { "$ref": "GoogleRpcStatus", "description": "The status of the export operation." @@ -13325,32 +13365,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaOutputResult": { - "description": "Output result that stores the information about where the exported data is stored.", - "id": "GoogleCloudDiscoveryengineV1alphaOutputResult", - "properties": { - "bigqueryResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", - "description": "The BigQuery location where the result is stored." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { - "description": "A BigQuery output result.", - "id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", - "properties": { - "datasetId": { - "description": "The ID of a BigQuery Dataset.", - "type": "string" - }, - "tableId": { - "description": "The ID of a BigQuery Table.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", @@ -13621,6 +13635,24 @@ "gcsSource": { "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource", + "description": "Inline source for the input content for purge." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource": { + "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource", + "properties": { + "documents": { + "description": "Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -14316,7 +14348,7 @@ "type": "string" }, "name": { - "description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "queryEntry": { @@ -14387,7 +14419,7 @@ "type": "string" }, "name": { - "description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, @@ -14508,7 +14540,7 @@ "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -14812,6 +14844,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" @@ -15150,6 +15186,13 @@ "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, + "oneBoxResults": { + "description": "A list of One Box results. There can be multiple One Box results of different types.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult" + }, + "type": "array" + }, "queryExpansionInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", "description": "Query expansion information for the returned results." @@ -15433,6 +15476,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult": { + "description": "OneBoxResult is a holder for all results of specific type that we want to display in UI differently.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult", + "properties": { + "oneBoxType": { + "description": "The type of One Box result.", + "enum": [ + "ONE_BOX_TYPE_UNSPECIFIED", + "PEOPLE", + "ORGANIZATION", + "SLACK" + ], + "enumDescriptions": [ + "Default value. Should not be used.", + "One Box result contains people results.", + "One Box result contains organization results.", + "One Box result contains slack results." + ], + "type": "string" + }, + "searchResults": { + "description": "The search results for this One Box.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": { "description": "Information describing query expansion including whether expansion has occurred.", "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", @@ -15507,15 +15580,19 @@ "NON_SUMMARY_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "LLM_ADDON_NOT_ENABLED" + "LLM_ADDON_NOT_ENABLED", + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", - "The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", + "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled." + "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", + "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`." ], "type": "string" }, @@ -17346,7 +17423,7 @@ "description": "Required. The specification of the evaluation." }, "name": { - "description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "qualityMetrics": { @@ -18024,7 +18101,7 @@ "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -18310,6 +18387,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index 7741fe4ca3a..901514c05cb 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -3520,6 +3520,9 @@ type GoogleCloudDiscoveryengineV1alphaAnswer struct { // includes content that may be violent or toxic. // "NO_RELEVANT_CONTENT" - The no relevant content case. Google skips the // answer if there is no relevant content in the retrieved search results. + // "JAIL_BREAKING_QUERY_IGNORED" - The jail-breaking query ignored case. For + // example, "Reply in the tone of a competing company's CEO". Google skips the + // answer if the query is classified as a jail-breaking query. AnswerSkippedReasons []string `json:"answerSkippedReasons,omitempty"` // AnswerText: The textual answer. AnswerText string `json:"answerText,omitempty"` @@ -4276,6 +4279,8 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassi type GoogleCloudDiscoveryengineV1alphaAnswerReference struct { // ChunkInfo: Chunk information. ChunkInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo `json:"chunkInfo,omitempty"` + // StructuredDocumentInfo: Structured document information. + StructuredDocumentInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo `json:"structuredDocumentInfo,omitempty"` // UnstructuredDocumentInfo: Unstructured document information. UnstructuredDocumentInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo `json:"unstructuredDocumentInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "ChunkInfo") to @@ -4305,7 +4310,10 @@ type GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo struct { Content string `json:"content,omitempty"` // DocumentMetadata: Document metadata. DocumentMetadata *GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata `json:"documentMetadata,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -4371,6 +4379,31 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadat return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo: +// Structured search information. +type GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo struct { + // Document: Document resource name. + Document string `json:"document,omitempty"` + // StructData: Structured search data. + StructData googleapi.RawMessage `json:"structData,omitempty"` + // ForceSendFields is a list of field names (e.g. "Document") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Document") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo: // Unstructured document information. type GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo struct { @@ -4410,6 +4443,11 @@ type GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChu Content string `json:"content,omitempty"` // PageIdentifier: Page identifier. PageIdentifier string `json:"pageIdentifier,omitempty"` + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. + RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -4428,6 +4466,20 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +func (s *GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent + var s1 struct { + RelevanceScore gensupport.JSONFloat64 `json:"relevanceScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.RelevanceScore = float64(s1.RelevanceScore) + return nil +} + // GoogleCloudDiscoveryengineV1alphaAnswerStep: Step information. type GoogleCloudDiscoveryengineV1alphaAnswerStep struct { // Actions: Actions. @@ -4551,7 +4603,10 @@ type GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChu Chunk string `json:"chunk,omitempty"` // Content: Chunk textual content. Content string `json:"content,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -6630,15 +6685,17 @@ func (s GoogleCloudDiscoveryengineV1alphaDocumentAclInfo) MarshalJSON() ([]byte, // "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } // } type GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction struct { + // IdpWide: All users within the Identity Provider. + IdpWide bool `json:"idpWide,omitempty"` // Principals: List of principals. Principals []*GoogleCloudDiscoveryengineV1alphaPrincipal `json:"principals,omitempty"` - // ForceSendFields is a list of field names (e.g. "Principals") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See + // ForceSendFields is a list of field names (e.g. "IdpWide") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Principals") to include in API + // NullFields is a list of field names (e.g. "IdpWide") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -7572,7 +7629,7 @@ type GoogleCloudDiscoveryengineV1alphaEvaluation struct { ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // EvaluationSpec: Required. The specification of the evaluation. EvaluationSpec *GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec `json:"evaluationSpec,omitempty"` - // Name: Immutable. The full resource name of the Evaluation, in the format of + // Name: Identifier. The full resource name of the Evaluation, in the format of // `projects/{project}/locations/{location}/evaluations/{evaluation}`. This // field must be a UTF-8 encoded string with a length limit of 1024 characters. Name string `json:"name,omitempty"` @@ -7698,17 +7755,15 @@ func (s GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata) MarshalJSON() // this message is returned by the google.longrunning.Operations.response // field. type GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse struct { - // OutputResult: Output result indicating where the data were exported to. - OutputResult *GoogleCloudDiscoveryengineV1alphaOutputResult `json:"outputResult,omitempty"` // Status: The status of the export operation. Status *GoogleRpcStatus `json:"status,omitempty"` - // ForceSendFields is a list of field names (e.g. "OutputResult") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See + // ForceSendFields is a list of field names (e.g. "Status") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "OutputResult") to include in API + // NullFields is a list of field names (e.g. "Status") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -9434,54 +9489,6 @@ func (s *GoogleCloudDiscoveryengineV1alphaMediaInfo) UnmarshalJSON(data []byte) return nil } -// GoogleCloudDiscoveryengineV1alphaOutputResult: Output result that stores the -// information about where the exported data is stored. -type GoogleCloudDiscoveryengineV1alphaOutputResult struct { - // BigqueryResult: The BigQuery location where the result is stored. - BigqueryResult *GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult `json:"bigqueryResult,omitempty"` - // ForceSendFields is a list of field names (e.g. "BigqueryResult") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BigqueryResult") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaOutputResult) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaOutputResult - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult: A -// BigQuery output result. -type GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult struct { - // DatasetId: The ID of a BigQuery Dataset. - DatasetId string `json:"datasetId,omitempty"` - // TableId: The ID of a BigQuery Table. - TableId string `json:"tableId,omitempty"` - // ForceSendFields is a list of field names (e.g. "DatasetId") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DatasetId") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleCloudDiscoveryengineV1alphaPageInfo: Detailed page information. type GoogleCloudDiscoveryengineV1alphaPageInfo struct { // PageCategory: The most specific category associated with a category page. To @@ -9850,6 +9857,8 @@ type GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest struct { // GcsSource: Cloud Storage location for the input content. Supported // `data_schema`: * `document_id`: One valid Document.id per line. GcsSource *GoogleCloudDiscoveryengineV1alphaGcsSource `json:"gcsSource,omitempty"` + // InlineSource: Inline source for the input content for purge. + InlineSource *GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource `json:"inlineSource,omitempty"` // ForceSendFields is a list of field names (e.g. "ErrorConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See @@ -9868,6 +9877,33 @@ func (s GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest) MarshalJSON() ([ return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource: The +// inline source for the input config for DocumentService.PurgeDocuments +// method. +type GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource struct { + // Documents: Required. A list of full resource name of documents to purge. In + // the format + // `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. + // Recommended max of 100 items. + Documents []string `json:"documents,omitempty"` + // ForceSendFields is a list of field names (e.g. "Documents") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Documents") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse: Response message // for DocumentService.PurgeDocuments method. If the long running operation is // successfully done, then this message is returned by the @@ -10891,11 +10927,11 @@ type GoogleCloudDiscoveryengineV1alphaResumeEngineRequest struct { type GoogleCloudDiscoveryengineV1alphaSampleQuery struct { // CreateTime: Output only. Timestamp the SampleQuery was created at. CreateTime string `json:"createTime,omitempty"` - // Name: Immutable. The full resource name of the sample query, in the format + // Name: Identifier. The full resource name of the sample query, in the format // of - // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sam - // pleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a - // length limit of 1024 characters. + // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/s + // ampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with + // a length limit of 1024 characters. Name string `json:"name,omitempty"` // QueryEntry: The query entry. QueryEntry *GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry `json:"queryEntry,omitempty"` @@ -11000,10 +11036,10 @@ type GoogleCloudDiscoveryengineV1alphaSampleQuerySet struct { // DisplayName: Required. The sample query set display name. This field must be // a UTF-8 encoded string with a length limit of 128 characters. DisplayName string `json:"displayName,omitempty"` - // Name: Immutable. The full resource name of the SampleQuerySet, in the format - // of - // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. - // This field must be a UTF-8 encoded string with a length limit of 1024 + // Name: Identifier. The full resource name of the SampleQuerySet, in the + // format of + // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. + // This field must be a UTF-8 encoded string with a length limit of 1024 // characters. Name string `json:"name,omitempty"` @@ -11179,9 +11215,12 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // OrderBy: The order in which documents are returned. Documents can be ordered // by a field in an Document object. Leave it unset if ordered by relevance. // `order_by` expression is case-sensitive. For more information on ordering - // for retail search, see Ordering - // (https://cloud.google.com/retail/docs/filter-and-order#order) If this field - // is unrecognizable, an `INVALID_ARGUMENT` is returned. + // the website search results, see Order web search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + // For more information on ordering the healthcare search results, see Order + // healthcare search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the @@ -11681,6 +11720,12 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec // skip generating summaries for adversarial queries and return fallback // messages instead. IgnoreAdversarialQuery bool `json:"ignoreAdversarialQuery,omitempty"` + // IgnoreLowRelevantContent: Specifies whether to filter out queries that have + // low relevance. The default value is `false`. If this field is set to + // `false`, all search results are used regardless of relevance to generate + // answers. If set to `true`, only queries with high relevance search results + // will generate answers. + IgnoreLowRelevantContent bool `json:"ignoreLowRelevantContent,omitempty"` // IgnoreNonSummarySeekingQuery: Specifies whether to filter out queries that // are not summary-seeking. The default value is `false`. Google employs // search-query classification to detect summary-seeking queries. No summary is @@ -12238,6 +12283,9 @@ type GoogleCloudDiscoveryengineV1alphaSearchResponse struct { // retrieve the next page. If this field is omitted, there are no subsequent // pages. NextPageToken string `json:"nextPageToken,omitempty"` + // OneBoxResults: A list of One Box results. There can be multiple One Box + // results of different types. + OneBoxResults []*GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult `json:"oneBoxResults,omitempty"` // QueryExpansionInfo: Query expansion information for the returned results. QueryExpansionInfo *GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo `json:"queryExpansionInfo,omitempty"` // RedirectUri: The URI of a customer-defined redirect page. If redirect action @@ -12670,6 +12718,38 @@ func (s GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnder return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult: OneBoxResult is +// a holder for all results of specific type that we want to display in UI +// differently. +type GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult struct { + // OneBoxType: The type of One Box result. + // + // Possible values: + // "ONE_BOX_TYPE_UNSPECIFIED" - Default value. Should not be used. + // "PEOPLE" - One Box result contains people results. + // "ORGANIZATION" - One Box result contains organization results. + // "SLACK" - One Box result contains slack results. + OneBoxType string `json:"oneBoxType,omitempty"` + // SearchResults: The search results for this One Box. + SearchResults []*GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult `json:"searchResults,omitempty"` + // ForceSendFields is a list of field names (e.g. "OneBoxType") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "OneBoxType") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo: // Information describing query expansion including whether expansion has // occurred. @@ -12772,10 +12852,10 @@ type GoogleCloudDiscoveryengineV1alphaSearchResponseSummary struct { // "SUMMARY_SKIPPED_REASON_UNSPECIFIED" - Default value. The summary skipped // reason is not specified. // "ADVERSARIAL_QUERY_IGNORED" - The adversarial query ignored case. Only - // populated when SummarySpec.ignore_adversarial_query is set to `true`. + // used when SummarySpec.ignore_adversarial_query is set to `true`. // "NON_SUMMARY_SEEKING_QUERY_IGNORED" - The non-summary seeking query - // ignored case. Only populated when - // SummarySpec.ignore_non_summary_seeking_query is set to `true`. + // ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is + // set to `true`. // "OUT_OF_DOMAIN_QUERY_IGNORED" - The out-of-domain query ignored case. // Google skips the summary if there are no high-relevance search results. For // example, the data store contains facts about company A but the user query is @@ -12785,6 +12865,12 @@ type GoogleCloudDiscoveryengineV1alphaSearchResponseSummary struct { // includes content that may be violent or toxic. // "LLM_ADDON_NOT_ENABLED" - The LLM addon not enabled case. Google skips the // summary if the LLM addon is not enabled. + // "NO_RELEVANT_CONTENT" - The no relevant content case. Google skips the + // summary if there is no relevant content in the retrieved search results. + // "JAIL_BREAKING_QUERY_IGNORED" - The jail-breaking query ignored case. For + // example, "Reply in the tone of a competing company's CEO". Only used when + // [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is + // set to `true`. SummarySkippedReasons []string `json:"summarySkippedReasons,omitempty"` // SummaryText: The summary content. SummaryText string `json:"summaryText,omitempty"` @@ -15294,7 +15380,7 @@ type GoogleCloudDiscoveryengineV1betaEvaluation struct { ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // EvaluationSpec: Required. The specification of the evaluation. EvaluationSpec *GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec `json:"evaluationSpec,omitempty"` - // Name: Immutable. The full resource name of the Evaluation, in the format of + // Name: Identifier. The full resource name of the Evaluation, in the format of // `projects/{project}/locations/{location}/evaluations/{evaluation}`. This // field must be a UTF-8 encoded string with a length limit of 1024 characters. Name string `json:"name,omitempty"` @@ -16224,9 +16310,12 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // OrderBy: The order in which documents are returned. Documents can be ordered // by a field in an Document object. Leave it unset if ordered by relevance. // `order_by` expression is case-sensitive. For more information on ordering - // for retail search, see Ordering - // (https://cloud.google.com/retail/docs/filter-and-order#order) If this field - // is unrecognizable, an `INVALID_ARGUMENT` is returned. + // the website search results, see Order web search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + // For more information on ordering the healthcare search results, see Order + // healthcare search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the @@ -16713,6 +16802,12 @@ type GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec s // skip generating summaries for adversarial queries and return fallback // messages instead. IgnoreAdversarialQuery bool `json:"ignoreAdversarialQuery,omitempty"` + // IgnoreLowRelevantContent: Specifies whether to filter out queries that have + // low relevance. The default value is `false`. If this field is set to + // `false`, all search results are used regardless of relevance to generate + // answers. If set to `true`, only queries with high relevance search results + // will generate answers. + IgnoreLowRelevantContent bool `json:"ignoreLowRelevantContent,omitempty"` // IgnoreNonSummarySeekingQuery: Specifies whether to filter out queries that // are not summary-seeking. The default value is `false`. Google employs // search-query classification to detect summary-seeking queries. No summary is @@ -18940,6 +19035,18 @@ func (c *ProjectsLocationsCollectionsDataStoresCreateCall) DataStoreId(dataStore return c } +// SkipDefaultSchemaCreation sets the optional parameter +// "skipDefaultSchemaCreation": 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. +func (c *ProjectsLocationsCollectionsDataStoresCreateCall) SkipDefaultSchemaCreation(skipDefaultSchemaCreation bool) *ProjectsLocationsCollectionsDataStoresCreateCall { + c.urlParams_.Set("skipDefaultSchemaCreation", fmt.Sprint(skipDefaultSchemaCreation)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. @@ -32953,6 +33060,18 @@ func (c *ProjectsLocationsDataStoresCreateCall) DataStoreId(dataStoreId string) return c } +// SkipDefaultSchemaCreation sets the optional parameter +// "skipDefaultSchemaCreation": 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. +func (c *ProjectsLocationsDataStoresCreateCall) SkipDefaultSchemaCreation(skipDefaultSchemaCreation bool) *ProjectsLocationsDataStoresCreateCall { + c.urlParams_.Set("skipDefaultSchemaCreation", fmt.Sprint(skipDefaultSchemaCreation)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. @@ -42748,8 +42867,8 @@ type ProjectsLocationsSampleQuerySetsDeleteCall struct { // Delete: Deletes a SampleQuerySet. // // - name: Full resource name of SampleQuerySet, such as -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. -// If the caller does not have permission to delete the SampleQuerySet, +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// `. If the caller does not have permission to delete the SampleQuerySet, // regardless of whether or not it exists, a `PERMISSION_DENIED` error is // returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` // error is returned. @@ -42850,8 +42969,8 @@ type ProjectsLocationsSampleQuerySetsGetCall struct { // Get: Gets a SampleQuerySet. // // - name: Full resource name of SampleQuerySet, such as -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. -// If the caller does not have permission to access the SampleQuerySet, +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// `. If the caller does not have permission to access the SampleQuerySet, // regardless of whether or not it exists, a PERMISSION_DENIED error is // returned. If the requested SampleQuerySet does not exist, a NOT_FOUND // error is returned. @@ -43115,10 +43234,10 @@ type ProjectsLocationsSampleQuerySetsPatchCall struct { // Patch: Updates a SampleQuerySet. // -// - name: Immutable. The full resource name of the SampleQuerySet, in the +// - name: Identifier. The full resource name of the SampleQuerySet, in the // format of -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. -// This field must be a UTF-8 encoded string with a length limit of 1024 +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// `. This field must be a UTF-8 encoded string with a length limit of 1024 // characters. func (r *ProjectsLocationsSampleQuerySetsService) Patch(name string, googleclouddiscoveryenginev1alphasamplequeryset *GoogleCloudDiscoveryengineV1alphaSampleQuerySet) *ProjectsLocationsSampleQuerySetsPatchCall { c := &ProjectsLocationsSampleQuerySetsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -43456,8 +43575,8 @@ type ProjectsLocationsSampleQuerySetsSampleQueriesDeleteCall struct { // Delete: Deletes a SampleQuery. // // - name: Full resource name of SampleQuery, such as -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/s -// ampleQueries/{sampleQuery}`. If the caller does not have permission to +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// /sampleQueries/{sample_query}`. If the caller does not have permission to // delete the SampleQuery, regardless of whether or not it exists, a // `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does // not exist, a `NOT_FOUND` error is returned. @@ -43558,8 +43677,8 @@ type ProjectsLocationsSampleQuerySetsSampleQueriesGetCall struct { // Get: Gets a SampleQuery. // // - name: Full resource name of SampleQuery, such as -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/s -// ampleQueries/{sampleQuery}`. If the caller does not have permission to +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// /sampleQueries/{sample_query}`. If the caller does not have permission to // access the SampleQuery, regardless of whether or not it exists, a // PERMISSION_DENIED error is returned. If the requested SampleQuery does not // exist, a NOT_FOUND error is returned. @@ -43931,10 +44050,10 @@ type ProjectsLocationsSampleQuerySetsSampleQueriesPatchCall struct { // Patch: Updates a SampleQuery. // -// - name: Immutable. The full resource name of the sample query, in the format -// of -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/s -// ampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string +// - name: Identifier. The full resource name of the sample query, in the +// format of +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// /sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string // with a length limit of 1024 characters. func (r *ProjectsLocationsSampleQuerySetsSampleQueriesService) Patch(name string, googleclouddiscoveryenginev1alphasamplequery *GoogleCloudDiscoveryengineV1alphaSampleQuery) *ProjectsLocationsSampleQuerySetsSampleQueriesPatchCall { c := &ProjectsLocationsSampleQuerySetsSampleQueriesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index e3e85178266..e1df27d77f8 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -287,6 +287,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "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": "v1beta/{+parent}/dataStores", @@ -2590,6 +2595,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "write": { "description": "Writes a single user event.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write", @@ -3817,6 +3850,11 @@ "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": "v1beta/{+parent}/dataStores", @@ -5785,6 +5823,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.dataStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "write": { "description": "Writes a single user event.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write", @@ -6161,7 +6227,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, @@ -6186,7 +6252,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, @@ -6247,7 +6313,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, @@ -6347,7 +6413,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "required": true, @@ -6372,7 +6438,7 @@ ], "parameters": { "name": { - "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "required": true, @@ -6461,7 +6527,7 @@ ], "parameters": { "name": { - "description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", "required": true, @@ -6642,7 +6708,7 @@ } } }, - "revision": "20240715", + "revision": "20240729", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -8187,7 +8253,8 @@ "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -8195,7 +8262,8 @@ "The non-answer seeking query ignored case.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." ], "type": "string" }, @@ -8354,6 +8422,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "description": "Chunk information." }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." @@ -8378,7 +8450,7 @@ "description": "Document metadata." }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -8416,6 +8488,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", @@ -8461,6 +8552,11 @@ "pageIdentifier": { "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" @@ -8585,7 +8681,7 @@ "type": "string" }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -9668,7 +9764,7 @@ "description": "Required. The specification of the evaluation." }, "name": { - "description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "qualityMetrics": { @@ -9745,10 +9841,6 @@ "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", "properties": { - "outputResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", - "description": "Output result indicating where the data were exported to." - }, "status": { "$ref": "GoogleRpcStatus", "description": "The status of the export operation." @@ -10280,32 +10372,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaOutputResult": { - "description": "Output result that stores the information about where the exported data is stored.", - "id": "GoogleCloudDiscoveryengineV1alphaOutputResult", - "properties": { - "bigqueryResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", - "description": "The BigQuery location where the result is stored." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { - "description": "A BigQuery output result.", - "id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", - "properties": { - "datasetId": { - "description": "The ID of a BigQuery Dataset.", - "type": "string" - }, - "tableId": { - "description": "The ID of a BigQuery Table.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", @@ -10818,7 +10884,7 @@ "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -11122,6 +11188,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" @@ -11791,7 +11861,8 @@ "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -11799,7 +11870,8 @@ "The non-answer seeking query ignored case.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query." ], "type": "string" }, @@ -12350,6 +12422,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo", "description": "Chunk information." }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." @@ -12374,7 +12450,7 @@ "description": "Document metadata." }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -12412,6 +12488,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo", @@ -12457,6 +12552,11 @@ "pageIdentifier": { "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" @@ -12581,7 +12681,7 @@ "type": "string" }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -14369,7 +14469,7 @@ "description": "Required. The specification of the evaluation." }, "name": { - "description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "qualityMetrics": { @@ -15559,6 +15659,10 @@ "description": "Request message for DocumentService.PurgeDocuments method.", "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest", "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeErrorConfig", + "description": "The desired location of errors incurred during the purge." + }, "filter": { "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", "type": "string" @@ -15566,6 +15670,28 @@ "force": { "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", "type": "boolean" + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaGcsSource", + "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource", + "description": "Inline source for the input content for purge." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource": { + "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource", + "properties": { + "documents": { + "description": "Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -15589,6 +15715,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaPurgeErrorConfig": { + "description": "Configuration of destination for Purge related errors.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeErrorConfig", + "properties": { + "gcsPrefix": { + "description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", @@ -15631,6 +15768,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest", + "properties": { + "filter": { + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", + "type": "string" + }, + "force": { + "description": "The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaQualityMetrics": { "description": "Describes the metrics produced by the evaluation.", "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", @@ -15946,7 +16098,7 @@ "type": "string" }, "name": { - "description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, "queryEntry": { @@ -16017,7 +16169,7 @@ "type": "string" }, "name": { - "description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, @@ -16126,7 +16278,7 @@ "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -16412,6 +16564,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" @@ -16750,6 +16906,13 @@ "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, + "oneBoxResults": { + "description": "A list of One Box results. There can be multiple One Box results of different types.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult" + }, + "type": "array" + }, "queryExpansionInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo", "description": "Query expansion information for the returned results." @@ -17033,6 +17196,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult": { + "description": "OneBoxResult is a holder for all results of specific type that we want to display in UI differently.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult", + "properties": { + "oneBoxType": { + "description": "The type of One Box result.", + "enum": [ + "ONE_BOX_TYPE_UNSPECIFIED", + "PEOPLE", + "ORGANIZATION", + "SLACK" + ], + "enumDescriptions": [ + "Default value. Should not be used.", + "One Box result contains people results.", + "One Box result contains organization results.", + "One Box result contains slack results." + ], + "type": "string" + }, + "searchResults": { + "description": "The search results for this One Box.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo": { "description": "Information describing query expansion including whether expansion has occurred.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo", @@ -17107,15 +17300,19 @@ "NON_SUMMARY_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "LLM_ADDON_NOT_ENABLED" + "LLM_ADDON_NOT_ENABLED", + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", - "The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", + "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled." + "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", + "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`." ], "type": "string" }, diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index 0510c95cbc0..346065e4e53 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -3025,6 +3025,9 @@ type GoogleCloudDiscoveryengineV1alphaAnswer struct { // includes content that may be violent or toxic. // "NO_RELEVANT_CONTENT" - The no relevant content case. Google skips the // answer if there is no relevant content in the retrieved search results. + // "JAIL_BREAKING_QUERY_IGNORED" - The jail-breaking query ignored case. For + // example, "Reply in the tone of a competing company's CEO". Google skips the + // answer if the query is classified as a jail-breaking query. AnswerSkippedReasons []string `json:"answerSkippedReasons,omitempty"` // AnswerText: The textual answer. AnswerText string `json:"answerText,omitempty"` @@ -3179,6 +3182,8 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassi type GoogleCloudDiscoveryengineV1alphaAnswerReference struct { // ChunkInfo: Chunk information. ChunkInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo `json:"chunkInfo,omitempty"` + // StructuredDocumentInfo: Structured document information. + StructuredDocumentInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo `json:"structuredDocumentInfo,omitempty"` // UnstructuredDocumentInfo: Unstructured document information. UnstructuredDocumentInfo *GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo `json:"unstructuredDocumentInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "ChunkInfo") to @@ -3208,7 +3213,10 @@ type GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo struct { Content string `json:"content,omitempty"` // DocumentMetadata: Document metadata. DocumentMetadata *GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata `json:"documentMetadata,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -3274,6 +3282,31 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadat return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo: +// Structured search information. +type GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo struct { + // Document: Document resource name. + Document string `json:"document,omitempty"` + // StructData: Structured search data. + StructData googleapi.RawMessage `json:"structData,omitempty"` + // ForceSendFields is a list of field names (e.g. "Document") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Document") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo: // Unstructured document information. type GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo struct { @@ -3313,6 +3346,11 @@ type GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChu Content string `json:"content,omitempty"` // PageIdentifier: Page identifier. PageIdentifier string `json:"pageIdentifier,omitempty"` + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. + RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -3331,6 +3369,20 @@ func (s GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +func (s *GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent + var s1 struct { + RelevanceScore gensupport.JSONFloat64 `json:"relevanceScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.RelevanceScore = float64(s1.RelevanceScore) + return nil +} + // GoogleCloudDiscoveryengineV1alphaAnswerStep: Step information. type GoogleCloudDiscoveryengineV1alphaAnswerStep struct { // Actions: Actions. @@ -3454,7 +3506,10 @@ type GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChu Chunk string `json:"chunk,omitempty"` // Content: Chunk textual content. Content string `json:"content,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -4952,7 +5007,7 @@ type GoogleCloudDiscoveryengineV1alphaEvaluation struct { ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // EvaluationSpec: Required. The specification of the evaluation. EvaluationSpec *GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec `json:"evaluationSpec,omitempty"` - // Name: Immutable. The full resource name of the Evaluation, in the format of + // Name: Identifier. The full resource name of the Evaluation, in the format of // `projects/{project}/locations/{location}/evaluations/{evaluation}`. This // field must be a UTF-8 encoded string with a length limit of 1024 characters. Name string `json:"name,omitempty"` @@ -5075,17 +5130,15 @@ func (s GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata) MarshalJSON() // this message is returned by the google.longrunning.Operations.response // field. type GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse struct { - // OutputResult: Output result indicating where the data were exported to. - OutputResult *GoogleCloudDiscoveryengineV1alphaOutputResult `json:"outputResult,omitempty"` // Status: The status of the export operation. Status *GoogleRpcStatus `json:"status,omitempty"` - // ForceSendFields is a list of field names (e.g. "OutputResult") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See + // ForceSendFields is a list of field names (e.g. "Status") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "OutputResult") to include in API + // NullFields is a list of field names (e.g. "Status") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -5771,54 +5824,6 @@ func (s GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse) MarshalJSON() return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1alphaOutputResult: Output result that stores the -// information about where the exported data is stored. -type GoogleCloudDiscoveryengineV1alphaOutputResult struct { - // BigqueryResult: The BigQuery location where the result is stored. - BigqueryResult *GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult `json:"bigqueryResult,omitempty"` - // ForceSendFields is a list of field names (e.g. "BigqueryResult") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BigqueryResult") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaOutputResult) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaOutputResult - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult: A -// BigQuery output result. -type GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult struct { - // DatasetId: The ID of a BigQuery Dataset. - DatasetId string `json:"datasetId,omitempty"` - // TableId: The ID of a BigQuery Table. - TableId string `json:"tableId,omitempty"` - // ForceSendFields is a list of field names (e.g. "DatasetId") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DatasetId") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleCloudDiscoveryengineV1alphaProject: Metadata and configurations for a // Google Cloud project in the service. type GoogleCloudDiscoveryengineV1alphaProject struct { @@ -6492,9 +6497,12 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // OrderBy: The order in which documents are returned. Documents can be ordered // by a field in an Document object. Leave it unset if ordered by relevance. // `order_by` expression is case-sensitive. For more information on ordering - // for retail search, see Ordering - // (https://cloud.google.com/retail/docs/filter-and-order#order) If this field - // is unrecognizable, an `INVALID_ARGUMENT` is returned. + // the website search results, see Order web search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + // For more information on ordering the healthcare search results, see Order + // healthcare search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the @@ -6994,6 +7002,12 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec // skip generating summaries for adversarial queries and return fallback // messages instead. IgnoreAdversarialQuery bool `json:"ignoreAdversarialQuery,omitempty"` + // IgnoreLowRelevantContent: Specifies whether to filter out queries that have + // low relevance. The default value is `false`. If this field is set to + // `false`, all search results are used regardless of relevance to generate + // answers. If set to `true`, only queries with high relevance search results + // will generate answers. + IgnoreLowRelevantContent bool `json:"ignoreLowRelevantContent,omitempty"` // IgnoreNonSummarySeekingQuery: Specifies whether to filter out queries that // are not summary-seeking. The default value is `false`. Google employs // search-query classification to detect summary-seeking queries. No summary is @@ -8019,6 +8033,9 @@ type GoogleCloudDiscoveryengineV1betaAnswer struct { // includes content that may be violent or toxic. // "NO_RELEVANT_CONTENT" - The no relevant content case. Google skips the // answer if there is no relevant content in the retrieved search results. + // "JAIL_BREAKING_QUERY_IGNORED" - The jail-breaking query ignored case. For + // example, "Reply in the tone of a competing company's CEO". Google skips the + // answer if the query is classified as a jail-breaking query. AnswerSkippedReasons []string `json:"answerSkippedReasons,omitempty"` // AnswerText: The textual answer. AnswerText string `json:"answerText,omitempty"` @@ -8773,6 +8790,8 @@ func (s GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassif type GoogleCloudDiscoveryengineV1betaAnswerReference struct { // ChunkInfo: Chunk information. ChunkInfo *GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo `json:"chunkInfo,omitempty"` + // StructuredDocumentInfo: Structured document information. + StructuredDocumentInfo *GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo `json:"structuredDocumentInfo,omitempty"` // UnstructuredDocumentInfo: Unstructured document information. UnstructuredDocumentInfo *GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo `json:"unstructuredDocumentInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "ChunkInfo") to @@ -8801,7 +8820,10 @@ type GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo struct { Content string `json:"content,omitempty"` // DocumentMetadata: Document metadata. DocumentMetadata *GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata `json:"documentMetadata,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -8867,6 +8889,31 @@ func (s GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo: +// Structured search information. +type GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo struct { + // Document: Document resource name. + Document string `json:"document,omitempty"` + // StructData: Structured search data. + StructData googleapi.RawMessage `json:"structData,omitempty"` + // ForceSendFields is a list of field names (e.g. "Document") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Document") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo: // Unstructured document information. type GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo struct { @@ -8906,6 +8953,11 @@ type GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChun Content string `json:"content,omitempty"` // PageIdentifier: Page identifier. PageIdentifier string `json:"pageIdentifier,omitempty"` + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. + RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Content") to unconditionally // include in API requests. By default, fields with empty or default values are // omitted from API requests. See @@ -8924,6 +8976,20 @@ func (s GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoC return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +func (s *GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent + var s1 struct { + RelevanceScore gensupport.JSONFloat64 `json:"relevanceScore"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.RelevanceScore = float64(s1.RelevanceScore) + return nil +} + // GoogleCloudDiscoveryengineV1betaAnswerStep: Step information. type GoogleCloudDiscoveryengineV1betaAnswerStep struct { // Actions: Actions. @@ -9047,7 +9113,10 @@ type GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChun Chunk string `json:"chunk,omitempty"` // Content: Chunk textual content. Content string `json:"content,omitempty"` - // RelevanceScore: Relevance score. + // RelevanceScore: The relevance of the chunk for a given query. Values range + // from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is + // for informational purpose only. It may change for the same query and chunk + // at any time due to a model retraining or change in implementation. RelevanceScore float64 `json:"relevanceScore,omitempty"` // ForceSendFields is a list of field names (e.g. "Chunk") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -11530,7 +11599,7 @@ type GoogleCloudDiscoveryengineV1betaEvaluation struct { ErrorSamples []*GoogleRpcStatus `json:"errorSamples,omitempty"` // EvaluationSpec: Required. The specification of the evaluation. EvaluationSpec *GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec `json:"evaluationSpec,omitempty"` - // Name: Immutable. The full resource name of the Evaluation, in the format of + // Name: Identifier. The full resource name of the Evaluation, in the format of // `projects/{project}/locations/{location}/evaluations/{evaluation}`. This // field must be a UTF-8 encoded string with a length limit of 1024 characters. Name string `json:"name,omitempty"` @@ -13270,19 +13339,26 @@ func (s GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata) MarshalJSON() ([ // GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest: Request message for // DocumentService.PurgeDocuments method. type GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest struct { + // ErrorConfig: The desired location of errors incurred during the purge. + ErrorConfig *GoogleCloudDiscoveryengineV1betaPurgeErrorConfig `json:"errorConfig,omitempty"` // Filter: Required. Filter matching documents to purge. Only currently // supported value is `*` (all items). Filter string `json:"filter,omitempty"` // Force: Actually performs the purge. If `force` is set to false, return the // expected purge count without deleting any documents. Force bool `json:"force,omitempty"` - // ForceSendFields is a list of field names (e.g. "Filter") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See + // GcsSource: Cloud Storage location for the input content. Supported + // `data_schema`: * `document_id`: One valid Document.id per line. + GcsSource *GoogleCloudDiscoveryengineV1betaGcsSource `json:"gcsSource,omitempty"` + // InlineSource: Inline source for the input content for purge. + InlineSource *GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource `json:"inlineSource,omitempty"` + // ForceSendFields is a list of field names (e.g. "ErrorConfig") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Filter") to include in API + // NullFields is a list of field names (e.g. "ErrorConfig") to include in API // requests with the JSON null value. By default, fields with empty values are // omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -13294,6 +13370,33 @@ func (s GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest) MarshalJSON() ([] return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource: The +// inline source for the input config for DocumentService.PurgeDocuments +// method. +type GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource struct { + // Documents: Required. A list of full resource name of documents to purge. In + // the format + // `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. + // Recommended max of 100 items. + Documents []string `json:"documents,omitempty"` + // ForceSendFields is a list of field names (e.g. "Documents") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Documents") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse: Response message for // DocumentService.PurgeDocuments method. If the long running operation is // successfully done, then this message is returned by the @@ -13324,6 +13427,32 @@ func (s GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse) MarshalJSON() ([ return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaPurgeErrorConfig: Configuration of +// destination for Purge related errors. +type GoogleCloudDiscoveryengineV1betaPurgeErrorConfig struct { + // GcsPrefix: Cloud Storage prefix for purge errors. This must be an empty, + // existing Cloud Storage directory. Purge errors are written to sharded files + // in this directory, one per line, as a JSON-encoded `google.rpc.Status` + // message. + GcsPrefix string `json:"gcsPrefix,omitempty"` + // ForceSendFields is a list of field names (e.g. "GcsPrefix") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "GcsPrefix") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaPurgeErrorConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaPurgeErrorConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata: // Metadata related to the progress of the PurgeSuggestionDenyListEntries // operation. This is returned by the google.longrunning.Operation.metadata @@ -13383,6 +13512,46 @@ func (s GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse) return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest: Request message for +// PurgeUserEvents method. +type GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest struct { + // Filter: Required. The filter string to specify the events to be deleted with + // a length limit of 5,000 characters. The eligible fields for filtering are: * + // `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in + // ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying + // this will delete all events associated with a visitor. * `userId`: Double + // quoted string. Specifying this will delete all events associated with a + // user. Examples: * Deleting all events in a time range: `eventTime > + // "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * + // Deleting specific eventType: `eventType = "search" * Deleting all events + // for a specific visitor: `userPseudoId = "visitor1024" * Deleting all events + // inside a DataStore: `*` The filtering fields are assumed to have an implicit + // AND. + Filter string `json:"filter,omitempty"` + // Force: The `force` field is currently not supported. Purge user event + // requests will permanently delete all purgeable events. Once the development + // is complete: If `force` is set to false, the method will return the expected + // purge count without deleting any user events. This field will default to + // false if not included in the request. + Force bool `json:"force,omitempty"` + // ForceSendFields is a list of field names (e.g. "Filter") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Filter") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaQualityMetrics: Describes the metrics // produced by the evaluation. type GoogleCloudDiscoveryengineV1betaQualityMetrics struct { @@ -13872,11 +14041,11 @@ type GoogleCloudDiscoveryengineV1betaResumeEngineRequest struct { type GoogleCloudDiscoveryengineV1betaSampleQuery struct { // CreateTime: Output only. Timestamp the SampleQuery was created at. CreateTime string `json:"createTime,omitempty"` - // Name: Immutable. The full resource name of the sample query, in the format + // Name: Identifier. The full resource name of the sample query, in the format // of - // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sam - // pleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a - // length limit of 1024 characters. + // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/s + // ampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with + // a length limit of 1024 characters. Name string `json:"name,omitempty"` // QueryEntry: The query entry. QueryEntry *GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry `json:"queryEntry,omitempty"` @@ -13981,10 +14150,10 @@ type GoogleCloudDiscoveryengineV1betaSampleQuerySet struct { // DisplayName: Required. The sample query set display name. This field must be // a UTF-8 encoded string with a length limit of 128 characters. DisplayName string `json:"displayName,omitempty"` - // Name: Immutable. The full resource name of the SampleQuerySet, in the format - // of - // `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. - // This field must be a UTF-8 encoded string with a length limit of 1024 + // Name: Identifier. The full resource name of the SampleQuerySet, in the + // format of + // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. + // This field must be a UTF-8 encoded string with a length limit of 1024 // characters. Name string `json:"name,omitempty"` @@ -14155,9 +14324,12 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // OrderBy: The order in which documents are returned. Documents can be ordered // by a field in an Document object. Leave it unset if ordered by relevance. // `order_by` expression is case-sensitive. For more information on ordering - // for retail search, see Ordering - // (https://cloud.google.com/retail/docs/filter-and-order#order) If this field - // is unrecognizable, an `INVALID_ARGUMENT` is returned. + // the website search results, see Order web search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). + // For more information on ordering the healthcare search results, see Order + // healthcare search results + // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). + // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the @@ -14644,6 +14816,12 @@ type GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec s // skip generating summaries for adversarial queries and return fallback // messages instead. IgnoreAdversarialQuery bool `json:"ignoreAdversarialQuery,omitempty"` + // IgnoreLowRelevantContent: Specifies whether to filter out queries that have + // low relevance. The default value is `false`. If this field is set to + // `false`, all search results are used regardless of relevance to generate + // answers. If set to `true`, only queries with high relevance search results + // will generate answers. + IgnoreLowRelevantContent bool `json:"ignoreLowRelevantContent,omitempty"` // IgnoreNonSummarySeekingQuery: Specifies whether to filter out queries that // are not summary-seeking. The default value is `false`. Google employs // search-query classification to detect summary-seeking queries. No summary is @@ -15201,6 +15379,9 @@ type GoogleCloudDiscoveryengineV1betaSearchResponse struct { // retrieve the next page. If this field is omitted, there are no subsequent // pages. NextPageToken string `json:"nextPageToken,omitempty"` + // OneBoxResults: A list of One Box results. There can be multiple One Box + // results of different types. + OneBoxResults []*GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult `json:"oneBoxResults,omitempty"` // QueryExpansionInfo: Query expansion information for the returned results. QueryExpansionInfo *GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo `json:"queryExpansionInfo,omitempty"` // RedirectUri: The URI of a customer-defined redirect page. If redirect action @@ -15633,6 +15814,38 @@ func (s GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnders return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult: OneBoxResult is +// a holder for all results of specific type that we want to display in UI +// differently. +type GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult struct { + // OneBoxType: The type of One Box result. + // + // Possible values: + // "ONE_BOX_TYPE_UNSPECIFIED" - Default value. Should not be used. + // "PEOPLE" - One Box result contains people results. + // "ORGANIZATION" - One Box result contains organization results. + // "SLACK" - One Box result contains slack results. + OneBoxType string `json:"oneBoxType,omitempty"` + // SearchResults: The search results for this One Box. + SearchResults []*GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult `json:"searchResults,omitempty"` + // ForceSendFields is a list of field names (e.g. "OneBoxType") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "OneBoxType") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo: // Information describing query expansion including whether expansion has // occurred. @@ -15735,10 +15948,10 @@ type GoogleCloudDiscoveryengineV1betaSearchResponseSummary struct { // "SUMMARY_SKIPPED_REASON_UNSPECIFIED" - Default value. The summary skipped // reason is not specified. // "ADVERSARIAL_QUERY_IGNORED" - The adversarial query ignored case. Only - // populated when SummarySpec.ignore_adversarial_query is set to `true`. + // used when SummarySpec.ignore_adversarial_query is set to `true`. // "NON_SUMMARY_SEEKING_QUERY_IGNORED" - The non-summary seeking query - // ignored case. Only populated when - // SummarySpec.ignore_non_summary_seeking_query is set to `true`. + // ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is + // set to `true`. // "OUT_OF_DOMAIN_QUERY_IGNORED" - The out-of-domain query ignored case. // Google skips the summary if there are no high-relevance search results. For // example, the data store contains facts about company A but the user query is @@ -15748,6 +15961,12 @@ type GoogleCloudDiscoveryengineV1betaSearchResponseSummary struct { // includes content that may be violent or toxic. // "LLM_ADDON_NOT_ENABLED" - The LLM addon not enabled case. Google skips the // summary if the LLM addon is not enabled. + // "NO_RELEVANT_CONTENT" - The no relevant content case. Google skips the + // summary if there is no relevant content in the retrieved search results. + // "JAIL_BREAKING_QUERY_IGNORED" - The jail-breaking query ignored case. For + // example, "Reply in the tone of a competing company's CEO". Only used when + // [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is + // set to `true`. SummarySkippedReasons []string `json:"summarySkippedReasons,omitempty"` // SummaryText: The summary content. SummaryText string `json:"summaryText,omitempty"` @@ -17748,6 +17967,18 @@ func (c *ProjectsLocationsCollectionsDataStoresCreateCall) DataStoreId(dataStore return c } +// SkipDefaultSchemaCreation sets the optional parameter +// "skipDefaultSchemaCreation": 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. +func (c *ProjectsLocationsCollectionsDataStoresCreateCall) SkipDefaultSchemaCreation(skipDefaultSchemaCreation bool) *ProjectsLocationsCollectionsDataStoresCreateCall { + c.urlParams_.Set("skipDefaultSchemaCreation", fmt.Sprint(skipDefaultSchemaCreation)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. @@ -26346,6 +26577,114 @@ func (c *ProjectsLocationsCollectionsDataStoresUserEventsImportCall) Do(opts ... return ret, nil } +type ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall struct { + s *Service + parent string + googleclouddiscoveryenginev1betapurgeusereventsrequest *GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Purge: Deletes permanently all user events specified by the filter provided. +// Depending on the number of events specified by the filter, this operation +// could take hours or days to complete. To test a filter, use the list command +// first. +// +// - parent: The resource name of the catalog under which the events are +// created. The format is +// `projects/${projectId}/locations/global/collections/{$collectionId}/dataSto +// res/${dataStoreId}`. +func (r *ProjectsLocationsCollectionsDataStoresUserEventsService) Purge(parent string, googleclouddiscoveryenginev1betapurgeusereventsrequest *GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest) *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall { + c := &ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddiscoveryenginev1betapurgeusereventsrequest = googleclouddiscoveryenginev1betapurgeusereventsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) Context(ctx context.Context) *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddiscoveryenginev1betapurgeusereventsrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+parent}/userEvents:purge") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.dataStores.userEvents.purge" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsDataStoresUserEventsPurgeCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + type ProjectsLocationsCollectionsDataStoresUserEventsWriteCall struct { s *Service parent string @@ -30797,6 +31136,18 @@ func (c *ProjectsLocationsDataStoresCreateCall) DataStoreId(dataStoreId string) return c } +// SkipDefaultSchemaCreation sets the optional parameter +// "skipDefaultSchemaCreation": 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. +func (c *ProjectsLocationsDataStoresCreateCall) SkipDefaultSchemaCreation(skipDefaultSchemaCreation bool) *ProjectsLocationsDataStoresCreateCall { + c.urlParams_.Set("skipDefaultSchemaCreation", fmt.Sprint(skipDefaultSchemaCreation)) + return c +} + // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. @@ -38140,6 +38491,114 @@ func (c *ProjectsLocationsDataStoresUserEventsImportCall) Do(opts ...googleapi.C return ret, nil } +type ProjectsLocationsDataStoresUserEventsPurgeCall struct { + s *Service + parent string + googleclouddiscoveryenginev1betapurgeusereventsrequest *GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Purge: Deletes permanently all user events specified by the filter provided. +// Depending on the number of events specified by the filter, this operation +// could take hours or days to complete. To test a filter, use the list command +// first. +// +// - parent: The resource name of the catalog under which the events are +// created. The format is +// `projects/${projectId}/locations/global/collections/{$collectionId}/dataSto +// res/${dataStoreId}`. +func (r *ProjectsLocationsDataStoresUserEventsService) Purge(parent string, googleclouddiscoveryenginev1betapurgeusereventsrequest *GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest) *ProjectsLocationsDataStoresUserEventsPurgeCall { + c := &ProjectsLocationsDataStoresUserEventsPurgeCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddiscoveryenginev1betapurgeusereventsrequest = googleclouddiscoveryenginev1betapurgeusereventsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) Fields(s ...googleapi.Field) *ProjectsLocationsDataStoresUserEventsPurgeCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) Context(ctx context.Context) *ProjectsLocationsDataStoresUserEventsPurgeCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.googleclouddiscoveryenginev1betapurgeusereventsrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+parent}/userEvents:purge") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.dataStores.userEvents.purge" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsDataStoresUserEventsPurgeCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil +} + type ProjectsLocationsDataStoresUserEventsWriteCall struct { s *Service parent string @@ -39483,8 +39942,8 @@ type ProjectsLocationsSampleQuerySetsDeleteCall struct { // Delete: Deletes a SampleQuerySet. // // - name: Full resource name of SampleQuerySet, such as -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. -// If the caller does not have permission to delete the SampleQuerySet, +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// `. If the caller does not have permission to delete the SampleQuerySet, // regardless of whether or not it exists, a `PERMISSION_DENIED` error is // returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` // error is returned. @@ -39585,8 +40044,8 @@ type ProjectsLocationsSampleQuerySetsGetCall struct { // Get: Gets a SampleQuerySet. // // - name: Full resource name of SampleQuerySet, such as -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. -// If the caller does not have permission to access the SampleQuerySet, +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// `. If the caller does not have permission to access the SampleQuerySet, // regardless of whether or not it exists, a PERMISSION_DENIED error is // returned. If the requested SampleQuerySet does not exist, a NOT_FOUND // error is returned. @@ -39850,10 +40309,10 @@ type ProjectsLocationsSampleQuerySetsPatchCall struct { // Patch: Updates a SampleQuerySet. // -// - name: Immutable. The full resource name of the SampleQuerySet, in the +// - name: Identifier. The full resource name of the SampleQuerySet, in the // format of -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. -// This field must be a UTF-8 encoded string with a length limit of 1024 +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// `. This field must be a UTF-8 encoded string with a length limit of 1024 // characters. func (r *ProjectsLocationsSampleQuerySetsService) Patch(name string, googleclouddiscoveryenginev1betasamplequeryset *GoogleCloudDiscoveryengineV1betaSampleQuerySet) *ProjectsLocationsSampleQuerySetsPatchCall { c := &ProjectsLocationsSampleQuerySetsPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} @@ -40191,8 +40650,8 @@ type ProjectsLocationsSampleQuerySetsSampleQueriesDeleteCall struct { // Delete: Deletes a SampleQuery. // // - name: Full resource name of SampleQuery, such as -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/s -// ampleQueries/{sampleQuery}`. If the caller does not have permission to +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// /sampleQueries/{sample_query}`. If the caller does not have permission to // delete the SampleQuery, regardless of whether or not it exists, a // `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does // not exist, a `NOT_FOUND` error is returned. @@ -40293,8 +40752,8 @@ type ProjectsLocationsSampleQuerySetsSampleQueriesGetCall struct { // Get: Gets a SampleQuery. // // - name: Full resource name of SampleQuery, such as -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/s -// ampleQueries/{sampleQuery}`. If the caller does not have permission to +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// /sampleQueries/{sample_query}`. If the caller does not have permission to // access the SampleQuery, regardless of whether or not it exists, a // PERMISSION_DENIED error is returned. If the requested SampleQuery does not // exist, a NOT_FOUND error is returned. @@ -40666,10 +41125,10 @@ type ProjectsLocationsSampleQuerySetsSampleQueriesPatchCall struct { // Patch: Updates a SampleQuery. // -// - name: Immutable. The full resource name of the sample query, in the format -// of -// `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/s -// ampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string +// - name: Identifier. The full resource name of the sample query, in the +// format of +// `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set} +// /sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string // with a length limit of 1024 characters. func (r *ProjectsLocationsSampleQuerySetsSampleQueriesService) Patch(name string, googleclouddiscoveryenginev1betasamplequery *GoogleCloudDiscoveryengineV1betaSampleQuery) *ProjectsLocationsSampleQuerySetsSampleQueriesPatchCall { c := &ProjectsLocationsSampleQuerySetsSampleQueriesPatchCall{s: r.s, urlParams_: make(gensupport.URLParams)} diff --git a/places/v1/places-api.json b/places/v1/places-api.json index d0b78e7d4dd..8ec83107592 100644 --- a/places/v1/places-api.json +++ b/places/v1/places-api.json @@ -276,7 +276,7 @@ } } }, - "revision": "20240519", + "revision": "20240729", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1287,7 +1287,7 @@ "id": "GoogleMapsPlacesV1PlaceOpeningHours", "properties": { "openNow": { - "description": "Is this place open right now? Always present unless we lack time-of-day or timezone data for these opening hours.", + "description": "Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active.", "type": "boolean" }, "periods": { diff --git a/places/v1/places-gen.go b/places/v1/places-gen.go index ffd6a4a4513..8ac63124559 100644 --- a/places/v1/places-gen.go +++ b/places/v1/places-gen.go @@ -1511,8 +1511,10 @@ func (s GoogleMapsPlacesV1PlaceGenerativeSummary) MarshalJSON() ([]byte, error) // GoogleMapsPlacesV1PlaceOpeningHours: Information about business hour of the // place. type GoogleMapsPlacesV1PlaceOpeningHours struct { - // OpenNow: Is this place open right now? Always present unless we lack - // time-of-day or timezone data for these opening hours. + // OpenNow: Whether the opening hours period is currently active. For regular + // opening hours and current opening hours, this field means whether the place + // is open. For secondary opening hours and current secondary opening hours, + // this field means whether the secondary hours of this place is active. OpenNow bool `json:"openNow,omitempty"` // Periods: The periods that this place is open during the week. The periods // are in chronological order, starting with Sunday in the place-local