google-api-python-client 2.158.0__py2.py3-none-any.whl → 2.160.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json

@@ -600,7 +600,7 @@
 ],
 "parameters": {
 "documentId": {
-"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "location": "query",
 "type": "string"
 },
@@ -4427,7 +4427,7 @@
 ],
 "parameters": {
 "documentId": {
-"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
+"description": "Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.",
 "location": "query",
 "type": "string"
 },
@@ -6563,14 +6563,14 @@
 ],
 "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.",
+"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list ListEvaluationResultsResponse.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.",
+"description": "Maximum number of ListEvaluationResultsResponse.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"
@@ -7384,7 +7384,7 @@
 }
 }
 },
-"revision": "20241216",
+"revision": "20250114",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -7762,7 +7762,16 @@
 "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig": {
 "description": "Configuration data for advance site search.",
 "id": "GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig",
-"properties": {},
+"properties": {
+"disableAutomaticRefresh": {
+"description": "If set true, automatic refresh is disabled for the DataStore.",
+"type": "boolean"
+},
+"disableInitialIndex": {
+"description": "If set true, initial indexing is disabled for the DataStore.",
+"type": "boolean"
+}
+},
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": {
@@ -8003,7 +8012,8 @@
 "id": "GoogleCloudDiscoveryengineV1ControlBoostAction",
 "properties": {
 "boost": {
-"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
+"deprecated": true,
+"description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
 "format": "float",
 "type": "number"
 },
@@ -8014,6 +8024,11 @@
 "filter": {
 "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
 "type": "string"
+},
+"fixedBoost": {
+"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
+"format": "float",
+"type": "number"
 }
 },
 "type": "object"
@@ -8342,6 +8357,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata": {
+"description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1DeleteIdentityMappingStoreMetadata",
+"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"
+},
 "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": {
 "description": "Metadata for DeleteSchema LRO.",
 "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata",
@@ -9417,7 +9449,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": {
@@ -9554,7 +9586,7 @@
 "id": "GoogleCloudDiscoveryengineV1TargetSite",
 "properties": {
 "exactMatch": {
-"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
+"description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
 "type": "boolean"
 },
 "failureReason": {
@@ -9820,7 +9852,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client id for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
+"description": "Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.",
 "type": "object"
 },
 "isActionConfigured": {
@@ -9938,6 +9970,13 @@
 },
 "type": "array"
 },
+"safetyRatings": {
+"description": "Optional. Safety ratings.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSafetyRating"
+},
+"type": "array"
+},
 "state": {
 "description": "The state of the answer generation.",
 "enum": [
@@ -10480,7 +10519,7 @@
 },
 "dataConnector": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaDataConnector",
-"description": "Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnector.GetDataConnector method.",
+"description": "Output only. The data connector, if present, manages the connection for data stores in the Collection. To set up the connector, use DataConnectorService.SetUpDataConnector method, which creates a new Collection while setting up the DataConnector singleton resource. Setting up connector on an existing Collection is not supported. This output only field contains a subset of the DataConnector fields, including `name`, `data_source`, `entities.entity_name` and `entities.data_store`. To get more details about a data connector, use the DataConnectorService.GetDataConnector method.",
 "readOnly": true
 },
 "displayName": {
@@ -10821,7 +10860,8 @@
 "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction",
 "properties": {
 "boost": {
-"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
+"deprecated": true,
+"description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
 "format": "float",
 "type": "number"
 },
@@ -10832,6 +10872,11 @@
 "filter": {
 "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
 "type": "string"
+},
+"fixedBoost": {
+"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
+"format": "float",
+"type": "number"
 }
 },
 "type": "object"
@@ -11005,7 +11050,7 @@
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1alphaDataConnector": {
-"description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through SetUpDataConnector method, which will create a new Collection and initialize its DataConnector. //",
+"description": "Manages the connection to external data sources for all data stores grouped under a Collection. It's a singleton resource of Collection. The initialization is only supported through DataConnectorService.SetUpDataConnector method, which will create a new Collection and initialize its DataConnector.",
 "id": "GoogleCloudDiscoveryengineV1alphaDataConnector",
 "properties": {
 "actionConfig": {
@@ -11106,7 +11151,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client id for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
+"description": "Required. Params needed to access the source in the format of (Key, Value) pairs. Required parameters for all data sources: * Key: `instance_uri` * Value: type STRING. The uri to access the data source. Required parameters for sources that support OAUTH, i.e. `salesforce`: * Key: `client_id` * Value: type STRING. The client ID for the third party service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the third party authorization server. * Key: `access_token` * Value: type STRING. OAuth token for UCS to access to the protected resource. * Key: `refresh_token` * Value: type STRING. OAuth refresh token for UCS to obtain a new access token without user interaction. Required parameters for sources that support basic API token auth, i.e. `jira`, `confluence`: * Key: `user_account` * Value: type STRING. The username or email with the source. * Key: `api_token` * Value: type STRING. The API token generated for the source account, that is used for authenticating anywhere where you would have used a password. Example: ```json { \"instance_uri\": \"https://xxx.atlassian.net\", \"user_account\": \"xxxx.xxx@xxx.com\", \"api_token\": \"test-token\" } ``` Optional parameter to specify the authorization type to use for multiple authorization types support: * Key: `auth_type` * Value: type STRING. The authorization type for the data source. Supported values: `BASIC_AUTH`, `OAUTH`, `OAUTH_ACCESS_TOKEN`, `OAUTH_TWO_LEGGED`, `OAUTH_JWT_BEARER`, `OAUTH_PASSWORD_GRANT`, `JWT`, `API_TOKEN`, `FEDERATED_CREDENTIAL`.",
 "type": "object"
 },
 "privateConnectivityProjectId": {
@@ -11196,7 +11241,7 @@
 "description": "Properties of the object.",
 "type": "any"
 },
-"description": "The parameters for the entity to facilitate data ingestion. E.g. for BQ connectors: * Key: `document_id_column` * Value: type STRING. The value of the column id.",
+"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"
 }
 },
