google-api-python-client 2.164.0__py2.py3-none-any.whl → 2.166.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1.json

@@ -160,7 +160,179 @@
 },
 "resources": {
 "locations": {
+"methods": {
+"getCmekConfig": {
+"description": "Gets the CmekConfig.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.getCmekConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1CmekConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"updateCmekConfig": {
+"description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfig",
+"httpMethod": "PATCH",
+"id": "discoveryengine.projects.locations.updateCmekConfig",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$",
+"required": true,
+"type": "string"
+},
+"setDefault": {
+"description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1CmekConfig"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+},
 "resources": {
+"cmekConfigs": {
+"methods": {
+"delete": {
+"description": "De-provisions a CmekConfig.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
+"httpMethod": "DELETE",
+"id": "discoveryengine.projects.locations.cmekConfigs.delete",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the CmekConfig to delete, such as `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"get": {
+"description": "Gets the CmekConfig.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.cmekConfigs.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Resource name of CmekConfig, such as `projects/*/locations/*/cmekConfig` or `projects/*/locations/*/cmekConfigs/*`. If the caller does not have permission to access the CmekConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1CmekConfig"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"list": {
+"description": "Lists all the CmekConfigs with the project.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.cmekConfigs.list",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"parent": {
+"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list CmekConfigs under this location, regardless of whether or not a CmekConfig exists, a PERMISSION_DENIED error is returned.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+parent}/cmekConfigs",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"patch": {
+"description": "Provisions a CMEK key for use in a location of a customer's project. This method will also conduct location validation on the provided cmekConfig to make sure the key is valid and can be used in the selected location.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cmekConfigs/{cmekConfigsId}",
+"httpMethod": "PATCH",
+"id": "discoveryengine.projects.locations.cmekConfigs.patch",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/cmekConfigs/[^/]+$",
+"required": true,
+"type": "string"
+},
+"setDefault": {
+"description": "Set the following CmekConfig as the default to be used for child resources if one is not specified.",
+"location": "query",
+"type": "boolean"
+}
+},
+"path": "v1/{+name}",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1CmekConfig"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+},
 "collections": {
 "resources": {
 "dataConnector": {
@@ -6499,6 +6671,39 @@
 }
 }
 },
+"podcasts": {
+"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": "v1/projects/{projectsId}/locations/{locationsId}/podcasts/{podcastsId}/operations/{operationsId}",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.podcasts.operations.get",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "The name of the operation resource.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/podcasts/[^/]+/operations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}",
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+}
+}
+}
+}
+},
 "rankingConfigs": {
 "methods": {
 "rank": {
@@ -6740,7 +6945,7 @@
 }
 }
 },
-"revision": "20250306",
+"revision": "20250320",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -7597,6 +7802,10 @@
 "description": "Query understanding specification.",
 "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec",
 "properties": {
+"disableSpellCorrection": {
+"description": "Optional. Whether to disable spell correction. The default value is `false`.",
+"type": "boolean"
+},
 "queryClassificationSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec",
 "description": "Query classification specification."
@@ -8916,6 +9125,23 @@
 "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
 "type": "string"
 },
+"notebooklmState": {
+"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
+"enum": [
+"NOTEBOOK_LM_STATE_UNSPECIFIED",
+"NOTEBOOK_LM_NOT_READY",
+"NOTEBOOK_LM_READY",
+"NOTEBOOK_LM_NOT_ENABLED"
+],
+"enumDescriptions": [
+"The NotebookLM state is unknown.",
+"The NotebookLM is not ready.",
+"The NotebookLM is ready to be used.",
+"The NotebookLM is not enabled."
+],
+"readOnly": true,
+"type": "string"
+},
 "singleRegionKeys": {
 "description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
 "items": {
@@ -9675,6 +9901,10 @@
 "description": "DataStore captures global settings and configs at the DataStore level.",
 "id": "GoogleCloudDiscoveryengineV1DataStore",
 "properties": {
+"aclEnabled": {
+"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
+"type": "boolean"
+},
 "advancedSiteSearchConfig": {
 "$ref": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig",
 "description": "Optional. Configuration for advanced site search."
@@ -11172,6 +11402,20 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1ListCmekConfigsResponse": {
+"description": "Response message for CmekConfigService.ListCmekConfigs method.",
+"id": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse",
+"properties": {
+"cmekConfigs": {
+"description": "All the customer's CmekConfigs.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1CmekConfig"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1ListControlsResponse": {
 "description": "Response for ListControls method.",
 "id": "GoogleCloudDiscoveryengineV1ListControlsResponse",
@@ -12127,7 +12371,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -12154,12 +12398,16 @@
 "description": "A specification for configuring the behavior of content search."
 },
 "dataStoreSpecs": {
-"description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
+"description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec"
 },
 "type": "array"
 },
+"displaySpec": {
+"$ref": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec",
+"description": "Optional. Config for display feature, like match highlighting on search results."
+},
 "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": {
@@ -12282,7 +12530,7 @@
 "id": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpec",
 "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.",
+"description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec"
 },
@@ -12567,6 +12815,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec": {
+"description": "Specifies features for display, like match highlighting.",
+"id": "GoogleCloudDiscoveryengineV1SearchRequestDisplaySpec",
+"properties": {
+"matchHighlightingCondition": {
+"description": "The condition under which match highlighting should occur.",
+"enum": [
+"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
+"MATCH_HIGHLIGHTING_DISABLED",
+"MATCH_HIGHLIGHTING_ENABLED"
+],
+"enumDescriptions": [
+"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
+"Disables match highlighting on all documents.",
+"Enables match highlighting on all documents."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec": {
 "description": "A facet specification to perform faceted search.",
 "id": "GoogleCloudDiscoveryengineV1SearchRequestFacetSpec",
@@ -13966,6 +14235,10 @@
 "description": "Output only. The connector contains the necessary parameters and is configured to support actions.",
 "readOnly": true,
 "type": "boolean"
+},
+"serviceName": {
+"description": "Optional. The Service Directory resource name (projects/*/locations/*/namespaces/*/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.",
+"type": "string"
 }
 },
 "type": "object"
@@ -13985,6 +14258,49 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig": {
+"description": "The connector level alert config.",
+"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig",
+"properties": {
+"alertEnrollments": {
+"description": "Optional. The enrollment states of each alert.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment"
+},
+"type": "array"
+},
+"alertPolicyName": {
+"description": "Immutable. The fully qualified resource name of the AlertPolicy.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment": {
+"description": "The alert enrollment status.",
+"id": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfigAlertEnrollment",
+"properties": {
+"alertId": {
+"description": "Immutable. The id of an alert.",
+"type": "string"
+},
+"enrollState": {
+"description": "Required. The enrollment status of a customer.",
+"enum": [
+"ENROLL_STATES_UNSPECIFIED",
+"ENROLLED",
+"DECLINED"
+],
+"enumDescriptions": [
+"Default value. Used for customers who have not responded to the alert policy.",
+"Customer is enrolled in this policy.",
+"Customer declined this policy."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaAnswer": {
 "description": "Defines an answer.",
 "id": "GoogleCloudDiscoveryengineV1alphaAnswer",
@@ -14024,6 +14340,13 @@
 "description": "The textual answer.",
 "type": "string"
 },
+"blobAttachments": {
+"description": "List of blob attachments in the answer.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment"
+},
+"type": "array"
+},
 "citations": {
 "description": "Citations.",
 "items": {
@@ -14112,6 +14435,51 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment": {
+"description": "Stores binarydata attached to text answer, e.g. image, video, audio, etc.",
+"id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachment",
+"properties": {
+"attributionType": {
+"description": "Output only. The attribution type of the blob.",
+"enum": [
+"ATTRIBUTION_TYPE_UNSPECIFIED",
+"CORPUS",
+"GENERATED"
+],
+"enumDescriptions": [
+"Unspecified attribution type.",
+"The attachment data is from the corpus.",
+"The attachment data is generated by the model through code generation."
+],
+"readOnly": true,
+"type": "string"
+},
+"data": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob",
+"description": "Output only. The mime type and data of the blob.",
+"readOnly": true
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob": {
+"description": "The media type and data of the blob.",
+"id": "GoogleCloudDiscoveryengineV1alphaAnswerBlobAttachmentBlob",
+"properties": {
+"data": {
+"description": "Output only. Raw bytes.",
+"format": "byte",
+"readOnly": true,
+"type": "string"
+},
+"mimeType": {
+"description": "Output only. The media type (MIME type) of the generated or retrieved data.",
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaAnswerCitation": {
 "description": "Citation info for a segment.",
 "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
@@ -14246,6 +14614,15 @@
 "description": "Chunk information.",
 "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo",
 "properties": {
+"blobAttachmentIndexes": {
+"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
+"items": {
+"format": "int64",
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
 "chunk": {
 "description": "Chunk resource name.",
 "type": "string"
@@ -14364,6 +14741,15 @@
 "description": "Chunk content.",
 "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent",
 "properties": {
+"blobAttachmentIndexes": {
+"description": "Output only. Stores indexes of blobattachments linked to this chunk.",
+"items": {
+"format": "int64",
+"type": "string"
+},
+"readOnly": true,
+"type": "array"
+},
 "content": {
 "description": "Chunk textual content.",
 "type": "string"
@@ -14615,6 +15001,23 @@
 "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
 "type": "string"
 },
+"notebooklmState": {
+"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
+"enum": [
+"NOTEBOOK_LM_STATE_UNSPECIFIED",
+"NOTEBOOK_LM_NOT_READY",
+"NOTEBOOK_LM_READY",
+"NOTEBOOK_LM_NOT_ENABLED"
+],
+"enumDescriptions": [
+"The NotebookLM state is unknown.",
+"The NotebookLM is not ready.",
+"The NotebookLM is ready to be used.",
+"The NotebookLM is not enabled."
+],
+"readOnly": true,
+"type": "string"
+},
 "singleRegionKeys": {
 "description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
 "items": {
@@ -14785,7 +15188,8 @@
 "OVERRUN",
 "CANCELLED",
 "PENDING",
-"WARNING"
+"WARNING",
+"SKIPPED"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -14795,7 +15199,8 @@
 "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
 "Data sync was scheduled but has been cancelled.",
 "Data sync is about to start.",
-"The data sync completed with non-fatal errors."
+"The data sync completed with non-fatal errors.",
+"An ongoing connector run has been running longer than expected, causing this run to be skipped."
 ],
 "readOnly": true,
 "type": "string"
@@ -14881,7 +15286,8 @@
 "OVERRUN",
 "CANCELLED",
 "PENDING",
-"WARNING"
+"WARNING",
+"SKIPPED"
 ],
 "enumDescriptions": [
 "Default value.",
@@ -14891,7 +15297,8 @@
 "Data sync has been running longer than expected and is still running at the time the next run is supposed to start.",
 "Data sync was scheduled but has been cancelled.",
 "Data sync is about to start.",
-"The data sync completed with non-fatal errors."
+"The data sync completed with non-fatal errors.",
+"An ongoing connector run has been running longer than expected, causing this run to be skipped."
 ],
 "type": "string"
 },
@@ -15297,6 +15704,13 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaActionConfig",
 "description": "Optional. Action configurations to make the connector support actions."
 },
+"alertPolicyConfigs": {
+"description": "Optional. The connector level alert config.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig"
+},
+"type": "array"
+},
 "autoRunDisabled": {
 "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
 "type": "boolean"
@@ -17874,7 +18288,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -17905,7 +18319,7 @@
 "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
 },
 "dataStoreSpecs": {
-"description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
+"description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
 },
@@ -17985,13 +18399,13 @@
 "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 syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
+"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
 "type": "string"
 },
 "rankingExpressionBackend": {
 "description": "Optional. The backend to use for the ranking expression evaluation.",
 "enum": [
-"UNKNOWN",
+"RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
 "BYOE",
 "CLEARBOX"
 ],
@@ -18075,7 +18489,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec",
 "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.",
+"description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec"
 },
@@ -18307,6 +18721,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec",
 "description": "If specified, the spec will be used to modify the model specification provided to the LLM."
 },
+"multimodalSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
+"description": "Optional. Multimodal specification."
+},
 "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",
@@ -18341,6 +18759,29 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": {
+"description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
+"properties": {
+"imageSource": {
+"description": "Optional. Source of image returned in the answer.",
+"enum": [
+"IMAGE_SOURCE_UNSPECIFIED",
+"ALL_AVAILABLE_SOURCES",
+"CORPUS_IMAGE_ONLY",
+"FIGURE_GENERATION_ONLY"
+],
+"enumDescriptions": [
+"Unspecified image source (multimodal feature is disabled by default).",
+"Behavior when service determines the pick from all available sources.",
+"Includes image from corpus in the answer.",
+"Triggers figure generation in the answer."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": {
 "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",
@@ -19238,6 +19679,23 @@
 "description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
 "type": "string"
 },
+"notebooklmState": {
+"description": "Output only. Whether the NotebookLM Corpus is ready to be used.",
+"enum": [
+"NOTEBOOK_LM_STATE_UNSPECIFIED",
+"NOTEBOOK_LM_NOT_READY",
+"NOTEBOOK_LM_READY",
+"NOTEBOOK_LM_NOT_ENABLED"
+],
+"enumDescriptions": [
+"The NotebookLM state is unknown.",
+"The NotebookLM is not ready.",
+"The NotebookLM is ready to be used.",
+"The NotebookLM is not enabled."
+],
+"readOnly": true,
+"type": "string"
+},
 "singleRegionKeys": {
 "description": "Optional. Single-regional CMEKs that are required for some VAIS features.",
 "items": {
@@ -19666,6 +20124,10 @@
 "description": "DataStore captures global settings and configs at the DataStore level.",
 "id": "GoogleCloudDiscoveryengineV1betaDataStore",
 "properties": {
+"aclEnabled": {
+"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.",
+"type": "boolean"
+},
 "advancedSiteSearchConfig": {
 "$ref": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig",
 "description": "Optional. Configuration for advanced site search."
@@ -21131,7 +21593,7 @@
 "type": "string"
 },
 "uri": {
-"description": "Required. The URL for the page the user wants to promote.",
+"description": "Optional. The URL for the page the user wants to promote. Must be set for site search. For other verticals, this is optional.",
 "type": "string"
 }
 },
@@ -21158,12 +21620,16 @@
 "description": "A specification for configuring the behavior of content search."
 },
 "dataStoreSpecs": {
-"description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
+"description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
 },
 "type": "array"
 },
+"displaySpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
+"description": "Optional. Config for display feature, like match highlighting on search results."
+},
 "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."
@@ -21234,13 +21700,13 @@
 "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 syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking expression is not provided or set to BYOE, it should be 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)`. === CLEARBOX === If ranking expression is set to CLEARBOX, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
+"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The syntax and supported features depend on the ranking_expression_backend value. If ranking_expression_backend is not provided, it defaults to BYOE. === BYOE === If ranking_expression_backend is not provided or set to `BYOE`, it should be 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)`. === CLEARBOX === If ranking_expression_backend is set to `CLEARBOX`, the following expression types (and combinations of those chained using + or * operators) are supported: * double * signal * log(signal) * exp(signal) * rr(signal, double > 0) -- reciprocal rank transformation with second argument being a denominator constant. * is_nan(signal) -- returns 0 if signal is NaN, 1 otherwise. * fill_nan(signal1, signal2 | double) -- if signal1 is NaN, returns signal2 | double, else returns signal1. Examples: * 0.2 * gecko_score + 0.8 * log(bm25_score) * 0.2 * exp(fill_nan(gecko_score, 0)) + 0.3 * is_nan(bm25_score) * 0.2 * rr(gecko_score, 16) + 0.8 * rr(bm25_score, 32) The following signals are supported: * gecko_score -- semantic similarity adjustment * bm25_score -- keyword match adjustment * jetstream_score -- semantic relevance adjustment * pctr_rank -- predicted conversion rate adjustment as a rank * freshness_rank -- freshness adjustment as a rank * base_rank -- the default rank of the result",
 "type": "string"
 },
 "rankingExpressionBackend": {
 "description": "Optional. The backend to use for the ranking expression evaluation.",
 "enum": [
-"UNKNOWN",
+"RANKING_EXPRESSION_BACKEND_UNSPECIFIED",
 "BYOE",
 "CLEARBOX"
 ],
@@ -21324,7 +21790,7 @@
 "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.",
+"description": "Condition boost specifications. If a document matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec"
 },
@@ -21556,6 +22022,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec",
 "description": "If specified, the spec will be used to modify the model specification provided to the LLM."
 },
+"multimodalSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
+"description": "Optional. Multimodal specification."
+},
 "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",
@@ -21590,6 +22060,29 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec": {
+"description": "Multimodal specification: Will return an image from specified source. If multiple sources are specified, the pick is a quality based decision.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecMultiModalSpec",
+"properties": {
+"imageSource": {
+"description": "Optional. Source of image returned in the answer.",
+"enum": [
+"IMAGE_SOURCE_UNSPECIFIED",
+"ALL_AVAILABLE_SOURCES",
+"CORPUS_IMAGE_ONLY",
+"FIGURE_GENERATION_ONLY"
+],
+"enumDescriptions": [
+"Unspecified image source (multimodal feature is disabled by default).",
+"Behavior when service determines the pick from all available sources.",
+"Includes image from corpus in the answer.",
+"Triggers figure generation in the answer."
+],
+"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",
@@ -21609,6 +22102,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec": {
+"description": "Specifies features for display, like match highlighting.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDisplaySpec",
+"properties": {
+"matchHighlightingCondition": {
+"description": "The condition under which match highlighting should occur.",
+"enum": [
+"MATCH_HIGHLIGHTING_CONDITION_UNSPECIFIED",
+"MATCH_HIGHLIGHTING_DISABLED",
+"MATCH_HIGHLIGHTING_ENABLED"
+],
+"enumDescriptions": [
+"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
+"Disables match highlighting on all documents.",
+"Enables match highlighting on all documents."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": {
 "description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec",