@googleapis/discoveryengine 28.2.0 → 28.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v1beta.ts CHANGED
@@ -553,6 +553,19 @@ export namespace discoveryengine_v1beta {
553
553
  */
554
554
  useStaticSecrets?: boolean | null;
555
555
  }
556
+ /**
557
+ * Request for DataStoreService.AddPatientFilter method.
558
+ */
559
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
560
+ /**
561
+ * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
562
+ */
563
+ dataStore?: string | null;
564
+ /**
565
+ * Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
566
+ */
567
+ filterGroups?: string[] | null;
568
+ }
556
569
  /**
557
570
  * Configuration data for advance site search.
558
571
  */
@@ -1118,7 +1131,7 @@ export namespace discoveryengine_v1beta {
1118
1131
  */
1119
1132
  groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
1120
1133
  /**
1121
- * Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple AssistantService.StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.
1134
+ * Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.
1122
1135
  */
1123
1136
  replyId?: string | null;
1124
1137
  }
@@ -2371,6 +2384,15 @@ export namespace discoveryengine_v1beta {
2371
2384
  */
2372
2385
  updateTime?: string | null;
2373
2386
  }
2387
+ /**
2388
+ * Request for DataStoreService.DeletePatientFilters method.
2389
+ */
2390
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest {
2391
+ /**
2392
+ * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.
2393
+ */
2394
+ dataStore?: string | null;
2395
+ }
2374
2396
  /**
2375
2397
  * Metadata for DeleteSchema LRO.
2376
2398
  */
@@ -2663,13 +2685,17 @@ export namespace discoveryengine_v1beta {
2663
2685
  */
2664
2686
  displayName?: string | null;
2665
2687
  /**
2666
- * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
2688
+ * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`
2667
2689
  */
2668
2690
  features?: {[key: string]: string} | null;
2669
2691
  /**
2670
2692
  * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
2671
2693
  */
2672
2694
  industryVertical?: string | null;
2695
+ /**
2696
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
2697
+ */
2698
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
2673
2699
  /**
2674
2700
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
2675
2701
  */
@@ -2759,6 +2785,52 @@ export namespace discoveryengine_v1beta {
2759
2785
  */
2760
2786
  companyName?: string | null;
2761
2787
  }
2788
+ /**
2789
+ * Configuration message for the Knowledge Graph.
2790
+ */
2791
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig {
2792
+ /**
2793
+ * Specify entity types to support.
2794
+ */
2795
+ cloudKnowledgeGraphTypes?: string[] | null;
2796
+ /**
2797
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
2798
+ */
2799
+ enableCloudKnowledgeGraph?: boolean | null;
2800
+ /**
2801
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
2802
+ */
2803
+ enablePrivateKnowledgeGraph?: boolean | null;
2804
+ /**
2805
+ * Optional. Feature config for the Knowledge Graph.
2806
+ */
2807
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig;
2808
+ /**
2809
+ * Specify entity types to support.
2810
+ */
2811
+ privateKnowledgeGraphTypes?: string[] | null;
2812
+ }
2813
+ /**
2814
+ * Feature config for the Knowledge Graph.
2815
+ */
2816
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig {
2817
+ /**
2818
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
2819
+ */
2820
+ disablePrivateKgAutoComplete?: boolean | null;
2821
+ /**
2822
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
2823
+ */
2824
+ disablePrivateKgEnrichment?: boolean | null;
2825
+ /**
2826
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
2827
+ */
2828
+ disablePrivateKgQueryUiChips?: boolean | null;
2829
+ /**
2830
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
2831
+ */
2832
+ disablePrivateKgQueryUnderstanding?: boolean | null;
2833
+ }
2762
2834
  /**
2763
2835
  * Additional config specs for a Media Recommendation engine.
2764
2836
  */
@@ -3059,6 +3131,10 @@ export namespace discoveryengine_v1beta {
3059
3131
  * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
3060
3132
  */
3061
3133
  enableStaticIndexingForBatchIngestion?: boolean | null;
3134
+ /**
3135
+ * Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
3136
+ */
3137
+ initialFilterGroups?: string[] | null;
3062
3138
  }
3063
3139
  /**
3064
3140
  * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
@@ -3484,6 +3560,27 @@ export namespace discoveryengine_v1beta {
3484
3560
  */
3485
3561
  vertexAiOrganicCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
3486
3562
  }
