google-api-python-client 2.161.0__py2.py3-none-any.whl → 2.162.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json

@@ -188,6 +188,90 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"obtainCrawlRate": {
+"description": "Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.obtainCrawlRate",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+location}:obtainCrawlRate",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"removeDedicatedCrawlRate": {
+"description": "Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:removeDedicatedCrawlRate",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.removeDedicatedCrawlRate",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+location}:removeDedicatedCrawlRate",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
+"setDedicatedCrawlRate": {
+"description": "Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:setDedicatedCrawlRate",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.setDedicatedCrawlRate",
+"parameterOrder": [
+"location"
+],
+"parameters": {
+"location": {
+"description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+location}:setDedicatedCrawlRate",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest"
+},
+"response": {
+"$ref": "GoogleLongrunningOperation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -2464,6 +2548,37 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"fetch": {
+"description": "Fetch Sitemaps in a DataStore.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch",
+"httpMethod": "GET",
+"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.fetch",
+"parameterOrder": [
+"parent"
+],
+"parameters": {
+"matcher.urisMatcher.uris": {
+"description": "The Sitemap uris.",
+"location": "query",
+"repeated": true,
+"type": "string"
+},
+"parent": {
+"description": "Required. Parent 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": "v1beta/{+parent}/sitemaps:fetch",
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1betaFetchSitemapsResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 }
 },
@@ -3186,6 +3301,34 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"removeSuggestion": {
+"description": "Removes the search history suggestion in an engine for a user. This will remove the suggestion from being returned in the AdvancedCompleteQueryResponse.recent_search_suggestions for this user. If the user searches the same suggestion again, the new history will override and suggest this suggestion again.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/completionConfig:removeSuggestion",
+"httpMethod": "POST",
+"id": "discoveryengine.projects.locations.collections.engines.completionConfig.removeSuggestion",
+"parameterOrder": [
+"completionConfig"
+],
+"parameters": {
+"completionConfig": {
+"description": "Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/completionConfig$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+completionConfig}:removeSuggestion",
+"request": {
+"$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest"
+},
+"response": {
+"$ref": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 }
 },
@@ -7607,7 +7750,7 @@
 }
 }
 },
-"revision": "20250130",
+"revision": "20250214",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -8038,11 +8181,11 @@
 "type": "boolean"
 },
 "kmsKey": {
-"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
+"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
 "type": "string"
 },
 "kmsKeyVersion": {
-"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
+"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
 "type": "string"
 },
 "lastRotationTimestampMicros": {
@@ -8052,7 +8195,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
 "type": "string"
 },
 "singleRegionKeys": {
@@ -8063,7 +8206,7 @@
 "type": "array"
 },
 "state": {
-"description": "Output only. State of the CmekConfig.",
+"description": "Output only. The states of the CmekConfig.",
 "enum": [
 "STATE_UNSPECIFIED",
 "CREATING",
@@ -8428,6 +8571,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1CreateSitemapMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.CreateSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1CreateSitemapMetadata",
+"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"
+},
 "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata",
@@ -8488,7 +8648,7 @@
 "type": "string"
 },
 "defaultSchemaId": {
-"description": "Output only. The id of the default Schema asscociated to this data store.",
+"description": "Output only. The id of the default Schema associated to this data store.",
 "readOnly": true,
 "type": "string"
 },
@@ -8504,6 +8664,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1HealthcareFhirConfig",
 "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
 },
