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

googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json

@@ -161,34 +161,6 @@
 "resources": {
 "locations": {
 "methods": {
-"generateGroundedContent": {
-"description": "Generates grounded content.",
-"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:generateGroundedContent",
-"httpMethod": "POST",
-"id": "discoveryengine.projects.locations.generateGroundedContent",
-"parameterOrder": [
-"location"
-],
-"parameters": {
-"location": {
-"description": "Required. Location resource. Format: `projects/{project}/locations/{location}`.",
-"location": "path",
-"pattern": "^projects/[^/]+/locations/[^/]+$",
-"required": true,
-"type": "string"
-}
-},
-"path": "v1beta/{+location}:generateGroundedContent",
-"request": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest"
-},
-"response": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse"
-},
-"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",
@@ -7750,7 +7722,7 @@
 }
 }
 },
-"revision": "20250214",
+"revision": "20250306",
 "rootUrl": "https://discoveryengine.googleapis.com/",
 "schemas": {
 "GoogleApiDistribution": {
@@ -8006,6 +7978,43 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext": {
+"description": "The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`",
+"id": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext",
+"properties": {
+"connectorRun": {
+"description": "The full resource name of the Connector Run. Format: `projects/*/locations/*/collections/*/dataConnector/connectorRuns/*`. The `connector_run_id` is system-generated.",
+"type": "string"
+},
+"dataConnector": {
+"description": "The full resource name of the DataConnector. Format: `projects/*/locations/*/collections/*/dataConnector`.",
+"type": "string"
+},
+"endTime": {
+"description": "The time when the connector run ended.",
+"format": "google-datetime",
+"type": "string"
+},
+"entity": {
+"description": "The entity to sync for the connector run.",
+"type": "string"
+},
+"operation": {
+"description": "The operation resource name of the LRO to sync the connector.",
+"type": "string"
+},
+"startTime": {
+"description": "The time when the connector run started.",
+"format": "google-datetime",
+"type": "string"
+},
+"syncType": {
+"description": "The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineLoggingErrorContext": {
 "description": "A description of the context in which an error occurred.",
 "id": "GoogleCloudDiscoveryengineLoggingErrorContext",
@@ -8025,6 +8034,10 @@
 "description": "An error log which is reported to the Error Reporting system.",
 "id": "GoogleCloudDiscoveryengineLoggingErrorLog",
 "properties": {
+"connectorRunPayload": {
+"$ref": "GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext",
+"description": "The error payload that is populated on LRO connector sync APIs."
+},
 "context": {
 "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext",
 "description": "A description of the context in which the error occurred."
@@ -9145,6 +9158,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig",
 "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
 },
+"allowCrossRegion": {
+"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
+"type": "boolean"
+},
 "dialogflowAgentToLink": {
 "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
 "type": "string"
@@ -10992,6 +11009,30 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaBAPConfig": {
+"description": "The configuration for the BAP connector.",
+"id": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
+"properties": {
+"supportedConnectorModes": {
+"description": "Required. The supported connector modes for the associated BAP connection.",
+"items": {
+"enum": [
+"CONNECTOR_MODE_UNSPECIFIED",
+"DATA_INGESTION",
+"ACTIONS"
+],
+"enumDescriptions": [
+"Connector mode unspecified.",
+"Connector utilized for data ingestion.",
+"Connector utilized for Actions"
+],
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": {
 "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.",
 "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata",
@@ -11297,6 +11338,10 @@
 "format": "int64",
 "type": "string"
 },
+"progress": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress",
+"description": "Metadata to generate the progress bar."
+},
 "sourceApiRequestCount": {
 "description": "The number of requests sent to 3p API.",
 "format": "int64",
@@ -11341,18 +11386,42 @@
 "enum": [
 "SYNC_TYPE_UNSPECIFIED",
 "FULL",
-"INCREMENTAL"
+"INCREMENTAL",
+"REALTIME"
 ],
 "enumDescriptions": [
 "Sync type unspecified.",
 "Sync triggers full sync of all documents.",
-"Incremental sync of updated documents."
+"Incremental sync of updated documents.",
+"Realtime sync."
 ],
 "type": "string"
 }
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress": {
+"description": "Represents the progress of a sync run.",
+"id": "GoogleCloudDiscoveryengineV1alphaConnectorRunEntityRunProgress",
+"properties": {
+"currentCount": {
+"description": "The current progress.",
+"format": "int64",
+"type": "string"
+},
+"percentile": {
+"description": "Derived. The percentile of the progress.current_count / total_count. The value is between [0, 1.0] inclusive.",
+"format": "float",
+"type": "number"
+},
+"totalCount": {
+"description": "The total.",
+"format": "int64",
+"type": "string"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaControl": {
 "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.",
 "id": "GoogleCloudDiscoveryengineV1alphaControl",
@@ -11708,6 +11777,10 @@
 "description": "Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync.",
 "type": "boolean"
 },
+"bapConfig": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaBAPConfig",
+"description": "Optional. The configuration for establishing a BAP connection."
+},
 "blockingReasons": {
 "description": "Output only. User actions that must be completed before the connector can start syncing data.",
 "items": {
@@ -11726,6 +11799,35 @@
 "readOnly": true,
 "type": "array"
 },
+"connectorType": {
+"description": "Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system.",
+"enum": [
+"CONNECTOR_TYPE_UNSPECIFIED",
+"THIRD_PARTY",
+"GCP_FHIR",
+"BIG_QUERY",
+"GCS",
+"GOOGLE_MAIL",
+"GOOGLE_CALENDAR",
+"GOOGLE_DRIVE",
+"NATIVE_CLOUD_IDENTITY",
+"THIRD_PARTY_FEDERATED"
+],
+"enumDescriptions": [
+"Default value.",
+"Third party connector to connector to third party application.",
+"Data connector connects between FHIR store and VAIS datastore.",
+"Big query connector.",
+"Google Cloud Storage connector.",
+"Gmail connector.",
+"Google Calendar connector.",
+"Google Drive connector.",
+"Native Cloud Identity connector for people search powered by People API.",
+"Federated connector, it is a third party connector that doesn't ingestion data, and search is powered by third party application's API."
+],
+"readOnly": true,
+"type": "string"
+},
 "createTime": {
 "description": "Output only. Timestamp the DataConnector was created at.",
 "format": "google-datetime",
@@ -11806,6 +11908,29 @@
 "readOnly": true,
 "type": "string"
 },
+"realtimeState": {
+"description": "Output only. real-time sync state",
+"enum": [
+"STATE_UNSPECIFIED",
+"CREATING",
+"ACTIVE",
+"FAILED",
+"RUNNING",
+"WARNING",
+"INITIALIZATION_FAILED"
+],
+"enumDescriptions": [
+"Default value.",
+"The connector is being set up.",
+"The connector is successfully set up and awaiting next sync run.",
+"The connector is in error. The error details can be found in DataConnector.errors. If the error is unfixable, the DataConnector can be deleted by [CollectionService.DeleteCollection] API.",
+"The connector is actively syncing records from the data source.",
+"The connector has completed a sync run, but encountered non-fatal errors.",
+"Connector initialization failed. Potential causes include runtime errors or issues in the asynchronous pipeline, preventing the request from reaching downstream services (except for some connector types)."
+],
+"readOnly": true,
+"type": "string"
+},
 "refreshInterval": {
 "description": "Required. The refresh interval for data sync. If duration is set to 0, the data will be synced in real time. The streaming feature is not supported yet. The minimum is 30 minutes and maximum is 7 days.",
 "format": "google-duration",
@@ -11850,11 +11975,13 @@
 "description": "The data synchronization mode supported by the data connector.",
 "enum": [
 "PERIODIC",
-"STREAMING"
+"STREAMING",
+"UNSPECIFIED"
 ],
 "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 data will be synced in real time."
+"The data will be synced in real time.",
+"Connector that doesn't ingest data will have this value"
 ],
 "type": "string"
 },
@@ -12102,10 +12229,18 @@
 "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": "GoogleCloudDiscoveryengineV1alphaDedicatedCrawlRateTimeSeries",
 "properties": {
+"autoRefreshCrawlErrorRate": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
+"description": "Vertex AI's error rate time series of auto-refresh dedicated crawl."
+},
 "autoRefreshCrawlRate": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
 "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."
 },
+"userTriggeredCrawlErrorRate": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
+"description": "Vertex AI's error rate time series of user triggered dedicated crawl."
+},
 "userTriggeredCrawlRate": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries",
 "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."
@@ -12561,6 +12696,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig",
 "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
 },
+"allowCrossRegion": {
+"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
+"type": "boolean"
+},
 "dialogflowAgentToLink": {
 "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
 "type": "string"
@@ -14242,7 +14381,7 @@
 "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec."
 },
 "dataStoreSpecs": {
-"description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
+"description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec"
 },
@@ -14343,8 +14482,12 @@
 "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
 "type": "string"
 },
+"relevanceScoreSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
+"description": "Optional. The specification for returning the relevance score."
+},
 "relevanceThreshold": {
-"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.",
+"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
 "enum": [
 "RELEVANCE_THRESHOLD_UNSPECIFIED",
 "LOWEST",
@@ -14705,7 +14848,7 @@
 "MATCH_HIGHLIGHTING_ENABLED"
 ],
 "enumDescriptions": [
-"Server behavior is the same as DISABLED.",
+"Server behavior is the same as `MATCH_HIGHLIGHTING_DISABLED`.",
 "Disables match highlighting on all documents.",
 "Enables match highlighting on all documents."
 ],
@@ -14906,6 +15049,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec": {
+"description": "The specification for returning the document relevance score.",
+"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec",
+"properties": {
+"returnRelevanceScore": {
+"description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": {
 "description": "Specification for search as you type in search requests.",
 "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec",
@@ -15671,10 +15825,23 @@
 "description": "The name of the dataStore that this suggestion belongs to.",
 "type": "string"
 },
+"destinationUri": {
+"description": "The destination uri of the content suggestion.",
+"type": "string"
+},
 "document": {
 "$ref": "GoogleCloudDiscoveryengineV1betaDocument",
 "description": "The document data snippet in the suggestion. Only a subset of fields will be populated."
 },
+"iconUri": {
+"description": "The icon uri of the content suggestion.",
+"type": "string"
+},
+"score": {
+"description": "The score of each suggestion. The score is in the range of [0, 1].",
+"format": "double",
+"type": "number"
+},
 "suggestion": {
 "description": "The suggestion for the query.",
 "type": "string"
@@ -15690,6 +15857,14 @@
 "description": "The name of the dataStore that this suggestion belongs to.",
 "type": "string"
 },
+"destinationUri": {
+"description": "The destination uri of the person suggestion.",
+"type": "string"
+},
+"displayPhotoUri": {
+"description": "The photo uri of the person suggestion.",
+"type": "string"
+},
 "document": {
 "$ref": "GoogleCloudDiscoveryengineV1betaDocument",
 "description": "The document data snippet in the suggestion. Only a subset of fields is populated."
@@ -15708,6 +15883,11 @@
 ],
 "type": "string"
 },
+"score": {
+"description": "The score of each suggestion. The score is in the range of [0, 1].",
+"format": "double",
+"type": "number"
+},
 "suggestion": {
 "description": "The suggestion for the query.",
 "type": "string"
@@ -15733,6 +15913,11 @@
 },
 "type": "array"
 },
+"score": {
+"description": "The score of each suggestion. The score is in the range of [0, 1].",
+"format": "double",
+"type": "number"
+},
 "suggestion": {
 "description": "The suggestion for the query.",
 "type": "string"
@@ -15749,6 +15934,11 @@
 "format": "google-datetime",
 "type": "string"
 },
+"score": {
+"description": "The score of each suggestion. The score is in the range of [0, 1].",
+"format": "double",
+"type": "number"
+},
 "suggestion": {
 "description": "The suggestion for the query.",
 "type": "string"
@@ -18486,10 +18676,18 @@
 "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": {
+"autoRefreshCrawlErrorRate": {
+"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
+"description": "Vertex AI's error rate time series of auto-refresh dedicated crawl."
+},
 "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."
 },
+"userTriggeredCrawlErrorRate": {
+"$ref": "GoogleCloudDiscoveryengineV1betaCrawlRateTimeSeries",
+"description": "Vertex AI's error rate time series of user triggered dedicated crawl."
+},
 "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."
@@ -19026,6 +19224,10 @@
 "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig",
 "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation."
 },
+"allowCrossRegion": {
+"description": "Optional. If the flag set to true, we allow the agent and engine are in different locations, otherwise the agent and engine are required to be in the same location. The flag is set to false by default. Note that the `allow_cross_region` are one-time consumed by and passed to EngineService.CreateEngine. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.",
+"type": "boolean"
+},
 "dialogflowAgentToLink": {
 "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.",
 "type": "string"
@@ -19346,424 +19548,6 @@
 },
 "type": "object"
 },
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest": {
-"description": "Top-level message sent by the client for the `GenerateGroundedContent` method.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequest",
-"properties": {
-"contents": {
-"description": "Content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent"
-},
-"type": "array"
-},
-"generationSpec": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec",
-"description": "Content generation specification."
-},
-"groundingSpec": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec",
-"description": "Grounding specification."
-},
-"systemInstruction": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent",
-"description": "Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them."
-},
-"userLabels": {
-"additionalProperties": {
-"type": "string"
-},
-"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.",
-"type": "object"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration": {
-"description": "Describes the options to customize dynamic retrieval.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration",
-"properties": {
-"predictor": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor",
-"description": "Specification for the predictor for dynamic retrieval."
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor": {
-"description": "Describes the predictor settings for dynamic retrieval.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfigurationDynamicRetrievalPredictor",
-"properties": {
-"threshold": {
-"description": "The value of the threshold. If the predictor will predict a value smaller than this, it would suppress grounding in the source.",
-"format": "float",
-"type": "number"
-},
-"version": {
-"description": "The version of the predictor to be used in dynamic retrieval.",
-"enum": [
-"VERSION_UNSPECIFIED",
-"V1_INDEPENDENT"
-],
-"enumDescriptions": [
-"Automatically choose the best version of the retrieval predictor.",
-"The V1 model which is evaluating each source independently."
-],
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec": {
-"description": "Content generation specification.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGenerationSpec",
-"properties": {
-"frequencyPenalty": {
-"description": "If specified, custom value for frequency penalty will be used.",
-"format": "float",
-"type": "number"
-},
-"languageCode": {
-"description": "Language code for content. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).",
-"type": "string"
-},
-"maxOutputTokens": {
-"description": "If specified, custom value for max output tokens will be used.",
-"format": "int32",
-"type": "integer"
-},
-"modelId": {
-"description": "Specifies which Vertex model id to use for generation.",
-"type": "string"
-},
-"presencePenalty": {
-"description": "If specified, custom value for presence penalty will be used.",
-"format": "float",
-"type": "number"
-},
-"seed": {
-"description": "If specified, custom value for the seed will be used.",
-"format": "int32",
-"type": "integer"
-},
-"temperature": {
-"description": "If specified, custom value for the temperature will be used.",
-"format": "float",
-"type": "number"
-},
-"topK": {
-"description": "If specified, custom value for top-k sampling will be used.",
-"format": "int32",
-"type": "integer"
-},
-"topP": {
-"description": "If specified, custom value for nucleus sampling will be used.",
-"format": "float",
-"type": "number"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource": {
-"description": "Grounding source.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource",
-"properties": {
-"googleSearchSource": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource",
-"description": "If set, grounding is performed with Google Search."
-},
-"inlineSource": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource",
-"description": "If set, grounding is performed with inline content."
-},
-"searchSource": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource",
-"description": "If set, grounding is performed with Vertex AI Search."
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource": {
-"description": "Google Search config parameters.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceGoogleSearchSource",
-"properties": {
-"dynamicRetrievalConfig": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestDynamicRetrievalConfiguration",
-"description": "Optional. Specifies the dynamic retrieval configuration for the given source."
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource": {
-"description": "Message to be used for grounding based on inline content.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceInlineSource",
-"properties": {
-"attributes": {
-"additionalProperties": {
-"type": "string"
-},
-"description": "Attributes associated with the content. Common attributes include `source` (indicating where the content was sourced from) and `author` (indicating the author of the content).",
-"type": "object"
-},
-"groundingFacts": {
-"description": "List of facts to be used for grounding.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGroundingFact"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource": {
-"description": "Message to be used for grounding with Vertex AI Search.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSourceSearchSource",
-"properties": {
-"filter": {
-"description": "Filter expression to be applied to the search. The syntax is the same as SearchRequest.filter.",
-"type": "string"
-},
-"maxResultCount": {
-"description": "Number of search results to return. The default value is 10. The maximumm allowed value is 10.",
-"format": "int32",
-"type": "integer"
-},
-"safeSearch": {
-"description": "If set, safe search is enabled in Vertex AI Search requests.",
-"type": "boolean"
-},
-"servingConfig": {
-"description": "The resource name of the Engine to use. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`",
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec": {
-"description": "Grounding specification.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSpec",
-"properties": {
-"groundingSources": {
-"description": "Grounding sources.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentRequestGroundingSource"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse": {
-"description": "Response for the `GenerateGroundedContent` method.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponse",
-"properties": {
-"candidates": {
-"description": "Generated candidates.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate": {
-"description": "A response candidate generated from the model.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidate",
-"properties": {
-"content": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent",
-"description": "Content of the candidate."
-},
-"groundingMetadata": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata",
-"description": "Grounding metadata for the generated content."
-},
-"groundingScore": {
-"description": "The overall grounding score for the candidate, in the range of [0, 1].",
-"format": "float",
-"type": "number"
-},
-"index": {
-"description": "Index of the candidate.",
-"format": "int32",
-"type": "integer"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata": {
-"description": "Citation for the generated content.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadata",
-"properties": {
-"groundingSupport": {
-"description": "GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport"
-},
-"type": "array"
-},
-"retrievalMetadata": {
-"description": "Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata"
-},
-"type": "array"
-},
-"searchEntryPoint": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint",
-"description": "Google search entry for the following-up web searches."
-},
-"supportChunks": {
-"description": "List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaFactChunk"
-},
-"type": "array"
-},
-"webSearchQueries": {
-"description": "Web search queries for the following-up web search.",
-"items": {
-"type": "string"
-},
-"type": "array"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata": {
-"description": "Describes the metadata about dynamic retrieval.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata",
-"properties": {
-"predictorMetadata": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata",
-"description": "Metadata for the dynamic retrieval predictor."
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata": {
-"description": "Describes the metadata about the dynamic retrieval predictor.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalPredictorMetadata",
-"properties": {
-"prediction": {
-"description": "The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding.",
-"format": "float",
-"type": "number"
-},
-"version": {
-"description": "The version of the predictor which was used in dynamic retrieval.",
-"enum": [
-"VERSION_UNSPECIFIED",
-"V1_INDEPENDENT"
-],
-"enumDescriptions": [
-"Unspecified version, should never be used.",
-"The V1 model which is evaluating each source independently."
-],
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport": {
-"description": "Grounding info for a claim in the candidate and its support.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataGroundingSupport",
-"properties": {
-"claimText": {
-"description": "Text for the claim in the candidate. Always provided when a support is found.",
-"type": "string"
-},
-"supportChunkIndices": {
-"description": "A list of indices (into 'support_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that support_chunks[1], support_chunks[3], support_chunks[4] are the chunks attributed to the claim.",
-"items": {
-"format": "int32",
-"type": "integer"
-},
-"type": "array"
-},
-"supportScore": {
-"description": "A score in the range of [0, 1] describing how grounded is a specific claim in the support chunks indicated. Higher value means that the claim is better supported by the chunks.",
-"format": "float",
-"type": "number"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata": {
-"description": "Describes the metadata associated with a retrieval step.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataRetrievalMetadata",
-"properties": {
-"dynamicRetrievalMetadata": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataDynamicRetrievalMetadata",
-"description": "Metadata for dynamic retrieval."
-},
-"source": {
-"description": "Describes the source to which the metadata is referring to.",
-"enum": [
-"SOURCE_UNSPECIFIED",
-"VERTEX_AI_SEARCH",
-"GOOGLE_SEARCH",
-"INLINE_CONTENT",
-"GOOGLE_MAPS"
-],
-"enumDescriptions": [
-"Unspecified source.",
-"Vertex AI search.",
-"Google Search.",
-"User inline provided content.",
-"Google Maps."
-],
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint": {
-"description": "Google search entry point.",
-"id": "GoogleCloudDiscoveryengineV1betaGenerateGroundedContentResponseCandidateGroundingMetadataSearchEntryPoint",
-"properties": {
-"renderedContent": {
-"description": "Web content snippet that can be embedded in a web page or an app webview.",
-"type": "string"
-},
-"sdkBlob": {
-"description": "Base64 encoded JSON representing array of tuple.",
-"format": "byte",
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGroundedGenerationContent": {
-"description": "Base structured datatype containing multi-part content of a message.",
-"id": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContent",
-"properties": {
-"parts": {
-"description": "Ordered `Parts` that constitute a single message.",
-"items": {
-"$ref": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart"
-},
-"type": "array"
-},
-"role": {
-"description": "Producer of the content. Must be either `user` or `model`. Intended to be used for multi-turn conversations. Otherwise, it can be left unset.",
-"type": "string"
-}
-},
-"type": "object"
-},
-"GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart": {
-"description": "Single part of content.",
-"id": "GoogleCloudDiscoveryengineV1betaGroundedGenerationContentPart",
-"properties": {
-"text": {
-"description": "Inline text.",
-"type": "string"
-}
-},
-"type": "object"
-},
 "GoogleCloudDiscoveryengineV1betaGroundingFact": {
 "description": "Grounding Fact.",
 "id": "GoogleCloudDiscoveryengineV1betaGroundingFact",
@@ -21270,7 +21054,7 @@
 "type": "boolean"
 },
 "model": {
-"description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.",
+"description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maximum input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.",
 "type": "string"
 },
 "query": {
@@ -21507,7 +21291,7 @@
 "type": "boolean"
 },
 "removeTime": {
-"description": "Optional. Time at which the suggestion was removed. If not set, the current time will be used.",
+"description": "Required. Time at which the suggestion was removed. If not set, the current time will be used.",
 "format": "google-datetime",
 "type": "string"
 },
@@ -21850,7 +21634,7 @@
 "description": "A specification for configuring the behavior of content search."
 },
 "dataStoreSpecs": {
-"description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
+"description": "Specifications that define the specific [DataStore]s to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.",
 "items": {
 "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec"
 },
@@ -21947,8 +21731,12 @@
 "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.",
 "type": "string"
 },
+"relevanceScoreSpec": {
+"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
+"description": "Optional. The specification for returning the relevance score."
+},
 "relevanceThreshold": {
-"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.",
+"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.",
 "enum": [
 "RELEVANCE_THRESHOLD_UNSPECIFIED",
 "LOWEST",
@@ -22489,6 +22277,17 @@
 },
 "type": "object"
 },
+"GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec": {
+"description": "The specification for returning the document relevance score.",
+"id": "GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec",
+"properties": {
+"returnRelevanceScore": {
+"description": "Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
 "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": {
 "description": "Specification for search as you type in search requests.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec",
@@ -22739,6 +22538,13 @@
 "description": "Information describing what natural language understanding was done on the input query.",
 "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo",
 "properties": {
+"classifiedIntents": {
+"description": "The classified intents from the input query.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "extractedFilters": {
 "description": "The filters that were extracted from the input query.",
 "type": "string"
@@ -22995,7 +22801,8 @@
 "additionalProperties": {
 "$ref": "GoogleCloudDiscoveryengineV1betaDoubleList"
 },
-"description": "Google provided available scores.",
+"description": "Output only. Google provided available scores.",
+"readOnly": true,
 "type": "object"
 }
 },
@@ -23037,7 +22844,8 @@
 "NO_RELEVANT_CONTENT",
 "JAIL_BREAKING_QUERY_IGNORED",
 "CUSTOMER_POLICY_VIOLATION",
-"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2"
+"NON_SUMMARY_SEEKING_QUERY_IGNORED_V2",
+"TIME_OUT"
 ],
 "enumDescriptions": [
 "Default value. The summary skipped reason is not specified.",
@@ -23049,7 +22857,8 @@
 "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.",
 "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.",
 "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.",
-"The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`."
+"The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`.",
+"The time out case. Google skips the summary if the time out."
 ],
 "type": "string"
 },