3563
+ /**
3564
+ * Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.
3565
+ */
3566
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata {
3567
+ /**
3568
+ * Operation create time.
3569
+ */
3570
+ createTime?: string | null;
3571
+ /**
3572
+ * The number of patient IDs added to the patient filter.
3573
+ */
3574
+ filtersAddedCount?: string | null;
3575
+ /**
3576
+ * The number of patient IDs removed from the patient filter.
3577
+ */
3578
+ filtersRemovedCount?: string | null;
3579
+ /**
3580
+ * Operation last update time. If the operation is done, this is also the finish time.
3581
+ */
3582
+ updateTime?: string | null;
3583
+ }
3487
3584
  /**
3488
3585
  * Metadata and configurations for a Google Cloud project in the service.
3489
3586
  */
@@ -3529,10 +3626,22 @@ export namespace discoveryengine_v1beta {
3529
3626
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
3530
3627
  */
3531
3628
  effectiveSearchQpmThreshold?: string | null;
3629
+ /**
3630
+ * Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.
3631
+ */
3632
+ indexingCoreThresholdNextUpdateTime?: string | null;
3633
+ /**
3634
+ * Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.
3635
+ */
3636
+ searchQpmThresholdNextUpdateTime?: string | null;
3532
3637
  /**
3533
3638
  * Optional. The start time of the currently active billing subscription.
3534
3639
  */
3535
3640
  startTime?: string | null;
3641
+ /**
3642
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
3643
+ */
3644
+ terminateTime?: string | null;
3536
3645
  }
3537
3646
  /**
3538
3647
  * Customer provided configurations.
@@ -3895,6 +4004,32 @@ export namespace discoveryengine_v1beta {
3895
4004
  */
3896
4005
  state?: string | null;
3897
4006
  }
4007
+ /**
4008
+ * Request for DataStoreService.RemovePatientFilter method.
4009
+ */
4010
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest {
4011
+ /**
4012
+ * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned
4013
+ */
4014
+ dataStore?: string | null;
4015
+ /**
4016
+ * Required. Names of the Group resources to use as a basis for the list of patients to remove from the patient filter, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the list of IDs to remove will be constructed from the direct members of the group which are Patient resources.
4017
+ */
4018
+ filterGroups?: string[] | null;
4019
+ }
4020
+ /**
4021
+ * Request for DataStoreService.ReplacePatientFilter method.
4022
+ */
4023
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest {
4024
+ /**
4025
+ * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
4026
+ */
4027
+ dataStore?: string | null;
4028
+ /**
4029
+ * Required. Names of the Group resources to use as a basis for the list of patients for the new patient filter, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.
4030
+ */
4031
+ filterGroups?: string[] | null;
4032
+ }
3898
4033
  /**
3899
4034
  * Safety rating corresponding to the generated content.
3900
4035
  */