+"identityMappingStore": {
+"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
+"type": "string"
+},
 "industryVertical": {
 "description": "Immutable. The industry vertical that the data store registers.",
 "enum": [
@@ -8701,6 +8865,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DeleteSitemapMetadata": {
+"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteSitemap operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1DeleteSitemapMetadata",
+"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"
+},
 "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata",
@@ -9068,7 +9249,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata": {
-"description": "IdentityMappingEntry LongRunningOperation metadata for [IdentityMappingStoreService.ImportIdentityMappings] and [IdentityMappingStoreService.PurgeIdentityMappings]",
+"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
 "id": "GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata",
 "properties": {
 "failureCount": {
@@ -9942,6 +10123,28 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1Sitemap": {
+"description": "A sitemap for the SiteSearchEngine.",
+"id": "GoogleCloudDiscoveryengineV1Sitemap",
+"properties": {
+"createTime": {
+"description": "Output only. The sitemap's creation time.",
+"format": "google-datetime",
+"readOnly": true,
+"type": "string"
+},
+"name": {
+"description": "Output only. The fully qualified resource name of the sitemap. `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/sitemaps/*` The `sitemap_id` suffix is system-generated.",
+"readOnly": true,
+"type": "string"
+},
+"uri": {
+"description": "Public URI for the sitemap, e.g. `www.example.com/sitemap.xml`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1TargetSite": {
 "description": "A target site for the SiteSearchEngine.",
 "id": "GoogleCloudDiscoveryengineV1TargetSite",
@@ -10373,7 +10576,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation",
 "properties": {
 "endIndex": {
-"description": "End of the attributed segment, exclusive.",
+"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
 "format": "int64",
 "type": "string"
 },
@@ -10385,7 +10588,7 @@
 "type": "array"
 },
 "startIndex": {
-"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
+"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
 "format": "int64",
 "type": "string"
 }
@@ -10568,6 +10771,16 @@
 },
 "description": "Structured search data.",
 "type": "object"
+},
+"title": {
+"description": "Output only. The title of the document.",
+"readOnly": true,
+"type": "string"
+},
+"uri": {
+"description": "Output only. The URI of the document.",
+"readOnly": true,
+"type": "string"
 }
 },
 "type": "object"
@@ -10820,11 +11033,11 @@
 "type": "boolean"
 },
 "kmsKey": {
-"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
+"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
 "type": "string"
 },
 "kmsKeyVersion": {
-"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
+"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
 "type": "string"
 },
 "lastRotationTimestampMicros": {
@@ -10834,7 +11047,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
 "type": "string"
 },
 "singleRegionKeys": {
@@ -10845,7 +11058,7 @@
 "type": "array"
 },
 "state": {
-"description": "Output only. State of the CmekConfig.",
+"description": "Output only. The states of the CmekConfig.",
 "enum": [
 "STATE_UNSPECIFIED",
 "CREATING",
@@ -11053,6 +11266,11 @@
 "description": "Represents an entity that was synced in this ConnectorRun.",
 "id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRun",
 "properties": {
+"deletedRecordCount": {
+"description": "The number of documents deleted.",
+"format": "int64",
+"type": "string"
+},
 "entityName": {
 "description": "The name of the source entity.",
 "type": "string"
@@ -11631,10 +11849,12 @@
 "syncMode": {
 "description": "The data synchronization mode supported by the data connector.",
 "enum": [
-"PERIODIC"
+"PERIODIC",
+"STREAMING"
 ],
 "enumDescriptions": [
-"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync."
+"The connector will sync data periodically based on the refresh_interval. Use it with auto_run_disabled to pause the periodic sync, or indicate a one-time sync.",
+"The data will be synced in real time."
 ],
 "type": "string"
 },
@@ -11660,6 +11880,10 @@
 "description": "The name of the entity. Supported values by data source: * Salesforce: `Lead`, `Opportunity`, `Contact`, `Account`, `Case`, `Contract`, `Campaign` * Jira: `Issue` * Confluence: `Content`, `Space`",
 "type": "string"
 },
+"healthcareFhirConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
+"description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
+},
 "keyPropertyMappings": {
 "additionalProperties": {
 "type": "string"
@@ -11674,6 +11898,10 @@
 },
 "description": "The parameters for the entity to facilitate data ingestion. E.g. for BigQuery connectors: * Key: `document_id_column` * Value: type STRING. The value of the column ID.",
 "type": "object"
+},
+"startingSchema": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSchema",
+"description": "Optional. The start schema to use for the DataStore created from this SourceEntity. If unset, a default vertical specialized schema will be used. This field is only used by SetUpDataConnector API, and will be ignored if used in other APIs. This field will be omitted from all API responses including GetDataConnector API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)."
 }
 },
 "type": "object"
@@ -11725,7 +11953,7 @@
 "type": "string"
 },
 "defaultSchemaId": {
-"description": "Output only. The id of the default Schema asscociated to this data store.",
+"description": "Output only. The id of the default Schema associated to this data store.",
 "readOnly": true,
 "type": "string"
 },
@@ -11741,6 +11969,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig",
 "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
 },
+"identityMappingStore": {
+"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
+"type": "string"
+},
 "idpConfig": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig",
 "description": "Output only. Data store level identity provider config.",