@@ -11452,6 +11497,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata": {
+"description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaDeleteIdentityMappingStoreMetadata",
+"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"
+},
 "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": {
 "description": "Metadata for DeleteSchema LRO.",
 "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata",
@@ -12346,6 +12408,10 @@
 "description": "The configuration for the identity data synchronization runs.",
 "id": "GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig",
 "properties": {
+"nextSyncTime": {
+"$ref": "GoogleTypeDateTime",
+"description": "Optional. The UTC time when the next data sync is expected to start for the Data Connector. Customers are only able to specify the hour and minute to schedule the data sync. This is utilized when the data connector has a refresh interval greater than 1 day."
+},
 "refreshInterval": {
 "description": "Optional. The refresh interval to sync the Access Control List information for the documents ingested by this connector. If not set, the access control list will be refreshed at the default interval of 30 minutes. The identity refresh interval can be at least 30 minutes and at most 7 days.",
 "format": "google-duration",
@@ -13245,6 +13311,132 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata": {
+"description": "Metadata related to the progress of the CrawlRateManagementService.RemoveDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateMetadata",
+"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"
+},
+"GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse": {
+"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": "GoogleCloudDiscoveryengineV1alphaRemoveDedicatedCrawlRateResponse",
+"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"
+},
+"GoogleCloudDiscoveryengineV1alphaSafetyRating": {
+"description": "Safety rating corresponding to the generated content.",
+"id": "GoogleCloudDiscoveryengineV1alphaSafetyRating",
+"properties": {
+"blocked": {
+"description": "Output only. Indicates whether the content was filtered out because of this rating.",
+"readOnly": true,
+"type": "boolean"
+},
+"category": {
+"description": "Output only. Harm category.",
+"enum": [
+"HARM_CATEGORY_UNSPECIFIED",
+"HARM_CATEGORY_HATE_SPEECH",
+"HARM_CATEGORY_DANGEROUS_CONTENT",
+"HARM_CATEGORY_HARASSMENT",
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
+],
+"enumDescriptions": [
+"The harm category is unspecified.",
+"The harm category is hate speech.",
+"The harm category is dangerous content.",
+"The harm category is harassment.",
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
+],
+"readOnly": true,
+"type": "string"
+},
+"probability": {
+"description": "Output only. Harm probability levels in the content.",
+"enum": [
+"HARM_PROBABILITY_UNSPECIFIED",
+"NEGLIGIBLE",
+"LOW",
+"MEDIUM",
+"HIGH"
+],
+"enumDescriptions": [
+"Harm probability unspecified.",
+"Negligible level of harm.",
+"Low level of harm.",
+"Medium level of harm.",
+"High level of harm."
+],
+"readOnly": true,
+"type": "string"
+},
+"probabilityScore": {
+"description": "Output only. Harm probability score.",
+"format": "float",
+"readOnly": true,
+"type": "number"
+},
+"severity": {
+"description": "Output only. Harm severity levels in the content.",
+"enum": [
+"HARM_SEVERITY_UNSPECIFIED",
+"HARM_SEVERITY_NEGLIGIBLE",
+"HARM_SEVERITY_LOW",
+"HARM_SEVERITY_MEDIUM",
+"HARM_SEVERITY_HIGH"
+],
+"enumDescriptions": [
+"Harm severity unspecified.",
+"Negligible level of harm severity.",
+"Low level of harm severity.",
+"Medium level of harm severity.",
+"High level of harm severity."
+],
+"readOnly": true,
+"type": "string"
+},
+"severityScore": {
+"description": "Output only. Harm severity score.",
+"format": "float",
+"readOnly": true,
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSchema": {
 "description": "Defines the structure and layout of a type of document data.",
 "id": "GoogleCloudDiscoveryengineV1alphaSchema",
@@ -13884,14 +14076,14 @@
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec",
 "properties": {
 "filterExtractionCondition": {
-"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.",
+"description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.",
 "enum": [
 "CONDITION_UNSPECIFIED",
 "DISABLED",
 "ENABLED"
 ],
 "enumDescriptions": [
-"Server behavior defaults to Condition.DISABLED.",
+"Server behavior defaults to `DISABLED`.",
 "Disables NL filter extraction.",
 "Enables NL filter extraction."
 ],
@@ -14085,6 +14277,49 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata": {
+"description": "Metadata related to the progress of the CrawlRateManagementService.SetDedicatedCrawlRate operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateMetadata",
+"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"
+},
+"GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse": {
+"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": "GoogleCloudDiscoveryengineV1alphaSetDedicatedCrawlRateResponse",
+"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"
+},
 "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata": {
 "description": "Metadata for DataConnectorService.SetUpDataConnector method.",
 "id": "GoogleCloudDiscoveryengineV1alphaSetUpDataConnectorMetadata",
@@ -14180,7 +14415,7 @@
 "id": "GoogleCloudDiscoveryengineV1alphaTargetSite",
 "properties": {
 "exactMatch": {
-"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
+"description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
 "type": "boolean"
 },
 "failureReason": {
@@ -14720,7 +14955,16 @@
 "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig": {
 "description": "Configuration data for advance site search.",
 "id": "GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig",
-"properties": {},
+"properties": {
+"disableAutomaticRefresh": {
+"description": "If set true, automatic refresh is disabled for the DataStore.",
+"type": "boolean"
+},
+"disableInitialIndex": {
+"description": "If set true, initial indexing is disabled for the DataStore.",
+"type": "boolean"
+}
+},
 "type": "object"
 },
 "GoogleCloudDiscoveryengineV1betaAlloyDbSource": {
@@ -14846,6 +15090,13 @@
 },
 "type": "array"
 },
+"safetyRatings": {
+"description": "Optional. Safety ratings.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSafetyRating"
+},
+"type": "array"
+},
 "state": {
 "description": "The state of the answer generation.",
 "enum": [
@@ -15185,6 +15436,60 @@
 "enable": {
 "description": "Enable the safety filtering on the answer response. It is false by default.",
 "type": "boolean"
+},
+"safetySettings": {
+"description": "Optional. Safety settings. This settings are effective only when the safety_spec.enable is true.",
+"items": {
+"$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
+"GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting": {
+"description": "Safety settings.",
+"id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpecSafetySetting",
+"properties": {
+"category": {
+"description": "Required. Harm category.",
+"enum": [
+"HARM_CATEGORY_UNSPECIFIED",
+"HARM_CATEGORY_HATE_SPEECH",
+"HARM_CATEGORY_DANGEROUS_CONTENT",
+"HARM_CATEGORY_HARASSMENT",
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
+],
+"enumDescriptions": [
+"The harm category is unspecified.",
+"The harm category is hate speech.",
+"The harm category is dangerous content.",
+"The harm category is harassment.",
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
+],
+"type": "string"
+},
+"threshold": {
+"description": "Required. The harm block threshold.",
+"enum": [
+"HARM_BLOCK_THRESHOLD_UNSPECIFIED",
+"BLOCK_LOW_AND_ABOVE",
+"BLOCK_MEDIUM_AND_ABOVE",
+"BLOCK_ONLY_HIGH",
+"BLOCK_NONE",
+"OFF"
+],
+"enumDescriptions": [
+"Unspecified harm block threshold.",
+"Block low threshold and above (i.e. block more).",
+"Block medium threshold and above.",
+"Block only high threshold (i.e. block less).",
+"Block none.",
+"Turn off the safety filter."
+],
+"type": "string"
 }
 },
 "type": "object"
@@ -16619,7 +16924,8 @@
 "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction",
 "properties": {
 "boost": {
-"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
+"deprecated": true,
+"description": "Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
 "format": "float",
 "type": "number"
 },
@@ -16630,6 +16936,11 @@
 "filter": {
 "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.",
 "type": "string"
+},
+"fixedBoost": {
+"description": "Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).",
+"format": "float",
+"type": "number"
 }
 },
 "type": "object"
@@ -17251,6 +17562,23 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata": {
+"description": "Metadata related to the progress of the IdentityMappingStoreService.DeleteIdentityMappingStore operation. This will be returned by the google.longrunning.Operation.metadata field.",
+"id": "GoogleCloudDiscoveryengineV1betaDeleteIdentityMappingStoreMetadata",
+"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"
+},
 "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": {
 "description": "Metadata for DeleteSchema LRO.",
 "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata",
@@ -17349,7 +17677,7 @@
 "type": "object"
 },
 "id": {
-"description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.",
+"description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters.",
 "type": "string"
 },
 "indexStatus": {
@@ -18635,6 +18963,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1betaFirestoreSource",
 "description": "Firestore input source."
 },
+"forceRefreshContent": {
+"description": "Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.",
+"type": "boolean"
+},
 "gcsSource": {
 "$ref": "GoogleCloudDiscoveryengineV1betaGcsSource",
 "description": "Cloud Storage location for the input content."
@@ -19127,7 +19459,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse",
 "properties": {
 "evaluationResults": {
-"description": "The EvaluationResults.",
+"description": "The evaluation results for the SampleQuerys.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult"
 },
@@ -19886,7 +20218,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. Full resource name of the `SiteCredential`, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.",
 "type": "string"
 },
 "uris": {
@@ -19955,6 +20287,89 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSafetyRating": {
+"description": "Safety rating corresponding to the generated content.",
+"id": "GoogleCloudDiscoveryengineV1betaSafetyRating",
+"properties": {
+"blocked": {
+"description": "Output only. Indicates whether the content was filtered out because of this rating.",
+"readOnly": true,
+"type": "boolean"
+},
+"category": {
+"description": "Output only. Harm category.",
+"enum": [
+"HARM_CATEGORY_UNSPECIFIED",
+"HARM_CATEGORY_HATE_SPEECH",
+"HARM_CATEGORY_DANGEROUS_CONTENT",
+"HARM_CATEGORY_HARASSMENT",
+"HARM_CATEGORY_SEXUALLY_EXPLICIT",
+"HARM_CATEGORY_CIVIC_INTEGRITY"
+],
+"enumDescriptions": [
+"The harm category is unspecified.",
+"The harm category is hate speech.",
+"The harm category is dangerous content.",
+"The harm category is harassment.",
+"The harm category is sexually explicit content.",
+"The harm category is civic integrity."
+],
+"readOnly": true,
+"type": "string"
+},
+"probability": {
+"description": "Output only. Harm probability levels in the content.",
+"enum": [
+"HARM_PROBABILITY_UNSPECIFIED",
+"NEGLIGIBLE",
+"LOW",
+"MEDIUM",
+"HIGH"
+],
+"enumDescriptions": [
+"Harm probability unspecified.",
+"Negligible level of harm.",
+"Low level of harm.",
+"Medium level of harm.",
+"High level of harm."
+],
+"readOnly": true,
+"type": "string"
+},
+"probabilityScore": {
+"description": "Output only. Harm probability score.",
+"format": "float",
+"readOnly": true,
+"type": "number"
+},
+"severity": {
+"description": "Output only. Harm severity levels in the content.",
+"enum": [
+"HARM_SEVERITY_UNSPECIFIED",
+"HARM_SEVERITY_NEGLIGIBLE",
+"HARM_SEVERITY_LOW",
+"HARM_SEVERITY_MEDIUM",
+"HARM_SEVERITY_HIGH"
+],
+"enumDescriptions": [
+"Harm severity unspecified.",
+"Negligible level of harm severity.",
+"Low level of harm severity.",
+"Medium level of harm severity.",
+"High level of harm severity."
+],
+"readOnly": true,
+"type": "string"
+},
+"severityScore": {
+"description": "Output only. Harm severity score.",
+"format": "float",
+"readOnly": true,
+"type": "number"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSampleQuery": {
 "description": "Sample Query captures metadata to be used for evaluation.",
 "id": "GoogleCloudDiscoveryengineV1betaSampleQuery",
@@ -20690,14 +21105,14 @@
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec",
 "properties": {
 "filterExtractionCondition": {
-"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.",
+"description": "The condition under which filter extraction should occur. Server behavior defaults to `DISABLED`.",
 "enum": [
 "CONDITION_UNSPECIFIED",
 "DISABLED",
 "ENABLED"
 ],
 "enumDescriptions": [
-"Server behavior defaults to Condition.DISABLED.",
+"Server behavior defaults to `DISABLED`.",
 "Disables NL filter extraction.",
 "Enables NL filter extraction."
 ],
@@ -20894,6 +21309,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo",
 "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details."
 },
+"suggestedQuery": {
+"description": "Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus).",
+"type": "string"
+},
 "summary": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary",
 "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set."
@@ -21011,6 +21430,10 @@
 "description": "Rewritten input query minus the extracted filters.",
 "type": "string"
 },
+"sqlRequest": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest",
+"description": "Optional. The SQL request that was generated from the natural language query understanding phase."
+},
 "structuredExtractedFilter": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
 "description": "The filters that were extracted from the input query represented in a structured form."
@@ -21018,6 +21441,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest": {
+"description": "The SQL request that was generated from the natural language query understanding phase.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest",
+"properties": {
+"sqlQuery": {
+"description": "Optional. The SQL query in text format.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": {
 "description": "The filters that were extracted from the input query represented in a structured form.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter",
@@ -21535,7 +21969,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": {
@@ -21831,7 +22265,7 @@
 "id": "GoogleCloudDiscoveryengineV1betaTargetSite",
 "properties": {
 "exactMatch": {
-"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
+"description": "Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.",
 "type": "boolean"
 },
 "failureReason": {