@googleapis/discoveryengine 28.3.0 → 28.5.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/v1.ts CHANGED
@@ -518,7 +518,7 @@ export namespace discoveryengine_v1 {
518
518
  userPseudoId?: string | null;
519
519
  }
520
520
  /**
521
- * Specification to boost suggestions based on the condtion of the suggestion.
521
+ * Specification to boost suggestions based on the condition of the suggestion.
522
522
  */
523
523
  export interface Schema$GoogleCloudDiscoveryengineV1AdvancedCompleteQueryRequestBoostSpec {
524
524
  /**
@@ -787,6 +787,19 @@ export namespace discoveryengine_v1 {
787
787
  */
788
788
  useStaticSecrets?: boolean | null;
789
789
  }
790
+ /**
791
+ * Request for DataStoreService.AddPatientFilter method.
792
+ */
793
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
794
+ /**
795
+ * 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.
796
+ */
797
+ dataStore?: string | null;
798
+ /**
799
+ * 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.
800
+ */
801
+ filterGroups?: string[] | null;
802
+ }
790
803
  /**
791
804
  * Configuration data for advance site search.
792
805
  */
@@ -1352,7 +1365,7 @@ export namespace discoveryengine_v1 {
1352
1365
  */
1353
1366
  groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
1354
1367
  /**
1355
- * 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.
1368
+ * 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.
1356
1369
  */
1357
1370
  replyId?: string | null;
1358
1371
  }
@@ -2605,6 +2618,15 @@ export namespace discoveryengine_v1 {
2605
2618
  */
2606
2619
  updateTime?: string | null;
2607
2620
  }
2621
+ /**
2622
+ * Request for DataStoreService.DeletePatientFilters method.
2623
+ */
2624
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest {
2625
+ /**
2626
+ * 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.
2627
+ */
2628
+ dataStore?: string | null;
2629
+ }
2608
2630
  /**
2609
2631
  * Metadata for DeleteSchema LRO.
2610
2632
  */
@@ -2897,13 +2919,17 @@ export namespace discoveryengine_v1 {
2897
2919
  */
2898
2920
  displayName?: string | null;
2899
2921
  /**
2900
- * 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`
2922
+ * 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`
2901
2923
  */
2902
2924
  features?: {[key: string]: string} | null;
2903
2925
  /**
2904
2926
  * 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.
2905
2927
  */
2906
2928
  industryVertical?: string | null;
2929
+ /**
2930
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
2931
+ */
2932
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
2907
2933
  /**
2908
2934
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
2909
2935
  */
@@ -2916,6 +2942,10 @@ export namespace discoveryengine_v1 {
2916
2942
  * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
2917
2943
  */
2918
2944
  name?: string | null;
2945
+ /**
2946
+ * Optional. Observability config for the engine.
2947
+ */
2948
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1alphaObservabilityConfig;
2919
2949
  /**
2920
2950
  * Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
2921
2951
  */
@@ -2993,6 +3023,52 @@ export namespace discoveryengine_v1 {
2993
3023
  */
2994
3024
  companyName?: string | null;
2995
3025
  }
3026
+ /**
3027
+ * Configuration message for the Knowledge Graph.
3028
+ */
3029
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig {
3030
+ /**
3031
+ * Specify entity types to support.
3032
+ */
3033
+ cloudKnowledgeGraphTypes?: string[] | null;
3034
+ /**
3035
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
3036
+ */
3037
+ enableCloudKnowledgeGraph?: boolean | null;
3038
+ /**
3039
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
3040
+ */
3041
+ enablePrivateKnowledgeGraph?: boolean | null;
3042
+ /**
3043
+ * Optional. Feature config for the Knowledge Graph.
3044
+ */
3045
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig;
3046
+ /**
3047
+ * Specify entity types to support.
3048
+ */
3049
+ privateKnowledgeGraphTypes?: string[] | null;
3050
+ }
3051
+ /**
3052
+ * Feature config for the Knowledge Graph.
3053
+ */
3054
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig {
3055
+ /**
3056
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
3057
+ */
3058
+ disablePrivateKgAutoComplete?: boolean | null;
3059
+ /**
3060
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
3061
+ */
3062
+ disablePrivateKgEnrichment?: boolean | null;
3063
+ /**
3064
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
3065
+ */
3066
+ disablePrivateKgQueryUiChips?: boolean | null;
3067
+ /**
3068
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
3069
+ */
3070
+ disablePrivateKgQueryUnderstanding?: boolean | null;
3071
+ }
2996
3072
  /**
2997
3073
  * Additional config specs for a Media Recommendation engine.
2998
3074
  */
@@ -3293,6 +3369,10 @@ export namespace discoveryengine_v1 {
3293
3369
  * 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.
3294
3370
  */
3295
3371
  enableStaticIndexingForBatchIngestion?: boolean | null;
3372
+ /**
3373
+ * 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.
3374
+ */
3375
+ initialFilterGroups?: string[] | null;
3296
3376
  }
3297
3377
  /**
3298
3378
  * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
@@ -3684,6 +3764,19 @@ export namespace discoveryengine_v1 {
3684
3764
  */
3685
3765
  mode?: string | null;
3686
3766
  }
3767
+ /**
3768
+ * Observability config for a resource.
3769
+ */
3770
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaObservabilityConfig {
3771
+ /**
3772
+ * Optional. Enables observability. If false, all other flags are ignored.
3773
+ */
3774
+ observabilityEnabled?: boolean | null;
3775
+ /**
3776
+ * Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
3777
+ */
3778
+ sensitiveLoggingEnabled?: boolean | null;
3779
+ }
3687
3780
  /**
3688
3781
  * Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.
3689
3782
  */
@@ -3718,6 +3811,27 @@ export namespace discoveryengine_v1 {
3718
3811
  */
3719
3812
  vertexAiOrganicCrawlRate?: Schema$GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
3720
3813
  }
3814
+ /**
3815
+ * Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.
3816
+ */
3817
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata {
3818
+ /**
3819
+ * Operation create time.
3820
+ */
3821
+ createTime?: string | null;
3822
+ /**
3823
+ * The number of patient IDs added to the patient filter.
3824
+ */
3825
+ filtersAddedCount?: string | null;
3826
+ /**
3827
+ * The number of patient IDs removed from the patient filter.
3828
+ */
3829
+ filtersRemovedCount?: string | null;
3830
+ /**
3831
+ * Operation last update time. If the operation is done, this is also the finish time.
3832
+ */
3833
+ updateTime?: string | null;
3834
+ }
3721
3835
  /**
3722
3836
  * Metadata and configurations for a Google Cloud project in the service.
3723
3837
  */
@@ -3763,10 +3877,22 @@ export namespace discoveryengine_v1 {
3763
3877
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
3764
3878
  */
3765
3879
  effectiveSearchQpmThreshold?: string | null;
3880
+ /**
3881
+ * 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.
3882
+ */
3883
+ indexingCoreThresholdNextUpdateTime?: string | null;
3884
+ /**
3885
+ * 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.
3886
+ */
3887
+ searchQpmThresholdNextUpdateTime?: string | null;
3766
3888
  /**
3767
3889
  * Optional. The start time of the currently active billing subscription.
3768
3890
  */
3769
3891
  startTime?: string | null;
3892
+ /**
3893
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
3894
+ */
3895
+ terminateTime?: string | null;
3770
3896
  }
3771
3897
  /**
3772
3898
  * Customer provided configurations.
@@ -3785,6 +3911,10 @@ export namespace discoveryengine_v1 {
3785
3911
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
3786
3912
  */
3787
3913
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
3914
+ /**
3915
+ * Optional. Observability config for NotebookLM.
3916
+ */
3917
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1alphaObservabilityConfig;
3788
3918
  /**
3789
3919
  * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
3790
3920
  */
@@ -4129,6 +4259,32 @@ export namespace discoveryengine_v1 {
4129
4259
  */
4130
4260
  state?: string | null;
4131
4261
  }
4262
+ /**
4263
+ * Request for DataStoreService.RemovePatientFilter method.
4264
+ */
4265
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest {
4266
+ /**
4267
+ * 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
4268
+ */
4269
+ dataStore?: string | null;
4270
+ /**
4271
+ * 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.
4272
+ */
4273
+ filterGroups?: string[] | null;
4274
+ }
4275
+ /**
4276
+ * Request for DataStoreService.ReplacePatientFilter method.
4277
+ */
4278
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest {
4279
+ /**
4280
+ * 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.
4281
+ */
4282
+ dataStore?: string | null;
4283
+ /**
4284
+ * 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.
4285
+ */
4286
+ filterGroups?: string[] | null;
4287
+ }
4132
4288
  /**
4133
4289
  * Safety rating corresponding to the generated content.
4134
4290
  */
@@ -4281,7 +4437,7 @@ export namespace discoveryengine_v1 {
4281
4437
  */
4282
4438
  orderBy?: string | null;
4283
4439
  /**
4284
- * 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`
4440
+ * 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`
4285
4441
  */
4286
4442
  pageCategories?: string[] | null;
4287
4443
  /**
@@ -4734,7 +4890,7 @@ export namespace discoveryengine_v1 {
4734
4890
  */
4735
4891
  allowedFieldNames?: string[] | null;
4736
4892
  /**
4737
- * 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.
4893
+ * 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.
4738
4894
  */
4739
4895
  extractedFilterBehavior?: string | null;
4740
4896
  /**
@@ -7496,13 +7652,17 @@ export namespace discoveryengine_v1 {
7496
7652
  */
7497
7653
  displayName?: string | null;
7498
7654
  /**
7499
- * 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`
7655
+ * 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`
7500
7656
  */
7501
7657
  features?: {[key: string]: string} | null;
7502
7658
  /**
7503
7659
  * 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.
7504
7660
  */
7505
7661
  industryVertical?: string | null;
7662
+ /**
7663
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
7664
+ */
7665
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
7506
7666
  /**
7507
7667
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
7508
7668
  */
@@ -7515,6 +7675,10 @@ export namespace discoveryengine_v1 {
7515
7675
  * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
7516
7676
  */
7517
7677
  name?: string | null;
7678
+ /**
7679
+ * Optional. Observability config for the engine.
7680
+ */
7681
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1betaObservabilityConfig;
7518
7682
  /**
7519
7683
  * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
7520
7684
  */
@@ -7584,6 +7748,52 @@ export namespace discoveryengine_v1 {
7584
7748
  */
7585
7749
  companyName?: string | null;
7586
7750
  }
7751
+ /**
7752
+ * Configuration message for the Knowledge Graph.
7753
+ */
7754
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig {
7755
+ /**
7756
+ * Specify entity types to support.
7757
+ */
7758
+ cloudKnowledgeGraphTypes?: string[] | null;
7759
+ /**
7760
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
7761
+ */
7762
+ enableCloudKnowledgeGraph?: boolean | null;
7763
+ /**
7764
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
7765
+ */
7766
+ enablePrivateKnowledgeGraph?: boolean | null;
7767
+ /**
7768
+ * Optional. Feature config for the Knowledge Graph.
7769
+ */
7770
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig;
7771
+ /**
7772
+ * Specify entity types to support.
7773
+ */
7774
+ privateKnowledgeGraphTypes?: string[] | null;
7775
+ }
7776
+ /**
7777
+ * Feature config for the Knowledge Graph.
7778
+ */
7779
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig {
7780
+ /**
7781
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
7782
+ */
7783
+ disablePrivateKgAutoComplete?: boolean | null;
7784
+ /**
7785
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
7786
+ */
7787
+ disablePrivateKgEnrichment?: boolean | null;
7788
+ /**
7789
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
7790
+ */
7791
+ disablePrivateKgQueryUiChips?: boolean | null;
7792
+ /**
7793
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
7794
+ */
7795
+ disablePrivateKgQueryUnderstanding?: boolean | null;
7796
+ }
7587
7797
  /**
7588
7798
  * Additional config specs for a Media Recommendation engine.
7589
7799
  */
@@ -7741,6 +7951,10 @@ export namespace discoveryengine_v1 {
7741
7951
  * 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.
7742
7952
  */
7743
7953
  enableStaticIndexingForBatchIngestion?: boolean | null;
7954
+ /**
7955
+ * 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.
7956
+ */
7957
+ initialFilterGroups?: string[] | null;
7744
7958
  }
7745
7959
  /**
7746
7960
  * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
@@ -8077,6 +8291,19 @@ export namespace discoveryengine_v1 {
8077
8291
  */
8078
8292
  mode?: string | null;
8079
8293
  }
8294
+ /**
8295
+ * Observability config for a resource.
8296
+ */
8297
+ export interface Schema$GoogleCloudDiscoveryengineV1betaObservabilityConfig {
8298
+ /**
8299
+ * Optional. Enables observability. If false, all other flags are ignored.
8300
+ */
8301
+ observabilityEnabled?: boolean | null;
8302
+ /**
8303
+ * Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
8304
+ */
8305
+ sensitiveLoggingEnabled?: boolean | null;
8306
+ }
8080
8307
  /**
8081
8308
  * Response message for CrawlRateManagementService.ObtainCrawlRate method. The response contains organcic or dedicated crawl rate time series data for monitoring, depending on whether dedicated crawl rate is set.
8082
8309
  */
@@ -8154,10 +8381,22 @@ export namespace discoveryengine_v1 {
8154
8381
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
8155
8382
  */
8156
8383
  effectiveSearchQpmThreshold?: string | null;
8384
+ /**
8385
+ * 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.
8386
+ */
8387
+ indexingCoreThresholdNextUpdateTime?: string | null;
8388
+ /**
8389
+ * 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.
8390
+ */
8391
+ searchQpmThresholdNextUpdateTime?: string | null;
8157
8392
  /**
8158
8393
  * Optional. The start time of the currently active billing subscription.
8159
8394
  */
8160
8395
  startTime?: string | null;
8396
+ /**
8397
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
8398
+ */
8399
+ terminateTime?: string | null;
8161
8400
  }
8162
8401
  /**
8163
8402
  * Customer provided configurations.
@@ -8176,6 +8415,10 @@ export namespace discoveryengine_v1 {
8176
8415
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
8177
8416
  */
8178
8417
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
8418
+ /**
8419
+ * Optional. Observability config for NotebookLM.
8420
+ */
8421
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1betaObservabilityConfig;
8179
8422
  /**
8180
8423
  * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
8181
8424
  */
@@ -8474,7 +8717,7 @@ export namespace discoveryengine_v1 {
8474
8717
  */
8475
8718
  orderBy?: string | null;
8476
8719
  /**
8477
- * 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`
8720
+ * 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`
8478
8721
  */
8479
8722
  pageCategories?: string[] | null;
8480
8723
  /**
@@ -8923,7 +9166,7 @@ export namespace discoveryengine_v1 {
8923
9166
  */
8924
9167
  allowedFieldNames?: string[] | null;
8925
9168
  /**
8926
- * 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.
9169
+ * 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.
8927
9170
  */
8928
9171
  extractedFilterBehavior?: string | null;
8929
9172
  /**
@@ -11177,13 +11420,17 @@ export namespace discoveryengine_v1 {
11177
11420
  */
11178
11421
  displayName?: string | null;
11179
11422
  /**
11180
- * 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`
11423
+ * 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`
11181
11424
  */
11182
11425
  features?: {[key: string]: string} | null;
11183
11426
  /**
11184
11427
  * 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.
11185
11428
  */
11186
11429
  industryVertical?: string | null;
11430
+ /**
11431
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
11432
+ */
11433
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
11187
11434
  /**
11188
11435
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
11189
11436
  */
@@ -11196,6 +11443,10 @@ export namespace discoveryengine_v1 {
11196
11443
  * Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
11197
11444
  */
11198
11445
  name?: string | null;
11446
+ /**
11447
+ * Optional. Observability config for the engine.
11448
+ */
11449
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1ObservabilityConfig;
11199
11450
  /**
11200
11451
  * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
11201
11452
  */
@@ -11265,6 +11516,52 @@ export namespace discoveryengine_v1 {
11265
11516
  */
11266
11517
  companyName?: string | null;
11267
11518
  }
11519
+ /**
11520
+ * Configuration message for the Knowledge Graph.
11521
+ */
11522
+ export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig {
11523
+ /**
11524
+ * Specify entity types to support.
11525
+ */
11526
+ cloudKnowledgeGraphTypes?: string[] | null;
11527
+ /**
11528
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
11529
+ */
11530
+ enableCloudKnowledgeGraph?: boolean | null;
11531
+ /**
11532
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
11533
+ */
11534
+ enablePrivateKnowledgeGraph?: boolean | null;
11535
+ /**
11536
+ * Optional. Feature config for the Knowledge Graph.
11537
+ */
11538
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig;
11539
+ /**
11540
+ * Specify entity types to support.
11541
+ */
11542
+ privateKnowledgeGraphTypes?: string[] | null;
11543
+ }
11544
+ /**
11545
+ * Feature config for the Knowledge Graph.
11546
+ */
11547
+ export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig {
11548
+ /**
11549
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
11550
+ */
11551
+ disablePrivateKgAutoComplete?: boolean | null;
11552
+ /**
11553
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
11554
+ */
11555
+ disablePrivateKgEnrichment?: boolean | null;
11556
+ /**
11557
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
11558
+ */
11559
+ disablePrivateKgQueryUiChips?: boolean | null;
11560
+ /**
11561
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
11562
+ */
11563
+ disablePrivateKgQueryUnderstanding?: boolean | null;
11564
+ }
11268
11565
  /**
11269
11566
  * Additional config specs for a Media Recommendation engine.
11270
11567
  */
@@ -11499,6 +11796,10 @@ export namespace discoveryengine_v1 {
11499
11796
  * 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.
11500
11797
  */
11501
11798
  enableStaticIndexingForBatchIngestion?: boolean | null;
11799
+ /**
11800
+ * 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.
11801
+ */
11802
+ initialFilterGroups?: string[] | null;
11502
11803
  }
11503
11804
  /**
11504
11805
  * Identity Mapping Entry that maps an external identity to an internal identity.
@@ -12128,7 +12429,7 @@ export namespace discoveryengine_v1 {
12128
12429
  nextPageToken?: string | null;
12129
12430
  }
12130
12431
  /**
12131
- * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
12432
+ * Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
12132
12433
  */
12133
12434
  export interface Schema$GoogleCloudDiscoveryengineV1ListLicenseConfigsUsageStatsResponse {
12134
12435
  /**
@@ -12227,6 +12528,19 @@ export namespace discoveryengine_v1 {
12227
12528
  */
12228
12529
  mode?: string | null;
12229
12530
  }
12531
+ /**
12532
+ * Observability config for a resource.
12533
+ */
12534
+ export interface Schema$GoogleCloudDiscoveryengineV1ObservabilityConfig {
12535
+ /**
12536
+ * Optional. Enables observability. If false, all other flags are ignored.
12537
+ */
12538
+ observabilityEnabled?: boolean | null;
12539
+ /**
12540
+ * Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
12541
+ */
12542
+ sensitiveLoggingEnabled?: boolean | null;
12543
+ }
12230
12544
  /**
12231
12545
  * Detailed page information.
12232
12546
  */
@@ -12333,10 +12647,22 @@ export namespace discoveryengine_v1 {
12333
12647
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
12334
12648
  */
12335
12649
  effectiveSearchQpmThreshold?: string | null;
12650
+ /**
12651
+ * 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.
12652
+ */
12653
+ indexingCoreThresholdNextUpdateTime?: string | null;
12654
+ /**
12655
+ * 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.
12656
+ */
12657
+ searchQpmThresholdNextUpdateTime?: string | null;
12336
12658
  /**
12337
12659
  * Optional. The start time of the currently active billing subscription.
12338
12660
  */
12339
12661
  startTime?: string | null;
12662
+ /**
12663
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
12664
+ */
12665
+ terminateTime?: string | null;
12340
12666
  }
12341
12667
  /**
12342
12668
  * Customer provided configurations.
@@ -12355,6 +12681,10 @@ export namespace discoveryengine_v1 {
12355
12681
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
12356
12682
  */
12357
12683
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
12684
+ /**
12685
+ * Optional. Observability config for NotebookLM.
12686
+ */
12687
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1ObservabilityConfig;
12358
12688
  /**
12359
12689
  * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
12360
12690
  */
@@ -12930,7 +13260,7 @@ export namespace discoveryengine_v1 {
12930
13260
  */
12931
13261
  orderBy?: string | null;
12932
13262
  /**
12933
- * 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`
13263
+ * 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`
12934
13264
  */
12935
13265
  pageCategories?: string[] | null;
12936
13266
  /**
@@ -13324,7 +13654,7 @@ export namespace discoveryengine_v1 {
13324
13654
  */
13325
13655
  allowedFieldNames?: string[] | null;
13326
13656
  /**
13327
- * 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.
13657
+ * 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.
13328
13658
  */
13329
13659
  extractedFilterBehavior?: string | null;
13330
13660
  /**
@@ -13405,6 +13735,10 @@ export namespace discoveryengine_v1 {
13405
13735
  * Results of facets requested by user.
13406
13736
  */
13407
13737
  facets?: Schema$GoogleCloudDiscoveryengineV1SearchResponseFacet[];
13738
+ /**
13739
+ * Output only. Natural language query understanding information for the returned results.
13740
+ */
13741
+ naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo;
13408
13742
  /**
13409
13743
  * A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
13410
13744
  */
@@ -13476,6 +13810,142 @@ export namespace discoveryengine_v1 {
13476
13810
  */
13477
13811
  value?: string | null;
13478
13812
  }
13813
+ /**
13814
+ * Information describing what natural language understanding was done on the input query.
13815
+ */
13816
+ export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfo {
13817
+ /**
13818
+ * The classified intents from the input query.
13819
+ */
13820
+ classifiedIntents?: string[] | null;
13821
+ /**
13822
+ * The filters that were extracted from the input query.
13823
+ */
13824
+ extractedFilters?: string | null;
13825
+ /**
13826
+ * Rewritten input query minus the extracted filters.
13827
+ */
13828
+ rewrittenQuery?: string | null;
13829
+ /**
13830
+ * The filters that were extracted from the input query represented in a structured form.
13831
+ */
13832
+ structuredExtractedFilter?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter;
13833
+ }
13834
+ /**
13835
+ * The filters that were extracted from the input query represented in a structured form.
13836
+ */
13837
+ export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter {
13838
+ /**
13839
+ * The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators.
13840
+ */
13841
+ expression?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression;
13842
+ }
13843
+ /**
13844
+ * Logical `And` operator.
13845
+ */
13846
+ export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression {
13847
+ /**
13848
+ * The expressions that were ANDed together.
13849
+ */
13850
+ expressions?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[];
13851
+ }
13852
+ /**
13853
+ * The expression denoting the filter that was extracted from the input query.
13854
+ */
13855
+ export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression {
13856
+ /**
13857
+ * Logical "And" compound operator connecting multiple expressions.
13858
+ */
13859
+ andExpr?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression;
13860
+ /**
13861
+ * Geolocation constraint expression.
13862
+ */
13863
+ geolocationConstraint?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint;
13864
+ /**
13865
+ * Numerical constraint expression.
13866
+ */
13867
+ numberConstraint?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint;
13868
+ /**
13869
+ * Logical "Or" compound operator connecting multiple expressions.
13870
+ */
13871
+ orExpr?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression;
13872
+ /**
13873
+ * String constraint expression.
13874
+ */
13875
+ stringConstraint?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint;
13876
+ }
13877
+ /**
13878
+ * Constraint of a geolocation field. Name of the geolocation field as defined in the schema.
13879
+ */
13880
+ export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint {
13881
+ /**
13882
+ * The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results.
13883
+ */
13884
+ address?: string | null;
13885
+ /**
13886
+ * The name of the geolocation field as defined in the schema.
13887
+ */
13888
+ fieldName?: string | null;
13889
+ /**
13890
+ * The latitude of the geolocation inferred from the input query.
13891
+ */
13892
+ latitude?: number | null;
13893
+ /**
13894
+ * The longitude of the geolocation inferred from the input query.
13895
+ */
13896
+ longitude?: number | null;
13897
+ /**
13898
+ * The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius.
13899
+ */
13900
+ radiusInMeters?: number | null;
13901
+ }
13902
+ /**
13903
+ * Constraint expression of a number field. Example: price < 100.
13904
+ */
13905
+ export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint {
13906
+ /**
13907
+ * The comparison operation performed between the field value and the value specified in the constraint.
13908
+ */
13909
+ comparison?: string | null;
13910
+ /**
13911
+ * Name of the numerical field as defined in the schema.
13912
+ */
13913
+ fieldName?: string | null;
13914
+ /**
13915
+ * Identifies the keywords within the search query that match a filter.
13916
+ */
13917
+ querySegment?: string | null;
13918
+ /**
13919
+ * The value specified in the numerical constraint.
13920
+ */
13921
+ value?: number | null;
13922
+ }
13923
+ /**
13924
+ * Logical `Or` operator.
13925
+ */
13926
+ export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression {
13927
+ /**
13928
+ * The expressions that were ORed together.
13929
+ */
13930
+ expressions?: Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[];
13931
+ }
13932
+ /**
13933
+ * Constraint expression of a string field.
13934
+ */
13935
+ export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint {
13936
+ /**
13937
+ * Name of the string field as defined in the schema.
13938
+ */
13939
+ fieldName?: string | null;
13940
+ /**
13941
+ * Identifies the keywords within the search query that match a filter.
13942
+ */
13943
+ querySegment?: string | null;
13944
+ /**
13945
+ * Values of the string field. The record will only be returned if the field value matches one of the values specified here.
13946
+ */
13947
+ values?: string[] | null;
13948
+ }
13479
13949
  /**
13480
13950
  * Information describing query expansion including whether expansion has occurred.
13481
13951
  */
@@ -14648,6 +15118,10 @@ export namespace discoveryengine_v1 {
14648
15118
  * Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
14649
15119
  */
14650
15120
  name?: string | null;
15121
+ /**
15122
+ * Output only. The nodes associated with the Widget Config.
15123
+ */
15124
+ nodes?: Schema$GoogleCloudDiscoveryengineV1WidgetConfigNode[];
14651
15125
  /**
14652
15126
  * The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.
14653
15127
  */
@@ -14744,7 +15218,7 @@ export namespace discoveryengine_v1 {
14744
15218
  */
14745
15219
  id?: string | null;
14746
15220
  /**
14747
- * The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
15221
+ * The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.
14748
15222
  */
14749
15223
  name?: string | null;
14750
15224
  }
@@ -14778,7 +15252,7 @@ export namespace discoveryengine_v1 {
14778
15252
  */
14779
15253
  id?: string | null;
14780
15254
  /**
14781
- * The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
15255
+ * The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.
14782
15256
  */
14783
15257
  name?: string | null;
14784
15258
  }
@@ -14803,7 +15277,7 @@ export namespace discoveryengine_v1 {
14803
15277
  */
14804
15278
  id?: string | null;
14805
15279
  /**
14806
- * The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookUpWidgetConfig, the project number and location part is erased in this field.
15280
+ * The name of the data store. It should be data store resource name Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field.
14807
15281
  */
14808
15282
  name?: string | null;
14809
15283
  }
@@ -14855,6 +15329,35 @@ export namespace discoveryengine_v1 {
14855
15329
  */
14856
15330
  url?: string | null;
14857
15331
  }
15332
+ /**
15333
+ * Represents a single reusable computational or logical unit.
15334
+ */
15335
+ export interface Schema$GoogleCloudDiscoveryengineV1WidgetConfigNode {
15336
+ /**
15337
+ * Output only. A detailed description of what the node does.
15338
+ */
15339
+ description?: string | null;
15340
+ /**
15341
+ * Output only. A human readable name for the node.
15342
+ */
15343
+ displayName?: string | null;
15344
+ /**
15345
+ * Output only. An identifier or URL pointing to an icon representing this node type.
15346
+ */
15347
+ iconUrl?: string | null;
15348
+ /**
15349
+ * Output only. The output schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html/ and AIP-146). It describes the structure of the output produced by this node.
15350
+ */
15351
+ outputSchema?: {[key: string]: any} | null;
15352
+ /**
15353
+ * Output only. The parameter schema of the tool. This schema is expected to conform to the OpenAPI Schema standard (see https://spec.openapis.org/oas/v3.0.3.html and AIP-146). It describes the expected structure of the parameters that this node accepts.
15354
+ */
15355
+ parameterSchema?: {[key: string]: any} | null;
15356
+ /**
15357
+ * Output only. The type of the node.
15358
+ */
15359
+ type?: string | null;
15360
+ }
14858
15361
  /**
14859
15362
  * Describes widget UI branding settings.
14860
15363
  */
@@ -14926,7 +15429,7 @@ export namespace discoveryengine_v1 {
14926
15429
  */
14927
15430
  enableVisualContentSummary?: boolean | null;
14928
15431
  /**
14929
- * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `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`
15432
+ * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `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`
14930
15433
  */
14931
15434
  features?: {[key: string]: string} | null;
14932
15435
  /**
@@ -27612,6 +28115,7 @@ export namespace discoveryengine_v1 {
27612
28115
  * // "attributionToken": "my_attributionToken",
27613
28116
  * // "correctedQuery": "my_correctedQuery",
27614
28117
  * // "facets": [],
28118
+ * // "naturalLanguageQueryUnderstandingInfo": {},
27615
28119
  * // "nextPageToken": "my_nextPageToken",
27616
28120
  * // "queryExpansionInfo": {},
27617
28121
  * // "redirectUri": "my_redirectUri",
@@ -27820,6 +28324,7 @@ export namespace discoveryengine_v1 {
27820
28324
  * // "attributionToken": "my_attributionToken",
27821
28325
  * // "correctedQuery": "my_correctedQuery",
27822
28326
  * // "facets": [],
28327
+ * // "naturalLanguageQueryUnderstandingInfo": {},
27823
28328
  * // "nextPageToken": "my_nextPageToken",
27824
28329
  * // "queryExpansionInfo": {},
27825
28330
  * // "redirectUri": "my_redirectUri",
@@ -33649,6 +34154,7 @@ export namespace discoveryengine_v1 {
33649
34154
  * // "llmEnabled": false,
33650
34155
  * // "minimumDataTermAccepted": false,
33651
34156
  * // "name": "my_name",
34157
+ * // "nodes": [],
33652
34158
  * // "resultDisplayType": "my_resultDisplayType",
33653
34159
  * // "solutionType": "my_solutionType",
33654
34160
  * // "uiBranding": {},
@@ -33838,6 +34344,7 @@ export namespace discoveryengine_v1 {
33838
34344
  * // "llmEnabled": false,
33839
34345
  * // "minimumDataTermAccepted": false,
33840
34346
  * // "name": "my_name",
34347
+ * // "nodes": [],
33841
34348
  * // "resultDisplayType": "my_resultDisplayType",
33842
34349
  * // "solutionType": "my_solutionType",
33843
34350
  * // "uiBranding": {},
@@ -33882,6 +34389,7 @@ export namespace discoveryengine_v1 {
33882
34389
  * // "llmEnabled": false,
33883
34390
  * // "minimumDataTermAccepted": false,
33884
34391
  * // "name": "my_name",
34392
+ * // "nodes": [],
33885
34393
  * // "resultDisplayType": "my_resultDisplayType",
33886
34394
  * // "solutionType": "my_solutionType",
33887
34395
  * // "uiBranding": {},
@@ -34128,9 +34636,11 @@ export namespace discoveryengine_v1 {
34128
34636
  * // "displayName": "my_displayName",
34129
34637
  * // "features": {},
34130
34638
  * // "industryVertical": "my_industryVertical",
34639
+ * // "knowledgeGraphConfig": {},
34131
34640
  * // "mediaRecommendationEngineConfig": {},
34132
34641
  * // "modelConfigs": {},
34133
34642
  * // "name": "my_name",
34643
+ * // "observabilityConfig": {},
34134
34644
  * // "searchEngineConfig": {},
34135
34645
  * // "solutionType": "my_solutionType",
34136
34646
  * // "updateTime": "my_updateTime"
@@ -34451,9 +34961,11 @@ export namespace discoveryengine_v1 {
34451
34961
  * // "displayName": "my_displayName",
34452
34962
  * // "features": {},
34453
34963
  * // "industryVertical": "my_industryVertical",
34964
+ * // "knowledgeGraphConfig": {},
34454
34965
  * // "mediaRecommendationEngineConfig": {},
34455
34966
  * // "modelConfigs": {},
34456
34967
  * // "name": "my_name",
34968
+ * // "observabilityConfig": {},
34457
34969
  * // "searchEngineConfig": {},
34458
34970
  * // "solutionType": "my_solutionType",
34459
34971
  * // "updateTime": "my_updateTime"
@@ -34782,9 +35294,11 @@ export namespace discoveryengine_v1 {
34782
35294
  * // "displayName": "my_displayName",
34783
35295
  * // "features": {},
34784
35296
  * // "industryVertical": "my_industryVertical",
35297
+ * // "knowledgeGraphConfig": {},
34785
35298
  * // "mediaRecommendationEngineConfig": {},
34786
35299
  * // "modelConfigs": {},
34787
35300
  * // "name": "my_name",
35301
+ * // "observabilityConfig": {},
34788
35302
  * // "searchEngineConfig": {},
34789
35303
  * // "solutionType": "my_solutionType",
34790
35304
  * // "updateTime": "my_updateTime"
@@ -34807,9 +35321,11 @@ export namespace discoveryengine_v1 {
34807
35321
  * // "displayName": "my_displayName",
34808
35322
  * // "features": {},
34809
35323
  * // "industryVertical": "my_industryVertical",
35324
+ * // "knowledgeGraphConfig": {},
34810
35325
  * // "mediaRecommendationEngineConfig": {},
34811
35326
  * // "modelConfigs": {},
34812
35327
  * // "name": "my_name",
35328
+ * // "observabilityConfig": {},
34813
35329
  * // "searchEngineConfig": {},
34814
35330
  * // "solutionType": "my_solutionType",
34815
35331
  * // "updateTime": "my_updateTime"
@@ -40211,6 +40727,7 @@ export namespace discoveryengine_v1 {
40211
40727
  * // "attributionToken": "my_attributionToken",
40212
40728
  * // "correctedQuery": "my_correctedQuery",
40213
40729
  * // "facets": [],
40730
+ * // "naturalLanguageQueryUnderstandingInfo": {},
40214
40731
  * // "nextPageToken": "my_nextPageToken",
40215
40732
  * // "queryExpansionInfo": {},
40216
40733
  * // "redirectUri": "my_redirectUri",
@@ -40419,6 +40936,7 @@ export namespace discoveryengine_v1 {
40419
40936
  * // "attributionToken": "my_attributionToken",
40420
40937
  * // "correctedQuery": "my_correctedQuery",
40421
40938
  * // "facets": [],
40939
+ * // "naturalLanguageQueryUnderstandingInfo": {},
40422
40940
  * // "nextPageToken": "my_nextPageToken",
40423
40941
  * // "queryExpansionInfo": {},
40424
40942
  * // "redirectUri": "my_redirectUri",
@@ -41997,6 +42515,7 @@ export namespace discoveryengine_v1 {
41997
42515
  * // "llmEnabled": false,
41998
42516
  * // "minimumDataTermAccepted": false,
41999
42517
  * // "name": "my_name",
42518
+ * // "nodes": [],
42000
42519
  * // "resultDisplayType": "my_resultDisplayType",
42001
42520
  * // "solutionType": "my_solutionType",
42002
42521
  * // "uiBranding": {},
@@ -42186,6 +42705,7 @@ export namespace discoveryengine_v1 {
42186
42705
  * // "llmEnabled": false,
42187
42706
  * // "minimumDataTermAccepted": false,
42188
42707
  * // "name": "my_name",
42708
+ * // "nodes": [],
42189
42709
  * // "resultDisplayType": "my_resultDisplayType",
42190
42710
  * // "solutionType": "my_solutionType",
42191
42711
  * // "uiBranding": {},
@@ -42230,6 +42750,7 @@ export namespace discoveryengine_v1 {
42230
42750
  * // "llmEnabled": false,
42231
42751
  * // "minimumDataTermAccepted": false,
42232
42752
  * // "name": "my_name",
42753
+ * // "nodes": [],
42233
42754
  * // "resultDisplayType": "my_resultDisplayType",
42234
42755
  * // "solutionType": "my_solutionType",
42235
42756
  * // "uiBranding": {},
@@ -51375,6 +51896,7 @@ export namespace discoveryengine_v1 {
51375
51896
  * // "attributionToken": "my_attributionToken",
51376
51897
  * // "correctedQuery": "my_correctedQuery",
51377
51898
  * // "facets": [],
51899
+ * // "naturalLanguageQueryUnderstandingInfo": {},
51378
51900
  * // "nextPageToken": "my_nextPageToken",
51379
51901
  * // "queryExpansionInfo": {},
51380
51902
  * // "redirectUri": "my_redirectUri",
@@ -51583,6 +52105,7 @@ export namespace discoveryengine_v1 {
51583
52105
  * // "attributionToken": "my_attributionToken",
51584
52106
  * // "correctedQuery": "my_correctedQuery",
51585
52107
  * // "facets": [],
52108
+ * // "naturalLanguageQueryUnderstandingInfo": {},
51586
52109
  * // "nextPageToken": "my_nextPageToken",
51587
52110
  * // "queryExpansionInfo": {},
51588
52111
  * // "redirectUri": "my_redirectUri",
@@ -56331,6 +56854,7 @@ export namespace discoveryengine_v1 {
56331
56854
  * // "llmEnabled": false,
56332
56855
  * // "minimumDataTermAccepted": false,
56333
56856
  * // "name": "my_name",
56857
+ * // "nodes": [],
56334
56858
  * // "resultDisplayType": "my_resultDisplayType",
56335
56859
  * // "solutionType": "my_solutionType",
56336
56860
  * // "uiBranding": {},
@@ -56519,6 +57043,7 @@ export namespace discoveryengine_v1 {
56519
57043
  * // "llmEnabled": false,
56520
57044
  * // "minimumDataTermAccepted": false,
56521
57045
  * // "name": "my_name",
57046
+ * // "nodes": [],
56522
57047
  * // "resultDisplayType": "my_resultDisplayType",
56523
57048
  * // "solutionType": "my_solutionType",
56524
57049
  * // "uiBranding": {},
@@ -56562,6 +57087,7 @@ export namespace discoveryengine_v1 {
56562
57087
  * // "llmEnabled": false,
56563
57088
  * // "minimumDataTermAccepted": false,
56564
57089
  * // "name": "my_name",
57090
+ * // "nodes": [],
56565
57091
  * // "resultDisplayType": "my_resultDisplayType",
56566
57092
  * // "solutionType": "my_solutionType",
56567
57093
  * // "uiBranding": {},