@@ -12641,31 +12873,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse": {
-"description": "Response message for SiteSearchEngineService.FetchSitemaps method.",
-"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponse",
-"properties": {
-"sitemapsMetadata": {
-"description": "List of Sitemaps fetched.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata": {
-"description": "Contains a Sitemap and its metadata.",
-"id": "GoogleCloudDiscoveryengineV1alphaFetchSitemapsResponseSitemapMetadata",
-"properties": {
-"sitemap": {
-"$ref": "GoogleCloudDiscoveryengineV1alphaSitemap",
-"description": "The Sitemap."
-}
-},
-"type": "object"
-},
 "GoogleCloudDiscoveryengineV1alphaFieldConfig": {
 "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.",
 "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig",
@@ -12872,7 +13079,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata": {
-"description": "IdentityMappingEntry LongRunningOperation metadata for [IdentityMappingStoreService.ImportIdentityMappings] and [IdentityMappingStoreService.PurgeIdentityMappings]",
+"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
 "id": "GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata",
 "properties": {
 "failureCount": {
@@ -14041,6 +14248,10 @@
 },
 "type": "array"
 },
+"displaySpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
+"description": "Optional. Config for display feature, like match highlighting on search results."
+},
 "embeddingSpec": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
 "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."
@@ -14111,7 +14322,21 @@
 "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)`.",
+"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",
+"type": "string"
+},
+"rankingExpressionBackend": {
+"description": "Optional. The backend to use for the ranking expression evaluation.",
+"enum": [
+"UNKNOWN",
+"BYOE",
+"CLEARBOX"
+],
+"enumDescriptions": [
+"Default option for unspecified/unknown values.",
+"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
+"The expression is compiled into a Clearbox formula."
+],
 "type": "string"
 },
 "regionCode": {
@@ -14468,6 +14693,27 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec": {
+"description": "Specifies features for display, like match highlighting.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDisplaySpec",
+"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 DISABLED.",
+"Disables match highlighting on all documents.",
+"Enables match highlighting on all documents."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": {
 "description": "The specification that uses customized query embedding vector to do semantic document retrieval.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec",
@@ -14669,12 +14915,14 @@
 "enum": [
 "CONDITION_UNSPECIFIED",
 "DISABLED",
-"ENABLED"
+"ENABLED",
+"AUTO"
 ],
 "enumDescriptions": [
 "Server behavior defaults to Condition.DISABLED.",
 "Disables Search As You Type.",
-"Enables Search As You Type."
+"Enables Search As You Type.",
+"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
 ],
 "type": "string"
 }
@@ -14690,7 +14938,7 @@
 "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.",
+"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 similar 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"
 }
@@ -15256,7 +15504,7 @@
 "type": "string"
 },
 "queryModel": {
-"description": "Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.",
+"description": "Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.",
 "type": "string"
 },
 "suggestionTypeSpecs": {
@@ -15686,7 +15934,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaAnswerCitation",
 "properties": {
 "endIndex": {
-"description": "End of the attributed segment, exclusive.",
+"description": "End of the attributed segment, exclusive. Measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
 "format": "int64",
 "type": "string"
 },
@@ -15698,7 +15946,7 @@
 "type": "array"
 },
 "startIndex": {
-"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).",
+"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode). If there are multi-byte characters,such as non-ASCII characters, the index measurement is longer than the string length.",
 "format": "int64",
 "type": "string"
 }
@@ -16469,6 +16717,16 @@
 },
 "description": "Structured search data.",
 "type": "object"
+},
+"title": {
+"description": "Output only. The title of the document.",
+"readOnly": true,
+"type": "string"
+},
+"uri": {
+"description": "Output only. The URI of the document.",
+"readOnly": true,
+"type": "string"
 }
 },
 "type": "object"
