google-api-python-client 2.136.0__py2.py3-none-any.whl → 2.138.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json

@@ -2428,6 +2428,31 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"getUriPatternDocumentData": {
+"description": "Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:getUriPatternDocumentData",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData",
+"parameterOrder": [
+"siteSearchEngine"
+],
+"parameters": {
+"siteSearchEngine": {
+"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+siteSearchEngine}:getUriPatternDocumentData",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "recrawlUris": {
 "description": "Request on-demand recrawl for a list of URIs.",
 "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris",
@@ -2455,6 +2480,34 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"setUriPatternDocumentData": {
+"description": "Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:setUriPatternDocumentData",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData",
+"parameterOrder": [
+"siteSearchEngine"
+],
+"parameters": {
+"siteSearchEngine": {
+"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+siteSearchEngine}:setUriPatternDocumentData",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -6377,6 +6430,133 @@
 }
 },
 "evaluations": {
+"methods": {
+"create": {
+"description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.evaluations.create",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/evaluations",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a Evaluation.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.evaluations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Gets a list of Evaluations.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.evaluations.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"pageSize": {
+"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"location": "query",
+"type": "string"
+},
+"parent": {
+"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+parent}/evaluations",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"listResults": {
+"description": "Gets a list of results for a given a Evaluation.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.evaluations.listResults",
+"parameterOrder": [
+"evaluation"
+],
+"parameters": {
+"evaluation": {
+"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+evaluation}:listResults",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
 "resources": {
 "operations": {
 "methods": {
@@ -6441,6 +6621,80 @@
 }
 }
 },
+"identity_mapping_stores": {
+"resources": {
+"operations": {
+"methods": {
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
 "operations": {
 "methods": {
 "get": {
@@ -6576,125 +6830,169 @@
 }
 },
 "sampleQuerySets": {
-"resources": {
-"operations": {
 "methods": {
-"get": {
-"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}",
-"httpMethod": "GET",
-"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get",
+"create": {
+"description": "Creates a SampleQuerySet",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.sampleQuerySets.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"name": {
-"description": "The name of the operation resource.",
+"parent": {
+"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+},
+"sampleQuerySetId": {
+"description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"location": "query",
+"type": "string"
 }
 },
-"path": "v1alpha/{+name}",
+"path": "v1alpha/{+parent}/sampleQuerySets",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet"
+},
 "response": {
-"$ref": "GoogleLongrunningOperation"
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
-}
-}
-}
-}
 },
-"userEvents": {
-"methods": {
-"collect": {
-"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect",
-"httpMethod": "GET",
-"id": "discoveryengine.projects.locations.userEvents.collect",
+"delete": {
+"description": "Deletes a SampleQuerySet.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}",
+"httpMethod": "DELETE",
+"id": "discoveryengine.projects.locations.sampleQuerySets.delete",
 "parameterOrder": [
-"parent"
+"name"
 ],
 "parameters": {
-"ets": {
-"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
-"format": "int64",
-"location": "query",
-"type": "string"
-},
-"parent": {
-"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
+"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.",
 "location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"uri": {
-"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.",
-"location": "query",
-"type": "string"
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
 },
-"userEvent": {
-"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
-"location": "query",
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a SampleQuerySet.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.sampleQuerySets.get",
+"parameterOrder": [
+"name"
+],
+"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.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
+"required": true,
 "type": "string"
 }
 },
-"path": "v1alpha/{+parent}/userEvents:collect",
+"path": "v1alpha/{+name}",
 "response": {
-"$ref": "GoogleApiHttpBody"
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
-"write": {
-"description": "Writes a single user event.",
-"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write",
-"httpMethod": "POST",
-"id": "discoveryengine.projects.locations.userEvents.write",
+"list": {
+"description": "Gets a list of SampleQuerySets.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.sampleQuerySets.list",
 "parameterOrder": [
 "parent"
 ],
 "parameters": {
+"pageSize": {
+"description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"location": "query",
+"type": "string"
+},
 "parent": {
-"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
+"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.",
 "location": "path",
 "pattern": "^projects/[^/]+/locations/[^/]+$",
 "required": true,
 "type": "string"
+}
 },
-"writeAsync": {
-"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.",
+"path": "v1alpha/{+parent}/sampleQuerySets",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Updates a SampleQuerySet.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}",
+"httpMethod": "PATCH",
+"id": "discoveryengine.projects.locations.sampleQuerySets.patch",
+"parameterOrder": [
+"name"
+],
+"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.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.",
+"format": "google-fieldmask",
 "location": "query",
-"type": "boolean"
+"type": "string"
 }
 },
-"path": "v1alpha/{+parent}/userEvents:write",
+"path": "v1alpha/{+name}",
 "request": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent"
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet"
 },
 "response": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent"
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 }
-}
-}
-}
 },
+"resources": {
 "operations": {
 "methods": {
 "get": {
 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
-"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}",
 "httpMethod": "GET",
-"id": "discoveryengine.projects.operations.get",
+"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get",
 "parameterOrder": [
 "name"
 ],
@@ -6702,7 +7000,7 @@
 "name": {
 "description": "The name of the operation resource.",
 "location": "path",
-"pattern": "^projects/[^/]+/operations/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$",
 "required": true,
 "type": "string"
 }
@@ -6714,85 +7012,381 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+}
+}
 },
-"list": {
-"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
-"flatPath": "v1alpha/projects/{projectsId}/operations",
-"httpMethod": "GET",
-"id": "discoveryengine.projects.operations.list",
+"sampleQueries": {
+"methods": {
+"create": {
+"description": "Creates a SampleQuery",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create",
 "parameterOrder": [
-"name"
+"parent"
 ],
 "parameters": {
-"filter": {
-"description": "The standard list filter.",
+"parent": {
+"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
+"required": true,
+"type": "string"
+},
+"sampleQueryId": {
+"description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "location": "query",
 "type": "string"
+}
+},
+"path": "v1alpha/{+parent}/sampleQueries",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
+"delete": {
+"description": "Deletes a SampleQuery.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}",
+"httpMethod": "DELETE",
+"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
 "name": {
-"description": "The name of the operation's parent resource.",
+"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.",
 "location": "path",
-"pattern": "^projects/[^/]+$",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "GoogleProtobufEmpty"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets a SampleQuery.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get",
+"parameterOrder": [
+"name"
+],
+"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.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"import": {
+"description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
 "required": true,
 "type": "string"
+}
+},
+"path": "v1alpha/{+parent}/sampleQueries:import",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 },
+"list": {
+"description": "Gets a list of SampleQuerys.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
 "pageSize": {
-"description": "The standard list page size.",
+"description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.",
 "format": "int32",
 "location": "query",
 "type": "integer"
 },
 "pageToken": {
-"description": "The standard list page token.",
+"description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "location": "query",
 "type": "string"
+},
+"parent": {
+"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$",
+"required": true,
+"type": "string"
 }
 },
-"path": "v1alpha/{+name}/operations",
+"path": "v1alpha/{+parent}/sampleQueries",
 "response": {
-"$ref": "GoogleLongrunningListOperationsResponse"
+"$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse"
 },
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"patch": {
+"description": "Updates a SampleQuery.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}",
+"httpMethod": "PATCH",
+"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch",
+"parameterOrder": [
+"name"
+],
+"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.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$",
+"required": true,
+"type": "string"
+},
+"updateMask": {
+"description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.",
+"format": "google-fieldmask",
+"location": "query",
+"type": "string"
 }
+},
+"path": "v1alpha/{+name}",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 }
 }
 }
 },
-"revision": "20240621",
-"rootUrl": "https://discoveryengine.googleapis.com/",
-"schemas": {
-"GoogleApiDistribution": {
-"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.",
-"id": "GoogleApiDistribution",
-"properties": {
-"bucketCounts": {
-"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).",
-"items": {
+"userEvents": {
+"methods": {
+"collect": {
+"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.userEvents.collect",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"ets": {
+"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
 "format": "int64",
+"location": "query",
 "type": "string"
 },
-"type": "array"
-},
-"bucketOptions": {
-"$ref": "GoogleApiDistributionBucketOptions",
-"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field."
+"parent": {
+"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
 },
-"count": {
-"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.",
-"format": "int64",
+"uri": {
+"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.",
+"location": "query",
 "type": "string"
 },
-"exemplars": {
-"description": "Must be in increasing order of `value` field.",
-"items": {
-"$ref": "GoogleApiDistributionExemplar"
+"userEvent": {
+"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
+"location": "query",
+"type": "string"
+}
 },
-"type": "array"
+"path": "v1alpha/{+parent}/userEvents:collect",
+"response": {
+"$ref": "GoogleApiHttpBody"
 },
-"mean": {
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"write": {
+"description": "Writes a single user event.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.userEvents.write",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+},
+"writeAsync": {
+"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1alpha/{+parent}/userEvents:write",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
+"operations": {
+"methods": {
+"get": {
+"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
+"flatPath": "v1alpha/projects/{projectsId}/operations",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.operations.list",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"filter": {
+"description": "The standard list filter.",
+"location": "query",
+"type": "string"
+},
+"name": {
+"description": "The name of the operation's parent resource.",
+"location": "path",
+"pattern": "^projects/[^/]+$",
+"required": true,
+"type": "string"
+},
+"pageSize": {
+"description": "The standard list page size.",
+"format": "int32",
+"location": "query",
+"type": "integer"
+},
+"pageToken": {
+"description": "The standard list page token.",
+"location": "query",
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}/operations",
+"response": {
+"$ref": "GoogleLongrunningListOperationsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+}
+},
+"revision": "20240715",
+"rootUrl": "https://discoveryengine.googleapis.com/",
+"schemas": {
+"GoogleApiDistribution": {
+"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.",
+"id": "GoogleApiDistribution",
+"properties": {
+"bucketCounts": {
+"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).",
+"items": {
+"format": "int64",
+"type": "string"
+},
+"type": "array"
+},
+"bucketOptions": {
+"$ref": "GoogleApiDistributionBucketOptions",
+"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field."
+},
+"count": {
+"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.",
+"format": "int64",
+"type": "string"
+},
+"exemplars": {
+"description": "Must be in increasing order of `value` field.",
+"items": {
+"$ref": "GoogleApiDistributionExemplar"
+},
+"type": "array"
+},
+"mean": {
 "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.",
 "format": "double",
 "type": "number"
@@ -7587,7 +8181,7 @@
 "additionalProperties": {
 "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig"
 },
-"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.",
+"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.",
 "type": "object"
 }
 },
@@ -8875,7 +9469,7 @@
 "type": "string"
 },
 "searchResultMode": {
-"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)",
+"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)",
 "enum": [
 "SEARCH_RESULT_MODE_UNSPECIFIED",
 "DOCUMENTS",
@@ -9026,7 +9620,7 @@
 "properties": {
 "answer": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer",
-"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API."
+"description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API."
 },
 "answerQueryToken": {
 "description": "A global unique ID used for logging.",
@@ -9285,6 +9879,14 @@
 },
 "type": "array"
 },
+"structData": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .",
+"type": "object"
+},
 "title": {
 "description": "Title.",
 "type": "string"
@@ -9684,7 +10286,7 @@
 "type": "string"
 },
 "resources": {
-"description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id`",
+"description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` * `branch`_`id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id`",
 "items": {
 "$ref": "GoogleApiMonitoredResource"
 },
@@ -10382,6 +10984,12 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": {
+"description": "Metadata for EvaluationService.CreateEvaluation method.",
+"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": {
 "description": "Metadata for Create Schema LRO.",
 "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata",
@@ -10469,6 +11077,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel",
 "properties": {
 "createTime": {
+"deprecated": true,
 "description": "Timestamp the Model was created at.",
 "format": "google-datetime",
 "type": "string"
@@ -10477,6 +11086,14 @@
 "description": "The display name of the model.",
 "type": "string"
 },
+"metrics": {
+"additionalProperties": {
+"format": "double",
+"type": "number"
+},
+"description": "The metrics of the trained model.",
+"type": "object"
+},
 "modelState": {
 "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
 "enum": [
@@ -10485,7 +11102,8 @@
 "TRAINING",
 "TRAINING_COMPLETE",
 "READY_FOR_SERVING",
-"TRAINING_FAILED"
+"TRAINING_FAILED",
+"NO_IMPROVEMENT"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -10493,7 +11111,8 @@
 "The model is currently training.",
 "The model has successfully completed training.",
 "The model is ready for serving.",
-"The model training failed."
+"The model training failed.",
+"The model training finished successfully but metrics did not improve."
 ],
 "type": "string"
 },
@@ -10868,7 +11487,7 @@
 "additionalProperties": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig"
 },
-"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.",
+"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.",
 "type": "object"
 }
 },
@@ -11397,6 +12016,128 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaEvaluation": {
+"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.",
+"id": "GoogleCloudDiscoveryengineV1alphaEvaluation",
+"properties": {
+"createTime": {
+"description": "Output only. Timestamp the Evaluation was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"endTime": {
+"description": "Output only. Timestamp the Evaluation was completed at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.",
+"readOnly": true
+},
+"errorSamples": {
+"description": "Output only. A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"readOnly": true,
+"type": "array"
+},
+"evaluationSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec",
+"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.",
+"type": "string"
+},
+"qualityMetrics": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics",
+"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.",
+"readOnly": true
+},
+"state": {
+"description": "Output only. The state of the evaluation.",
+"enum": [
+"STATE_UNSPECIFIED",
+"PENDING",
+"RUNNING",
+"SUCCEEDED",
+"FAILED"
+],
+"enumDescriptions": [
+"The evaluation is unspecified.",
+"The service is preparing to run the evaluation.",
+"The evaluation is in progress.",
+"The evaluation completed successfully.",
+"The evaluation failed."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": {
+"description": "Describes the specification of the evaluation.",
+"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec",
+"properties": {
+"querySetSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec",
+"description": "Required. The specification of the query set."
+},
+"searchRequest": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest",
+"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": {
+"description": "Describes the specification of the query set.",
+"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec",
+"properties": {
+"sampleQuerySet": {
+"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": {
+"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": {
+"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."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaFactChunk": {
 "description": "Fact Chunk.",
 "id": "GoogleCloudDiscoveryengineV1alphaFactChunk",
@@ -11654,6 +12395,24 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": {
+"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.",
+"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse",
+"properties": {
+"documentDataMap": {
+"additionalProperties": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }",
+"type": "object"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaGroundingFact": {
 "description": "Grounding Fact.",
 "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact",
@@ -11959,9 +12718,96 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": {
-"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
-"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata",
+"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": {
+"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata",
+"properties": {
+"createTime": {
+"description": "ImportSampleQueries operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"failureCount": {
+"description": "Count of SampleQuerys that failed to be imported.",
+"format": "int64",
+"type": "string"
+},
+"successCount": {
+"description": "Count of SampleQuerys successfully imported.",
+"format": "int64",
+"type": "string"
+},
+"totalCount": {
+"description": "Total count of SampleQuerys that were processed.",
+"format": "int64",
+"type": "string"
+},
+"updateTime": {
+"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": {
+"description": "Request message for SampleQueryService.ImportSampleQueries method.",
+"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest",
+"properties": {
+"bigquerySource": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource",
+"description": "BigQuery input source."
+},
+"errorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
+"description": "The desired location of errors incurred during the Import."
+},
+"gcsSource": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource",
+"description": "Cloud Storage location for the input content."
+},
+"inlineSource": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource",
+"description": "The Inline source for sample query entries."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": {
+"description": "The inline source for SampleQuerys.",
+"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource",
+"properties": {
+"sampleQueries": {
+"description": "Required. A list of SampleQuerys to import. Max of 1000 items.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": {
+"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
+"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse",
+"properties": {
+"errorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig",
+"description": "The desired location of errors incurred during the Import."
+},
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": {
+"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata",
 "properties": {
 "createTime": {
 "description": "Operation create time.",
@@ -12296,6 +13142,95 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": {
+"description": "Response message for EvaluationService.ListEvaluationResults method.",
+"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse",
+"properties": {
+"evaluationResults": {
+"description": "The EvaluationResults.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": {
+"description": "Represents the results of an evaluation for a single SampleQuery.",
+"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult",
+"properties": {
+"qualityMetrics": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics",
+"description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.",
+"readOnly": true
+},
+"sampleQuery": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery",
+"description": "Output only. The SampleQuery that was evaluated.",
+"readOnly": true
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": {
+"description": "Response message for EvaluationService.ListEvaluations method.",
+"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse",
+"properties": {
+"evaluations": {
+"description": "The Evaluations.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation"
+},
+"type": "array"
+},
+"nextPageToken": {
+"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": {
+"description": "Response message for SampleQueryService.ListSampleQueries method.",
+"id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse",
+"properties": {
+"nextPageToken": {
+"description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+"type": "string"
+},
+"sampleQueries": {
+"description": "The SampleQuerys.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": {
+"description": "Response message for SampleQuerySetService.ListSampleQuerySets method.",
+"id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse",
+"properties": {
+"nextPageToken": {
+"description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+"type": "string"
+},
+"sampleQuerySets": {
+"description": "The SampleQuerySets.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": {
 "description": "Response message for SchemaService.ListSchemas method.",
 "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse",
@@ -12390,6 +13325,32 @@
 },
 "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",
@@ -12790,6 +13751,60 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaQualityMetrics": {
+"description": "Describes the metrics produced by the evaluation.",
+"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics",
+"properties": {
+"docNdcg": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
+"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693"
+},
+"docPrecision": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
+"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8"
+},
+"docRecall": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
+"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6"
+},
+"pageNdcg": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
+"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693"
+},
+"pageRecall": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
+"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": {
+"description": "Stores the metric values at specific top-k levels.",
+"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics",
+"properties": {
+"top1": {
+"description": "The top-1 value.",
+"format": "double",
+"type": "number"
+},
+"top10": {
+"description": "The top-10 value.",
+"format": "double",
+"type": "number"
+},
+"top3": {
+"description": "The top-3 value.",
+"format": "double",
+"type": "number"
+},
+"top5": {
+"description": "The top-5 value.",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaQuery": {
 "description": "Defines a user inputed query.",
 "id": "GoogleCloudDiscoveryengineV1alphaQuery",
@@ -13290,6 +14305,94 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSampleQuery": {
+"description": "Sample Query captures metadata to be used for evaluation.",
+"id": "GoogleCloudDiscoveryengineV1alphaSampleQuery",
+"properties": {
+"createTime": {
+"description": "Output only. Timestamp the SampleQuery was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"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.",
+"type": "string"
+},
+"queryEntry": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry",
+"description": "The query entry."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": {
+"description": "Query Entry captures metadata to be used for search evaluation.",
+"id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry",
+"properties": {
+"query": {
+"description": "Required. The query.",
+"type": "string"
+},
+"targets": {
+"description": "List of targets for the query.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": {
+"description": "Defines the parameters of the query's expected outcome.",
+"id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget",
+"properties": {
+"pageNumbers": {
+"description": "Expected page numbers of the target. Each page number must be non negative.",
+"items": {
+"format": "int32",
+"type": "integer"
+},
+"type": "array"
+},
+"score": {
+"description": "Relevance score of the target.",
+"format": "double",
+"type": "number"
+},
+"uri": {
+"description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSampleQuerySet": {
+"description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.",
+"id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet",
+"properties": {
+"createTime": {
+"description": "Output only. Timestamp the SampleQuerySet was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"description": {
+"description": "The description of the SampleQuerySet.",
+"type": "string"
+},
+"displayName": {
+"description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.",
+"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.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSchema": {
 "description": "Defines the structure and layout of a type of document data.",
 "id": "GoogleCloudDiscoveryengineV1alphaSchema",
@@ -13363,7 +14466,7 @@
 },
 "customFineTuningSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
-"description": "Custom fine tuning configs."
+"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
 },
 "dataStoreSpecs": {
 "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
@@ -13395,6 +14498,10 @@
 "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.",
 "type": "string"
 },
+"naturalLanguageQueryUnderstandingSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
+"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
+},
 "offset": {
 "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
 "format": "int32",
@@ -13429,7 +14536,7 @@
 "description": "The query expansion specification that specifies the conditions under which query expansion occurs."
 },
 "rankingExpression": {
-"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: `relevance_score`: pre-defined keywords, used for measure relevance between query and document. `embedding_field_path`: the document embedding field used with query embedding vector. `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
+"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
 "type": "string"
 },
 "regionCode": {
@@ -13462,6 +14569,18 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
 "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
 },
+"servingConfig": {
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"type": "string"
+},
+"session": {
+"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
+"type": "string"
+},
+"sessionSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec",
+"description": "Session specification. Can be used only when `session` is set."
+},
 "spellCorrectionSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec",
 "description": "The spell correction specification that specifies the mode under which spell correction takes effect."
@@ -13591,7 +14710,7 @@
 "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
 },
 "searchResultMode": {
-"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.",
+"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
 "enum": [
 "SEARCH_RESULT_MODE_UNSPECIFIED",
 "DOCUMENTS",
@@ -13748,7 +14867,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
-"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec",
 "properties": {
 "dataStore": {
@@ -13876,6 +14995,34 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": {
+"description": "Specification to enable natural language understanding capabilities for search requests.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
+"properties": {
+"filterExtractionCondition": {
+"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.",
+"enum": [
+"CONDITION_UNSPECIFIED",
+"DISABLED",
+"ENABLED"
+],
+"enumDescriptions": [
+"Server behavior defaults to Condition.DISABLED.",
+"Disables NL filter extraction.",
+"Enables NL filter extraction."
+],
+"type": "string"
+},
+"geoSearchQueryDetectionFieldNames": {
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": {
 "description": "Specification to determine under which conditions query expansion should occur.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec",
@@ -13922,13 +15069,29 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": {
-"description": "The specification for query spell correction.",
-"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec",
+"GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": {
+"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec",
 "properties": {
-"mode": {
-"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.",
-"enum": [
+"queryId": {
+"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.",
+"type": "string"
+},
+"searchResultPersistenceCount": {
+"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": {
+"description": "The specification for query spell correction.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec",
+"properties": {
+"mode": {
+"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.",
+"enum": [
 "MODE_UNSPECIFIED",
 "SUGGESTION_ONLY",
 "AUTO"
@@ -13979,6 +15142,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult",
 "description": "Guided search result."
 },
+"naturalLanguageQueryUnderstandingInfo": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo",
+"description": "Natural language query understanding information for the returned results."
+},
 "nextPageToken": {
 "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"
@@ -13998,6 +15165,10 @@
 },
 "type": "array"
 },
+"sessionInfo": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo",
+"description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
+},
 "summary": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary",
 "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set."
@@ -14103,6 +15274,165 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo": {
+"description": "Information describing what natural language understanding was done on the input query.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo",
+"properties": {
+"extractedFilters": {
+"description": "The filters that were extracted from the input query.",
+"type": "string"
+},
+"rewrittenQuery": {
+"description": "Rewritten input query minus the extracted filters.",
+"type": "string"
+},
+"structuredExtractedFilter": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
+"description": "The filters that were extracted from the input query represented in a structured form."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": {
+"description": "The filters that were extracted from the input query represented in a structured form.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
+"properties": {
+"expression": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression",
+"description": "The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": {
+"description": "Logical `And` operator.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression",
+"properties": {
+"expressions": {
+"description": "The expressions that were ANDed together.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": {
+"description": "The expression denoting the filter that was extracted from the input query.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression",
+"properties": {
+"andExpr": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression",
+"description": "Logical \"And\" compound operator connecting multiple expressions."
+},
+"geolocationConstraint": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint",
+"description": "Geolocation constraint expression."
+},
+"numberConstraint": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint",
+"description": "Numerical constraint expression."
+},
+"orExpr": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression",
+"description": "Logical \"Or\" compound operator connecting multiple expressions."
+},
+"stringConstraint": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint",
+"description": "String constraint expression."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": {
+"description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint",
+"properties": {
+"address": {
+"description": "The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results.",
+"type": "string"
+},
+"fieldName": {
+"description": "The name of the geolocation field as defined in the schema.",
+"type": "string"
+},
+"radiusInMeters": {
+"description": "The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": {
+"description": "Constraint expression of a number field. Example: price < 100.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint",
+"properties": {
+"comparison": {
+"description": "The comparison operation performed between the field value and the value specified in the constraint.",
+"enum": [
+"COMPARISON_UNSPECIFIED",
+"EQUALS",
+"LESS_THAN_EQUALS",
+"LESS_THAN",
+"GREATER_THAN_EQUALS",
+"GREATER_THAN"
+],
+"enumDescriptions": [
+"Undefined comparison operator.",
+"Denotes equality `=` operator.",
+"Denotes less than or equal to `<=` operator.",
+"Denotes less than `<` operator.",
+"Denotes greater than or equal to `>=` operator.",
+"Denotes greater than `>` operator."
+],
+"type": "string"
+},
+"fieldName": {
+"description": "Name of the numerical field as defined in the schema.",
+"type": "string"
+},
+"value": {
+"description": "The value specified in the numerical constraint.",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": {
+"description": "Logical `Or` operator.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression",
+"properties": {
+"expressions": {
+"description": "The expressions that were ORed together.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": {
+"description": "Constraint expression of a string field.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint",
+"properties": {
+"fieldName": {
+"description": "Name of the string field as defined in the schema.",
+"type": "string"
+},
+"values": {
+"description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": {
 "description": "Information describing query expansion including whether expansion has occurred.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo",
@@ -14145,6 +15475,21 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo": {
+"description": "Information about the session.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo",
+"properties": {
+"name": {
+"description": "Name of the session. If the auto-session mode is used (when SearchRequest.session ends with \"-\"), this field holds the newly generated session name.",
+"type": "string"
+},
+"queryId": {
+"description": "Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": {
 "description": "Summary of the top N search results specified by the summary spec.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary",
@@ -14341,7 +15686,7 @@
 },
 "customFineTuningSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec",
-"description": "Custom fine tuning configs."
+"description": "Custom fine tuning configs. If SearchRequest.custom_fine_tuning_spec is set, it has higher priority than the configs set here."
 },
 "displayName": {
 "description": "Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
@@ -14404,7 +15749,7 @@
 "type": "array"
 },
 "rankingExpression": {
-"description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).",
+"description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
 "type": "string"
 },
 "redirectControlIds": {
@@ -14553,6 +15898,59 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": {
+"description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.",
+"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest",
+"properties": {
+"documentDataMap": {
+"additionalProperties": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"type": "object"
+},
+"description": "Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { \"type\": \"object\", \"properties\": { \"Categories\": { \"type\": \"array\", \"items\": { \"retrievable\": true, \"type\": \"string\" } } } document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }",
+"type": "object"
+},
+"emptyDocumentDataMap": {
+"description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.",
+"type": "boolean"
+},
+"schema": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": {
+"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.",
+"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": {
 "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.",
 "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine",
@@ -15324,6 +16722,12 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": {
+"description": "Metadata for EvaluationService.CreateEvaluation method.",
+"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": {
 "description": "Metadata for Create Schema LRO.",
 "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata",
@@ -15363,6 +16767,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel",
 "properties": {
 "createTime": {
+"deprecated": true,
 "description": "Timestamp the Model was created at.",
 "format": "google-datetime",
 "type": "string"
@@ -15371,6 +16776,14 @@
 "description": "The display name of the model.",
 "type": "string"
 },
+"metrics": {
+"additionalProperties": {
+"format": "double",
+"type": "number"
+},
+"description": "The metrics of the trained model.",
+"type": "object"
+},
 "modelState": {
 "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).",
 "enum": [
@@ -15379,7 +16792,8 @@
 "TRAINING",
 "TRAINING_COMPLETE",
 "READY_FOR_SERVING",
-"TRAINING_FAILED"
+"TRAINING_FAILED",
+"NO_IMPROVEMENT"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -15387,7 +16801,8 @@
 "The model is currently training.",
 "The model has successfully completed training.",
 "The model is ready for serving.",
-"The model training failed."
+"The model training failed.",
+"The model training finished successfully but metrics did not improve."
 ],
 "type": "string"
 },
@@ -15610,7 +17025,7 @@
 "additionalProperties": {
 "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig"
 },
-"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.",
+"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.",
 "type": "object"
 }
 },
@@ -15897,6 +17312,96 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaEvaluation": {
+"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.",
+"id": "GoogleCloudDiscoveryengineV1betaEvaluation",
+"properties": {
+"createTime": {
+"description": "Output only. Timestamp the Evaluation was created at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"endTime": {
+"description": "Output only. Timestamp the Evaluation was completed at.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.",
+"readOnly": true
+},
+"errorSamples": {
+"description": "Output only. A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"readOnly": true,
+"type": "array"
+},
+"evaluationSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec",
+"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.",
+"type": "string"
+},
+"qualityMetrics": {
+"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics",
+"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.",
+"readOnly": true
+},
+"state": {
+"description": "Output only. The state of the evaluation.",
+"enum": [
+"STATE_UNSPECIFIED",
+"PENDING",
+"RUNNING",
+"SUCCEEDED",
+"FAILED"
+],
+"enumDescriptions": [
+"The evaluation is unspecified.",
+"The service is preparing to run the evaluation.",
+"The evaluation is in progress.",
+"The evaluation completed successfully.",
+"The evaluation failed."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": {
+"description": "Describes the specification of the evaluation.",
+"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec",
+"properties": {
+"querySetSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec",
+"description": "Required. The specification of the query set."
+},
+"searchRequest": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest",
+"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": {
+"description": "Describes the specification of the query set.",
+"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec",
+"properties": {
+"sampleQuerySet": {
+"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": {
 "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata",
@@ -16003,6 +17508,56 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": {
+"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata",
+"properties": {
+"createTime": {
+"description": "ImportSampleQueries operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"failureCount": {
+"description": "Count of SampleQuerys that failed to be imported.",
+"format": "int64",
+"type": "string"
+},
+"successCount": {
+"description": "Count of SampleQuerys successfully imported.",
+"format": "int64",
+"type": "string"
+},
+"totalCount": {
+"description": "Total count of SampleQuerys that were processed.",
+"format": "int64",
+"type": "string"
+},
+"updateTime": {
+"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": {
+"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
+"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse",
+"properties": {
+"errorConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig",
+"description": "The desired location of errors incurred during the Import."
+},
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": {
 "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata",
@@ -16099,8 +17654,35 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaLanguageInfo": {
-"description": "Language info for DataStore.",
+"GoogleCloudDiscoveryengineV1betaInterval": {
+"description": "A floating point interval.",
+"id": "GoogleCloudDiscoveryengineV1betaInterval",
+"properties": {
+"exclusiveMaximum": {
+"description": "Exclusive upper bound.",
+"format": "double",
+"type": "number"
+},
+"exclusiveMinimum": {
+"description": "Exclusive lower bound.",
+"format": "double",
+"type": "number"
+},
+"maximum": {
+"description": "Inclusive upper bound.",
+"format": "double",
+"type": "number"
+},
+"minimum": {
+"description": "Inclusive lower bound.",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaLanguageInfo": {
+"description": "Language info for DataStore.",
 "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo",
 "properties": {
 "language": {
@@ -16139,128 +17721,798 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaProject": {
-"description": "Metadata and configurations for a Google Cloud project in the service.",
-"id": "GoogleCloudDiscoveryengineV1betaProject",
+"GoogleCloudDiscoveryengineV1betaProject": {
+"description": "Metadata and configurations for a Google Cloud project in the service.",
+"id": "GoogleCloudDiscoveryengineV1betaProject",
+"properties": {
+"createTime": {
+"description": "Output only. The timestamp when this project is created.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
+"readOnly": true,
+"type": "string"
+},
+"provisionCompletionTime": {
+"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"serviceTermsMap": {
+"additionalProperties": {
+"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms"
+},
+"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.",
+"readOnly": true,
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": {
+"description": "Metadata about the terms of service.",
+"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms",
+"properties": {
+"acceptTime": {
+"description": "The last time when the project agreed to the terms of service.",
+"format": "google-datetime",
+"type": "string"
+},
+"declineTime": {
+"description": "The last time when the project declined or revoked the agreement to terms of service.",
+"format": "google-datetime",
+"type": "string"
+},
+"id": {
+"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.",
+"type": "string"
+},
+"state": {
+"description": "Whether the project has accepted/rejected the service terms or it is still pending.",
+"enum": [
+"STATE_UNSPECIFIED",
+"TERMS_ACCEPTED",
+"TERMS_PENDING",
+"TERMS_DECLINED"
+],
+"enumDescriptions": [
+"The default value of the enum. This value is not actually used.",
+"The project has given consent to the terms of service.",
+"The project is pending to review and accept the terms of service.",
+"The project has declined or revoked the agreement to terms of service."
+],
+"type": "string"
+},
+"version": {
+"description": "The version string of the terms of service. For acceptable values, see the comments for id above.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": {
+"description": "Metadata associated with a project provision operation.",
+"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata",
+"properties": {},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": {
+"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"failureCount": {
+"description": "Count of entries that encountered errors while processing.",
+"format": "int64",
+"type": "string"
+},
+"ignoredCount": {
+"description": "Count of entries that were ignored as entries were not found.",
+"format": "int64",
+"type": "string"
+},
+"successCount": {
+"description": "Count of entries that were deleted successfully.",
+"format": "int64",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": {
+"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.",
+"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse",
+"properties": {
+"purgeCount": {
+"description": "The total count of documents purged as a result of the operation.",
+"format": "int64",
+"type": "string"
+},
+"purgeSample": {
+"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"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",
+"properties": {
+"createTime": {
+"description": "Operation create time.",
+"format": "google-datetime",
+"type": "string"
+},
+"updateTime": {
+"description": "Operation last update time. If the operation is done, this is also the finish time.",
+"format": "google-datetime",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": {
+"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.",
+"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse",
+"properties": {
+"errorSamples": {
+"description": "A sample of errors encountered while processing the request.",
+"items": {
+"$ref": "GoogleRpcStatus"
+},
+"type": "array"
+},
+"purgeCount": {
+"description": "Number of suggestion deny list entries purged.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaQualityMetrics": {
+"description": "Describes the metrics produced by the evaluation.",
+"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics",
+"properties": {
+"docNdcg": {
+"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
+"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693"
+},
+"docPrecision": {
+"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
+"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8"
+},
+"docRecall": {
+"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
+"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6"
+},
+"pageNdcg": {
+"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
+"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693"
+},
+"pageRecall": {
+"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
+"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": {
+"description": "Stores the metric values at specific top-k levels.",
+"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics",
+"properties": {
+"top1": {
+"description": "The top-1 value.",
+"format": "double",
+"type": "number"
+},
+"top10": {
+"description": "The top-10 value.",
+"format": "double",
+"type": "number"
+},
+"top3": {
+"description": "The top-3 value.",
+"format": "double",
+"type": "number"
+},
+"top5": {
+"description": "The top-5 value.",
+"format": "double",
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSchema": {
+"description": "Defines the structure and layout of a type of document data.",
+"id": "GoogleCloudDiscoveryengineV1betaSchema",
+"properties": {
+"jsonSchema": {
+"description": "The JSON representation of the schema.",
+"type": "string"
+},
+"name": {
+"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
+"type": "string"
+},
+"structSchema": {
+"additionalProperties": {
+"description": "Properties of the object.",
+"type": "any"
+},
+"description": "The structured representation of the schema.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequest": {
+"description": "Request message for SearchService.Search method.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequest",
+"properties": {
+"boostSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
+"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)"
+},
+"branch": {
+"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.",
+"type": "string"
+},
+"canonicalFilter": {
+"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.",
+"type": "string"
+},
+"contentSearchSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec",
+"description": "A specification for configuring the behavior of content search."
+},
+"dataStoreSpecs": {
+"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
+},
+"type": "array"
+},
+"embeddingSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
+"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path."
+},
+"facetSpecs": {
+"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec"
+},
+"type": "array"
+},
+"filter": {
+"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)",
+"type": "string"
+},
+"imageQuery": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery",
+"description": "Raw image query."
+},
+"languageCode": {
+"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.",
+"type": "string"
+},
+"naturalLanguageQueryUnderstandingSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
+"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done."
+},
+"offset": {
+"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"format": "int32",
+"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.",
+"type": "string"
+},
+"pageSize": {
+"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"format": "int32",
+"type": "integer"
+},
+"pageToken": {
+"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"type": "string"
+},
+"params": {
+"additionalProperties": {
+"type": "any"
+},
+"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`",
+"type": "object"
+},
+"query": {
+"description": "Raw search query.",
+"type": "string"
+},
+"queryExpansionSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec",
+"description": "The query expansion specification that specifies the conditions under which query expansion occurs."
+},
+"rankingExpression": {
+"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.",
+"type": "string"
+},
+"regionCode": {
+"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
+"type": "string"
+},
+"safeSearch": {
+"description": "Whether to turn on safe search. This is only supported for website search.",
+"type": "boolean"
+},
+"searchAsYouTypeSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
+"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical."
+},
+"servingConfig": {
+"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.",
+"type": "string"
+},
+"session": {
+"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
+"type": "string"
+},
+"sessionSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec",
+"description": "Session specification. Can be used only when `session` is set."
+},
+"spellCorrectionSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec",
+"description": "The spell correction specification that specifies the mode under which spell correction takes effect."
+},
+"userInfo": {
+"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
+"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics."
+},
+"userLabels": {
+"additionalProperties": {
+"type": "string"
+},
+"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
+"type": "object"
+},
+"userPseudoId": {
+"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": {
+"description": "Boost specification to boost certain documents.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec",
+"properties": {
+"conditionBoostSpecs": {
+"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": {
+"description": "Boost applies to documents which match a condition.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec",
+"properties": {
+"boost": {
+"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.",
+"format": "float",
+"type": "number"
+},
+"boostControlSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec",
+"description": "Complex specification for custom ranking based on customer defined attribute value."
+},
+"condition": {
+"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": {
+"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec",
+"properties": {
+"attributeType": {
+"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).",
+"enum": [
+"ATTRIBUTE_TYPE_UNSPECIFIED",
+"NUMERICAL",
+"FRESHNESS"
+],
+"enumDescriptions": [
+"Unspecified AttributeType.",
+"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.",
+"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`."
+],
+"type": "string"
+},
+"controlPoints": {
+"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint"
+},
+"type": "array"
+},
+"fieldName": {
+"description": "The name of the field whose value will be used to determine the boost amount.",
+"type": "string"
+},
+"interpolationType": {
+"description": "The interpolation type to be applied to connect the control points listed below.",
+"enum": [
+"INTERPOLATION_TYPE_UNSPECIFIED",
+"LINEAR"
+],
+"enumDescriptions": [
+"Interpolation type is unspecified. In this case, it defaults to Linear.",
+"Piecewise linear interpolation will be applied."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": {
+"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint",
+"properties": {
+"attributeValue": {
+"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.",
+"type": "string"
+},
+"boostAmount": {
+"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.",
+"format": "float",
+"type": "number"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": {
+"description": "A specification for configuring the behavior of content search.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec",
+"properties": {
+"chunkSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec",
+"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS"
+},
+"extractiveContentSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec",
+"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response."
+},
+"searchResultMode": {
+"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.",
+"enum": [
+"SEARCH_RESULT_MODE_UNSPECIFIED",
+"DOCUMENTS",
+"CHUNKS"
+],
+"enumDescriptions": [
+"Default value.",
+"Returns documents in the search result.",
+"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified."
+],
+"type": "string"
+},
+"snippetSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec",
+"description": "If `snippetSpec` is not specified, snippets are not included in the search response."
+},
+"summarySpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec",
+"description": "If `summarySpec` is not specified, summaries are not included in the search response."
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": {
+"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec",
+"properties": {
+"numNextChunks": {
+"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.",
+"format": "int32",
+"type": "integer"
+},
+"numPreviousChunks": {
+"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.",
+"format": "int32",
+"type": "integer"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": {
+"description": "A specification for configuring the extractive content in a search response.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec",
+"properties": {
+"maxExtractiveAnswerCount": {
+"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.",
+"format": "int32",
+"type": "integer"
+},
+"maxExtractiveSegmentCount": {
+"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.",
+"format": "int32",
+"type": "integer"
+},
+"numNextSegments": {
+"description": "Return at most `num_next_segments` segments after each selected segments.",
+"format": "int32",
+"type": "integer"
+},
+"numPreviousSegments": {
+"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.",
+"format": "int32",
+"type": "integer"
+},
+"returnExtractiveSegmentScore": {
+"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": {
+"description": "A specification for configuring snippets in a search response.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec",
+"properties": {
+"maxSnippetCount": {
+"deprecated": true,
+"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.",
+"format": "int32",
+"type": "integer"
+},
+"referenceOnly": {
+"deprecated": true,
+"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.",
+"type": "boolean"
+},
+"returnSnippet": {
+"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": {
+"description": "A specification for configuring a summary returned in a search response.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec",
+"properties": {
+"ignoreAdversarialQuery": {
+"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"
+},
+"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"
+},
+"includeCitations": {
+"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.",
+"type": "boolean"
+},
+"languageCode": {
+"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.",
+"type": "string"
+},
+"modelPromptSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec",
+"description": "If specified, the spec will be used to modify the prompt provided to the LLM."
+},
+"modelSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec",
+"description": "If specified, the spec will be used to modify the model specification provided to the LLM."
+},
+"summaryResultCount": {
+"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.",
+"format": "int32",
+"type": "integer"
+},
+"useSemanticChunks": {
+"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": {
+"description": "Specification of the prompt to use with the model.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec",
+"properties": {
+"preamble": {
+"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": {
+"description": "Specification of the model.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec",
+"properties": {
+"version": {
+"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": {
+"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec",
+"properties": {
+"dataStore": {
+"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": {
+"description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",
+"properties": {
+"embeddingVectors": {
+"description": "The embedding vector used for retrieval. Limit to 1.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": {
+"description": "Embedding vector.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector",
 "properties": {
-"createTime": {
-"description": "Output only. The timestamp when this project is created.",
-"format": "google-datetime",
-"readOnly": true,
-"type": "string"
-},
-"name": {
-"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.",
-"readOnly": true,
-"type": "string"
-},
-"provisionCompletionTime": {
-"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.",
-"format": "google-datetime",
-"readOnly": true,
+"fieldPath": {
+"description": "Embedding field path in schema.",
 "type": "string"
 },
-"serviceTermsMap": {
-"additionalProperties": {
-"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms"
+"vector": {
+"description": "Query embedding vector.",
+"items": {
+"format": "float",
+"type": "number"
 },
-"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.",
-"readOnly": true,
-"type": "object"
+"type": "array"
 }
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": {
-"description": "Metadata about the terms of service.",
-"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms",
+"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": {
+"description": "A facet specification to perform faceted search.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec",
 "properties": {
-"acceptTime": {
-"description": "The last time when the project agreed to the terms of service.",
-"format": "google-datetime",
-"type": "string"
+"enableDynamicPosition": {
+"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.",
+"type": "boolean"
 },
-"declineTime": {
-"description": "The last time when the project declined or revoked the agreement to terms of service.",
-"format": "google-datetime",
+"excludedFilterKeys": {
+"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"items": {
 "type": "string"
 },
-"id": {
-"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.",
-"type": "string"
+"type": "array"
 },
-"state": {
-"description": "Whether the project has accepted/rejected the service terms or it is still pending.",
-"enum": [
-"STATE_UNSPECIFIED",
-"TERMS_ACCEPTED",
-"TERMS_PENDING",
-"TERMS_DECLINED"
-],
-"enumDescriptions": [
-"The default value of the enum. This value is not actually used.",
-"The project has given consent to the terms of service.",
-"The project is pending to review and accept the terms of service.",
-"The project has declined or revoked the agreement to terms of service."
-],
-"type": "string"
+"facetKey": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey",
+"description": "Required. The facet key specification."
 },
-"version": {
-"description": "The version string of the terms of service. For acceptable values, see the comments for id above.",
-"type": "string"
+"limit": {
+"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.",
+"format": "int32",
+"type": "integer"
 }
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": {
-"description": "Metadata associated with a project provision operation.",
-"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata",
-"properties": {},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": {
-"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.",
-"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata",
+"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": {
+"description": "Specifies how a facet is computed.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey",
 "properties": {
-"createTime": {
-"description": "Operation create time.",
-"format": "google-datetime",
+"caseInsensitive": {
+"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.",
+"type": "boolean"
+},
+"contains": {
+"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.",
+"items": {
 "type": "string"
 },
-"failureCount": {
-"description": "Count of entries that encountered errors while processing.",
-"format": "int64",
+"type": "array"
+},
+"intervals": {
+"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaInterval"
+},
+"type": "array"
+},
+"key": {
+"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.",
 "type": "string"
 },
-"ignoredCount": {
-"description": "Count of entries that were ignored as entries were not found.",
-"format": "int64",
+"orderBy": {
+"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.",
 "type": "string"
 },
-"successCount": {
-"description": "Count of entries that were deleted successfully.",
-"format": "int64",
+"prefixes": {
+"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.",
+"items": {
 "type": "string"
 },
-"updateTime": {
-"description": "Operation last update time. If the operation is done, this is also the finish time.",
-"format": "google-datetime",
+"type": "array"
+},
+"restrictedValues": {
+"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.",
+"items": {
 "type": "string"
+},
+"type": "array"
 }
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": {
-"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.",
-"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse",
+"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": {
+"description": "Specifies the image query input.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery",
 "properties": {
-"purgeCount": {
-"description": "The total count of documents purged as a result of the operation.",
-"format": "int64",
+"imageBytes": {
+"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.",
 "type": "string"
+}
 },
-"purgeSample": {
-"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.",
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": {
+"description": "Specification to enable natural language understanding capabilities for search requests.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
+"properties": {
+"filterExtractionCondition": {
+"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.",
+"enum": [
+"CONDITION_UNSPECIFIED",
+"DISABLED",
+"ENABLED"
+],
+"enumDescriptions": [
+"Server behavior defaults to Condition.DISABLED.",
+"Disables NL filter extraction.",
+"Enables NL filter extraction."
+],
+"type": "string"
+},
+"geoSearchQueryDetectionFieldNames": {
+"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.",
 "items": {
 "type": "string"
 },
@@ -16269,61 +18521,85 @@
 },
 "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",
+"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": {
+"description": "Specification to determine under which conditions query expansion should occur.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec",
 "properties": {
-"createTime": {
-"description": "Operation create time.",
-"format": "google-datetime",
+"condition": {
+"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.",
+"enum": [
+"CONDITION_UNSPECIFIED",
+"DISABLED",
+"AUTO"
+],
+"enumDescriptions": [
+"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.",
+"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.",
+"Automatic query expansion built by the Search API."
+],
 "type": "string"
 },
-"updateTime": {
-"description": "Operation last update time. If the operation is done, this is also the finish time.",
-"format": "google-datetime",
-"type": "string"
+"pinUnexpandedResults": {
+"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.",
+"type": "boolean"
 }
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": {
-"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.",
-"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse",
+"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": {
+"description": "Specification for search as you type in search requests.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
 "properties": {
-"errorSamples": {
-"description": "A sample of errors encountered while processing the request.",
-"items": {
-"$ref": "GoogleRpcStatus"
-},
-"type": "array"
-},
-"purgeCount": {
-"description": "Number of suggestion deny list entries purged.",
-"format": "int64",
+"condition": {
+"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.",
+"enum": [
+"CONDITION_UNSPECIFIED",
+"DISABLED",
+"ENABLED"
+],
+"enumDescriptions": [
+"Server behavior defaults to Condition.DISABLED.",
+"Disables Search As You Type.",
+"Enables Search As You Type."
+],
 "type": "string"
 }
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaSchema": {
-"description": "Defines the structure and layout of a type of document data.",
-"id": "GoogleCloudDiscoveryengineV1betaSchema",
+"GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": {
+"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec",
 "properties": {
-"jsonSchema": {
-"description": "The JSON representation of the schema.",
-"type": "string"
-},
-"name": {
-"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.",
+"queryId": {
+"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.",
 "type": "string"
 },
-"structSchema": {
-"additionalProperties": {
-"description": "Properties of the object.",
-"type": "any"
+"searchResultPersistenceCount": {
+"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.",
+"format": "int32",
+"type": "integer"
+}
 },
-"description": "The structured representation of the schema.",
 "type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": {
+"description": "The specification for query spell correction.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec",
+"properties": {
+"mode": {
+"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.",
+"enum": [
+"MODE_UNSPECIFIED",
+"SUGGESTION_ONLY",
+"AUTO"
+],
+"enumDescriptions": [
+"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.",
+"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.",
+"Automatic spell correction built by the Search API. Search will be based on the corrected query if found."
+],
+"type": "string"
 }
 },
 "type": "object"
@@ -16560,6 +18836,21 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaUserInfo": {
+"description": "Information of an end user.",
+"id": "GoogleCloudDiscoveryengineV1betaUserInfo",
+"properties": {
+"userAgent": {
+"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.",
+"type": "string"
+},
+"userId": {
+"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleLongrunningCancelOperationRequest": {
 "description": "The request message for Operations.CancelOperation.",
 "id": "GoogleLongrunningCancelOperationRequest",