@@ -4047,7 +4182,7 @@ export namespace discoveryengine_v1beta {
4047
4182
  */
4048
4183
  orderBy?: string | null;
4049
4184
  /**
4050
- * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
4185
+ * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
4051
4186
  */
4052
4187
  pageCategories?: string[] | null;
4053
4188
  /**
@@ -4500,7 +4635,7 @@ export namespace discoveryengine_v1beta {
4500
4635
  */
4501
4636
  allowedFieldNames?: string[] | null;
4502
4637
  /**
4503
- * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
4638
+ * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED.
4504
4639
  */
4505
4640
  extractedFilterBehavior?: string | null;
4506
4641
  /**
@@ -5090,6 +5225,10 @@ export namespace discoveryengine_v1beta {
5090
5225
  * Optional. Customer policy for the assistant.
5091
5226
  */
5092
5227
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
5228
+ /**
5229
+ * Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
5230
+ */
5231
+ defaultWebGroundingToggleOff?: boolean | null;
5093
5232
  /**
5094
5233
  * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
5095
5234
  */
@@ -5340,7 +5479,7 @@ export namespace discoveryengine_v1beta {
5340
5479
  userPseudoId?: string | null;
5341
5480
  }
5342
5481
  /**
5343
- * Specification to boost suggestions based on the condtion of the suggestion.
5482
+ * Specification to boost suggestions based on the condition of the suggestion.
5344
5483
  */
5345
5484
  export interface Schema$GoogleCloudDiscoveryengineV1betaAdvancedCompleteQueryRequestBoostSpec {
5346
5485
  /**
@@ -6531,6 +6670,10 @@ export namespace discoveryengine_v1beta {
6531
6670
  * Optional. Customer policy for the assistant.
6532
6671
  */
6533
6672
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy;
6673
+ /**
6674
+ * Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
6675
+ */
6676
+ defaultWebGroundingToggleOff?: boolean | null;
6534
6677
  /**
6535
6678
  * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
6536
6679
  */
@@ -8534,13 +8677,17 @@ export namespace discoveryengine_v1beta {
8534
8677
  */
8535
8678
  displayName?: string | null;
8536
8679
  /**
8537
- * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
8680
+ * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`
8538
8681
  */
8539
8682
  features?: {[key: string]: string} | null;
8540
8683
  /**
8541
8684
  * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
8542
8685
  */
8543
8686
  industryVertical?: string | null;
8687
+ /**
8688
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
8689
+ */
8690
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
8544
8691
  /**
8545
8692
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
8546
8693
  */
@@ -8622,6 +8769,52 @@ export namespace discoveryengine_v1beta {
8622
8769
  */
8623
8770
  companyName?: string | null;
8624
8771
  }
8772
+ /**
8773
+ * Configuration message for the Knowledge Graph.
8774
+ */
8775
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig {
8776
+ /**
8777
+ * Specify entity types to support.
8778
+ */
8779
+ cloudKnowledgeGraphTypes?: string[] | null;
8780
+ /**
8781
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
8782
+ */
8783
+ enableCloudKnowledgeGraph?: boolean | null;
8784
+ /**
8785
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
8786
+ */
8787
+ enablePrivateKnowledgeGraph?: boolean | null;
8788
+ /**
8789
+ * Optional. Feature config for the Knowledge Graph.
8790
+ */
8791
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig;
8792
+ /**
8793
+ * Specify entity types to support.
8794
+ */
8795
+ privateKnowledgeGraphTypes?: string[] | null;
8796
+ }
8797
+ /**
8798
+ * Feature config for the Knowledge Graph.
8799
+ */
8800
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig {
8801
+ /**
8802
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
8803
+ */
8804
+ disablePrivateKgAutoComplete?: boolean | null;
8805
+ /**
8806
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
8807
+ */
8808
+ disablePrivateKgEnrichment?: boolean | null;
8809
+ /**
8810
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
8811
+ */
8812
+ disablePrivateKgQueryUiChips?: boolean | null;
8813
+ /**
8814
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
8815
+ */
8816
+ disablePrivateKgQueryUnderstanding?: boolean | null;
8817
+ }
8625
8818
  /**
8626
8819
  * Additional config specs for a Media Recommendation engine.
8627
8820
  */
@@ -8915,6 +9108,10 @@ export namespace discoveryengine_v1beta {
8915
9108
  * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
8916
9109
  */
8917
9110
  enableStaticIndexingForBatchIngestion?: boolean | null;
9111
+ /**
9112
+ * Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
9113
+ */
9114
+ initialFilterGroups?: string[] | null;
8918
9115
  }
8919
9116
  /**
8920
9117
  * Identity Mapping Entry that maps an external identity to an internal identity.
@@ -9659,7 +9856,7 @@ export namespace discoveryengine_v1beta {
9659
9856
  nextPageToken?: string | null;
9660
9857
  }
9661
9858
  /**
9662
- * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
9859
+ * Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
9663
9860
  */
9664
9861
  export interface Schema$GoogleCloudDiscoveryengineV1betaListLicenseConfigsUsageStatsResponse {
9665
9862
  /**
@@ -9937,10 +10134,22 @@ export namespace discoveryengine_v1beta {
9937
10134
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
9938
10135
  */
9939
10136
  effectiveSearchQpmThreshold?: string | null;
10137
+ /**
10138
+ * Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.
10139
+ */
10140
+ indexingCoreThresholdNextUpdateTime?: string | null;
10141
+ /**
10142
+ * Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.
10143
+ */
10144
+ searchQpmThresholdNextUpdateTime?: string | null;
9940
10145
  /**
9941
10146
  * Optional. The start time of the currently active billing subscription.
9942
10147
  */
9943
10148
  startTime?: string | null;
10149
+ /**
10150
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
10151
+ */
10152
+ terminateTime?: string | null;
9944
10153
  }
9945
10154
  /**
9946
10155
  * Customer provided configurations.
@@ -10723,7 +10932,7 @@ export namespace discoveryengine_v1beta {
10723
10932
  */
10724
10933
  orderBy?: string | null;
10725
10934
  /**
10726
- * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
10935
+ * Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
10727
10936
  */
10728
10937
  pageCategories?: string[] | null;
10729
10938
  /**
@@ -11172,7 +11381,7 @@ export namespace discoveryengine_v1beta {
11172
11381
  */
11173
11382
  allowedFieldNames?: string[] | null;
11174
11383
  /**
11175
- * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.natural_language_query_understanding_spec.filter_extraction_condition is set to FilterExtractionCondition.ENABLED.
11384
+ * Optional. Controls behavior of how extracted filters are applied to the search. The default behavior depends on the request. For single datastore structured search, the default is `HARD_FILTER`. For multi-datastore search, the default behavior is `SOFT_BOOST`. Location-based filters are always applied as hard filters, and the `SOFT_BOOST` setting will not affect them. This field is only used if SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition is set to FilterExtractionCondition.ENABLED.
11176
11385
  */
11177
11386
  extractedFilterBehavior?: string | null;
11178
11387
  /**
@@ -11315,7 +11524,7 @@ export namespace discoveryengine_v1beta {
11315
11524
  */
11316
11525
  guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult;
11317
11526
  /**
11318
- * Natural language query understanding information for the returned results.
11527
+ * Output only. Natural language query understanding information for the returned results.
11319
11528
  */
11320
11529
  naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo;
11321
11530
  /**
@@ -13743,13 +13952,17 @@ export namespace discoveryengine_v1beta {
13743
13952
  */
13744
13953
  displayName?: string | null;
13745
13954
  /**
13746
- * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
13955
+ * Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`
13747
13956
  */
13748
13957
  features?: {[key: string]: string} | null;
13749
13958
  /**
13750
13959
  * Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
13751
13960
  */
13752
13961
  industryVertical?: string | null;
13962
+ /**
13963
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
13964
+ */
13965
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
13753
13966
  /**
13754
13967
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
13755
13968
  */
@@ -13831,6 +14044,52 @@ export namespace discoveryengine_v1beta {
13831
14044
  */
13832
14045
  companyName?: string | null;
13833
14046
  }
14047
+ /**
14048
+ * Configuration message for the Knowledge Graph.
14049
+ */
14050
+ export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig {
14051
+ /**
14052
+ * Specify entity types to support.
14053
+ */
14054
+ cloudKnowledgeGraphTypes?: string[] | null;
14055
+ /**
14056
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
14057
+ */
14058
+ enableCloudKnowledgeGraph?: boolean | null;
14059
+ /**
14060
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
14061
+ */
14062
+ enablePrivateKnowledgeGraph?: boolean | null;
14063
+ /**
14064
+ * Optional. Feature config for the Knowledge Graph.
14065
+ */
14066
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig;
14067
+ /**
14068
+ * Specify entity types to support.
14069
+ */
14070
+ privateKnowledgeGraphTypes?: string[] | null;
14071
+ }
14072
+ /**
14073
+ * Feature config for the Knowledge Graph.
14074
+ */
14075
+ export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig {
14076
+ /**
14077
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
14078
+ */
14079
+ disablePrivateKgAutoComplete?: boolean | null;
14080
+ /**
14081
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
14082
+ */
14083
+ disablePrivateKgEnrichment?: boolean | null;
14084
+ /**
14085
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
14086
+ */
14087
+ disablePrivateKgQueryUiChips?: boolean | null;
14088
+ /**
14089
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
14090
+ */
14091
+ disablePrivateKgQueryUnderstanding?: boolean | null;
14092
+ }
13834
14093
  /**
13835
14094
  * Additional config specs for a Media Recommendation engine.
13836
14095
  */
@@ -13929,6 +14188,10 @@ export namespace discoveryengine_v1beta {
13929
14188
  * Whether to enable static indexing for `HEALTHCARE_FHIR` batch ingestion. If set to `true`, the batch ingestion will be processed in a static indexing mode which is slower but more capable of handling larger volume.
13930
14189
  */
13931
14190
  enableStaticIndexingForBatchIngestion?: boolean | null;
14191
+ /**
14192
+ * Optional. Names of the Group resources to use as a basis for the initial patient filter, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
14193
+ */
14194
+ initialFilterGroups?: string[] | null;
13932
14195
  }
13933
14196
  /**
13934
14197
  * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
@@ -14241,10 +14504,22 @@ export namespace discoveryengine_v1beta {
14241
14504
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
14242
14505
  */
14243
14506
  effectiveSearchQpmThreshold?: string | null;
14507
+ /**
14508
+ * Output only. The earliest next update time for the indexing core subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update indexing core subscription threshold request is succeeded.
14509
+ */
14510
+ indexingCoreThresholdNextUpdateTime?: string | null;
14511
+ /**
14512
+ * Output only. The earliest next update time for the search QPM subscription threshold. This is based on the next_update_time returned by the underlying Cloud Billing Subscription V3 API. This field is populated only if an update QPM subscription threshold request is succeeded.
14513
+ */
14514
+ searchQpmThresholdNextUpdateTime?: string | null;
14244
14515
  /**
14245
14516
  * Optional. The start time of the currently active billing subscription.
14246
14517
  */
14247
14518
  startTime?: string | null;
14519
+ /**
14520
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
14521
+ */
14522
+ terminateTime?: string | null;
14248
14523
  }
14249
14524
  /**
14250
14525
  * Customer provided configurations.
@@ -33202,6 +33477,7 @@ export namespace discoveryengine_v1beta {
33202
33477
  * // "displayName": "my_displayName",
33203
33478
  * // "features": {},
33204
33479
  * // "industryVertical": "my_industryVertical",
33480
+ * // "knowledgeGraphConfig": {},
33205
33481
  * // "mediaRecommendationEngineConfig": {},
33206
33482
  * // "modelConfigs": {},
33207
33483
  * // "name": "my_name",
@@ -33525,6 +33801,7 @@ export namespace discoveryengine_v1beta {
33525
33801
  * // "displayName": "my_displayName",
33526
33802
  * // "features": {},
33527
33803
  * // "industryVertical": "my_industryVertical",
33804
+ * // "knowledgeGraphConfig": {},
33528
33805
  * // "mediaRecommendationEngineConfig": {},
33529
33806
  * // "modelConfigs": {},
33530
33807
  * // "name": "my_name",
@@ -33856,6 +34133,7 @@ export namespace discoveryengine_v1beta {
33856
34133
  * // "displayName": "my_displayName",
33857
34134
  * // "features": {},
33858
34135
  * // "industryVertical": "my_industryVertical",
34136
+ * // "knowledgeGraphConfig": {},
33859
34137
  * // "mediaRecommendationEngineConfig": {},
33860
34138
  * // "modelConfigs": {},
33861
34139
  * // "name": "my_name",
@@ -33881,6 +34159,7 @@ export namespace discoveryengine_v1beta {
33881
34159
  * // "displayName": "my_displayName",
33882
34160
  * // "features": {},
33883
34161
  * // "industryVertical": "my_industryVertical",
34162
+ * // "knowledgeGraphConfig": {},
33884
34163
  * // "mediaRecommendationEngineConfig": {},
33885
34164
  * // "modelConfigs": {},
33886
34165
  * // "name": "my_name",
@@ -34054,6 +34333,7 @@ export namespace discoveryengine_v1beta {
34054
34333
  * // "displayName": "my_displayName",
34055
34334
  * // "features": {},
34056
34335
  * // "industryVertical": "my_industryVertical",
34336
+ * // "knowledgeGraphConfig": {},
34057
34337
  * // "mediaRecommendationEngineConfig": {},
34058
34338
  * // "modelConfigs": {},
34059
34339
  * // "name": "my_name",
@@ -34230,6 +34510,7 @@ export namespace discoveryengine_v1beta {
34230
34510
  * // "displayName": "my_displayName",
34231
34511
  * // "features": {},
34232
34512
  * // "industryVertical": "my_industryVertical",
34513
+ * // "knowledgeGraphConfig": {},
34233
34514
  * // "mediaRecommendationEngineConfig": {},
34234
34515
  * // "modelConfigs": {},
34235
34516
  * // "name": "my_name",
@@ -34658,6 +34939,7 @@ export namespace discoveryengine_v1beta {
34658
34939
  * // request body parameters
34659
34940
  * // {
34660
34941
  * // "customerPolicy": {},
34942
+ * // "defaultWebGroundingToggleOff": false,
34661
34943
  * // "description": "my_description",
34662
34944
  * // "displayName": "my_displayName",
34663
34945
  * // "enabledTools": {},
@@ -34673,6 +34955,7 @@ export namespace discoveryengine_v1beta {
34673
34955
  * // Example response
34674
34956
  * // {
34675
34957
  * // "customerPolicy": {},
34958
+ * // "defaultWebGroundingToggleOff": false,
34676
34959
  * // "description": "my_description",
34677
34960
  * // "displayName": "my_displayName",
34678
34961
  * // "enabledTools": {},
@@ -34976,6 +35259,7 @@ export namespace discoveryengine_v1beta {
34976
35259
  * // Example response
34977
35260
  * // {
34978
35261
  * // "customerPolicy": {},
35262
+ * // "defaultWebGroundingToggleOff": false,
34979
35263
  * // "description": "my_description",
34980
35264
  * // "displayName": "my_displayName",
34981
35265
  * // "enabledTools": {},
@@ -35298,6 +35582,7 @@ export namespace discoveryengine_v1beta {
35298
35582
  * // request body parameters
35299
35583
  * // {
35300
35584
  * // "customerPolicy": {},
35585
+ * // "defaultWebGroundingToggleOff": false,
35301
35586
  * // "description": "my_description",
35302
35587
  * // "displayName": "my_displayName",
35303
35588
  * // "enabledTools": {},
@@ -35313,6 +35598,7 @@ export namespace discoveryengine_v1beta {
35313
35598
  * // Example response
35314
35599
  * // {
35315
35600
  * // "customerPolicy": {},
35601
+ * // "defaultWebGroundingToggleOff": false,
35316
35602
  * // "description": "my_description",
35317
35603
  * // "displayName": "my_displayName",
35318
35604
  * // "enabledTools": {},