@@ -17245,11 +17503,11 @@
 "type": "boolean"
 },
 "kmsKey": {
-"description": "Kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
+"description": "KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.",
 "type": "string"
 },
 "kmsKeyVersion": {
-"description": "Kms key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
+"description": "KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`.",
 "type": "string"
 },
 "lastRotationTimestampMicros": {
@@ -17259,7 +17517,7 @@
 "type": "string"
 },
 "name": {
-"description": "Required. Name of the CmekConfig, of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
+"description": "Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmekConfig}`.",
 "type": "string"
 },
 "singleRegionKeys": {
@@ -17270,7 +17528,7 @@
 "type": "array"
 },
 "state": {
-"description": "Output only. State of the CmekConfig.",
+"description": "Output only. The states of the CmekConfig.",
 "enum": [
 "STATE_UNSPECIFIED",
 "CREATING",
@@ -17835,6 +18093,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries": {
+"description": "The historical crawl rate timeseries data, used for monitoring.",
+"id": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
+"properties": {
+"qpsTimeSeries": {
+"$ref": "GoogleMonitoringV3TimeSeries",
+"description": "The QPS of the crawl rate."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": {
 "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata",
@@ -18073,7 +18342,7 @@
 "type": "string"
 },
 "defaultSchemaId": {
-"description": "Output only. The id of the default Schema asscociated to this data store.",
+"description": "Output only. The id of the default Schema associated to this data store.",
 "readOnly": true,
 "type": "string"
 },
@@ -18089,6 +18358,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig",
 "description": "Optional. Configuration for `HEALTHCARE_FHIR` vertical."
 },
+"identityMappingStore": {
+"description": "Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`.",
+"type": "string"
+},
 "industryVertical": {
 "description": "Immutable. The industry vertical that the data store registers.",
 "enum": [
@@ -18209,6 +18482,21 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries": {
+"description": "The historical dedicated crawl rate timeseries data, used for monitoring. Dedicated crawl is used by Vertex AI to crawl the user's website when dedicate crawl is set.",
+"id": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
+"properties": {
+"autoRefreshCrawlRate": {
+"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
+"description": "Vertex AI's dedicated crawl rate time series of auto-refresh, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and the crawl rate is for best effort use cases like refreshing urls periodically."
+},
+"userTriggeredCrawlRate": {
+"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
+"description": "Vertex AI's dedicated crawl rate time series of user triggered crawl, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is set, and user triggered crawl rate is for deterministic use cases like crawling urls or sitemaps specified by users."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": {
 "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata",
@@ -19529,7 +19817,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata": {
-"description": "IdentityMappingEntry LongRunningOperation metadata for [IdentityMappingStoreService.ImportIdentityMappings] and [IdentityMappingStoreService.PurgeIdentityMappings]",
+"description": "IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings",
 "id": "GoogleCloudDiscoveryengineV1betaIdentityMappingEntryOperationMetadata",
 "properties": {
 "failureCount": {
@@ -20490,6 +20778,66 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest": {
+"description": "Request message for CrawlRateManagementService.ObtainCrawlRate method.",
+"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest",
+"properties": {
+"crawlRateScope": {
+"description": "Required. The scope of the crawl rate that the user wants to monitor. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse": {
+"description": "Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.",
+"id": "GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse",
+"properties": {
+"dedicatedCrawlRateTimeSeries": {
+"$ref": "GoogleCloudDiscoveryengineV1betaDedicatedCrawlRateTimeSeries",
+"description": "The historical dedicated crawl rate timeseries data, used for monitoring."
+},
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Errors from service when handling the request."
+},
+"organicCrawlRateTimeSeries": {
+"$ref": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
+"description": "The historical organic crawl rate timeseries data, used for monitoring."
+},
+"state": {
+"description": "Output only. The state of the response.",
+"enum": [
+"STATE_UNSPECIFIED",
+"SUCCEEDED",
+"FAILED"
+],
+"enumDescriptions": [
+"The state is unspecified.",
+"The state is successful.",
+"The state is failed."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries": {
+"description": "The historical organic crawl rate timeseries data, used for monitoring. Organic crawl is auto-determined by Google to crawl the user's website when dedicate crawl is not set. Crawl rate is the QPS of crawl request Google sends to the user's website.",
+"id": "GoogleCloudDiscoveryengineV1betaOrganicCrawlRateTimeSeries",
+"properties": {
+"googleOrganicCrawlRate": {
+"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
+"description": "Google's organic crawl rate time series, which is the sum of all googlebots' crawl rate. Please refer to https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers for more details about googlebots."
+},
+"vertexAiOrganicCrawlRate": {
+"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
+"description": "Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot."
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaPageInfo": {
 "description": "Detailed page information.",
 "id": "GoogleCloudDiscoveryengineV1betaPageInfo",
@@ -21083,7 +21431,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest",
 "properties": {
 "siteCredential": {
-"description": "Optional. Full resource name of the `SiteCredential`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.",
+"description": "Optional. Credential id to use for crawling.",
 "type": "string"
 },
 "uris": {
@@ -21096,6 +21444,94 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata": {
+"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateMetadata",
+"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"
+},
+"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest": {
+"description": "Request message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. The user can remove the dedicated crawl rate for a crawl_rate_scope they own, and Google will fall back to organic crawl, and the crawl rate will be determined by Google.",
+"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateRequest",
+"properties": {
+"crawlRateScope": {
+"description": "Required. The scope of the crawl rate change. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse": {
+"description": "Response message for CrawlRateManagementService.RemoveDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
+"id": "GoogleCloudDiscoveryengineV1betaRemoveDedicatedCrawlRateResponse",
+"properties": {
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Errors from service when handling the request."
+},
+"state": {
+"description": "Output only. The state of the response.",
+"enum": [
+"STATE_UNSPECIFIED",
+"SUCCEEDED",
+"FAILED"
+],
+"enumDescriptions": [
+"The state is unspecified.",
+"The state is successful.",
+"The state is failed."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest": {
+"description": "Request message for CompletionService.RemoveSuggestion method.",
+"id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionRequest",
+"properties": {
+"removeAllSearchHistorySuggestions": {
+"description": "Remove all search history suggestions for the user.",
+"type": "boolean"
+},
+"removeTime": {
+"description": "Optional. Time at which the suggestion was removed. If not set, the current time will be used.",
+"format": "google-datetime",
+"type": "string"
+},
+"searchHistorySuggestion": {
+"description": "The search history suggestion to be removed.",
+"type": "string"
+},
+"userInfo": {
+"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo",
+"description": "Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info."
+},
+"userPseudoId": {
+"description": "Required. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse": {
+"description": "Response message for CompletionService.RemoveSuggestion method.",
+"id": "GoogleCloudDiscoveryengineV1betaRemoveSuggestionResponse",
+"properties": {},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaReply": {
 "description": "Defines a reply message to user.",
 "id": "GoogleCloudDiscoveryengineV1betaReply",
@@ -21490,7 +21926,21 @@
 "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)`.",
+"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",
+"type": "string"
+},
+"rankingExpressionBackend": {
+"description": "Optional. The backend to use for the ranking expression evaluation.",
+"enum": [
+"UNKNOWN",
+"BYOE",
+"CLEARBOX"
+],
+"enumDescriptions": [
+"Default option for unspecified/unknown values.",
+"Bring your own embedding (BYOE), the default way to evaluate the ranking expression.",
+"The expression is compiled into a Clearbox formula."
+],
 "type": "string"
 },
 "regionCode": {
@@ -22048,12 +22498,14 @@
 "enum": [
 "CONDITION_UNSPECIFIED",
 "DISABLED",
-"ENABLED"
+"ENABLED",
+"AUTO"
 ],
 "enumDescriptions": [
 "Server behavior defaults to Condition.DISABLED.",
 "Disables Search As You Type.",
-"Enables Search As You Type."
+"Enables Search As You Type.",
+"Automatic switching between search-as-you-type and standard search modes, ideal for single-API implementations (e.g., debouncing)."
 ],
 "type": "string"
 }
@@ -22069,7 +22521,7 @@
 "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.",
+"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 similar 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"
 }
@@ -23001,6 +23453,93 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata": {
+"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateMetadata",
+"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"
+},
+"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest": {
+"description": "Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.",
+"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest",
+"properties": {
+"crawlRate": {
+"description": "Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.",
+"format": "int32",
+"type": "integer"
+},
+"crawlRateScope": {
+"description": "Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: `example.com`. A host name example: `www.example.com`. Please do not include `/` in the domain or host name.",
+"type": "string"
+},
+"crawlType": {
+"description": "Optional. Whether it's the crawl rate of user-triggered or auto-refresh.",
+"enum": [
+"CRAWL_TYPE_UNSPECIFIED",
+"USER_TRIGGERED",
+"AUTO_REFRESH"
+],
+"enumDescriptions": [
+"The crawl type is unspecified.",
+"The crawl type is user-triggered.",
+"The crawl type is auto-refresh."
+],
+"type": "string"
+},
+"mode": {
+"description": "Optional. Whether the rate is explicitly set by users, or set by vertex AI.",
+"enum": [
+"MODE_UNSPECIFIED",
+"AUTOMATIC",
+"EXPLICIT"
+],
+"enumDescriptions": [
+"The mode is unspecified. If the user does not specify the mode, default to AUTOMATIC.",
+"Vertex AI automatically splits crawl_rate into user-triggered and auto-refresh. Users don't need to specify SetDedicatedCrawlRateRequest.CrawlType if the mode is AUTOMATIC.",
+"Users explicitly set user-triggered or auto-refresh crawl rate."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse": {
+"description": "Response message for CrawlRateManagementService.SetDedicatedCrawlRate method. It simply returns the state of the response, and an error message if the state is FAILED.",
+"id": "GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateResponse",
+"properties": {
+"error": {
+"$ref": "GoogleRpcStatus",
+"description": "Errors from service when handling the request."
+},
+"state": {
+"description": "Output only. The state of the response.",
+"enum": [
+"STATE_UNSPECIFIED",
+"SUCCEEDED",
+"FAILED"
+],
+"enumDescriptions": [
+"The state is unspecified.",
+"The state is successful.",
+"The state is failed."
+],
+"readOnly": true,
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSingleRegionKey": {
 "description": "Metadata for single-regional CMEKs.",
 "id": "GoogleCloudDiscoveryengineV1betaSingleRegionKey",