@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.
@@ -564,6 +564,19 @@ export declare namespace discoveryengine_v1alpha {
564
564
  */
565
565
  useStaticSecrets?: boolean | null;
566
566
  }
567
+ /**
568
+ * Request for DataStoreService.AddPatientFilter method.
569
+ */
570
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
571
+ /**
572
+ * 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.
573
+ */
574
+ dataStore?: string | null;
575
+ /**
576
+ * 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.
577
+ */
578
+ filterGroups?: string[] | null;
579
+ }
567
580
  /**
568
581
  * Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).
569
582
  */
@@ -624,7 +637,7 @@ export declare namespace discoveryengine_v1alpha {
624
637
  userPseudoId?: string | null;
625
638
  }
626
639
  /**
627
- * Specification to boost suggestions based on the condtion of the suggestion.
640
+ * Specification to boost suggestions based on the condition of the suggestion.
628
641
  */
629
642
  export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec {
630
643
  /**
@@ -985,6 +998,10 @@ export declare namespace discoveryengine_v1alpha {
985
998
  * The reason why the agent was suspended. Only set if the state is SUSPENDED.
986
999
  */
987
1000
  suspensionReason?: string | null;
1001
+ /**
1002
+ * Output only. The timestamp when the agent was last updated.
1003
+ */
1004
+ updateTime?: string | null;
988
1005
  /**
989
1006
  * Optional. Per-user annotations of the current caller for the agent.
990
1007
  */
@@ -1131,6 +1148,19 @@ export declare namespace discoveryengine_v1alpha {
1131
1148
  */
1132
1149
  tableId?: string | null;
1133
1150
  }
1151
+ /**
1152
+ * The customer controllable config for Analytics.
1153
+ */
1154
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig {
1155
+ /**
1156
+ * Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
1157
+ */
1158
+ name?: string | null;
1159
+ /**
1160
+ * Whether user-level metrics are enabled.
1161
+ */
1162
+ userLevelMetricsEnabled?: boolean | null;
1163
+ }
1134
1164
  /**
1135
1165
  * Defines an answer.
1136
1166
  */
@@ -2123,7 +2153,7 @@ export declare namespace discoveryengine_v1alpha {
2123
2153
  */
2124
2154
  groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
2125
2155
  /**
2126
- * 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.
2156
+ * 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.
2127
2157
  */
2128
2158
  replyId?: string | null;
2129
2159
  }
@@ -2511,7 +2541,7 @@ export declare namespace discoveryengine_v1alpha {
2511
2541
  */
2512
2542
  pkceVerificationEnabled?: boolean | null;
2513
2543
  /**
2514
- * Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
2544
+ * Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization.
2515
2545
  */
2516
2546
  scopes?: string[] | null;
2517
2547
  /**
@@ -2855,7 +2885,7 @@ export declare namespace discoveryengine_v1alpha {
2855
2885
  */
2856
2886
  export interface Schema$GoogleCloudDiscoveryengineV1alphaBranch {
2857
2887
  /**
2858
- * Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.
2888
+ * Output only. Statistics describing a branch. This field is not populated in BranchView.BRANCH_VIEW_BASIC view.
2859
2889
  */
2860
2890
  branchStats?: Schema$GoogleCloudDiscoveryengineV1alphaBranchBranchStats;
2861
2891
  /**
@@ -4551,6 +4581,15 @@ export declare namespace discoveryengine_v1alpha {
4551
4581
  */
4552
4582
  updateTime?: string | null;
4553
4583
  }
4584
+ /**
4585
+ * Request for DataStoreService.DeletePatientFilters method.
4586
+ */
4587
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest {
4588
+ /**
4589
+ * 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.
4590
+ */
4591
+ dataStore?: string | null;
4592
+ }
4554
4593
  /**
4555
4594
  * Metadata for DeleteSchema LRO.
4556
4595
  */
@@ -5055,7 +5094,7 @@ export declare namespace discoveryengine_v1alpha {
5055
5094
  */
5056
5095
  displayName?: string | null;
5057
5096
  /**
5058
- * 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`
5097
+ * 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`
5059
5098
  */
5060
5099
  features?: {
5061
5100
  [key: string]: string;
@@ -5064,6 +5103,10 @@ export declare namespace discoveryengine_v1alpha {
5064
5103
  * 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.
5065
5104
  */
5066
5105
  industryVertical?: string | null;
5106
+ /**
5107
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
5108
+ */
5109
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
5067
5110
  /**
5068
5111
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
5069
5112
  */
@@ -5078,6 +5121,10 @@ export declare namespace discoveryengine_v1alpha {
5078
5121
  * 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.
5079
5122
  */
5080
5123
  name?: string | null;
5124
+ /**
5125
+ * Optional. Observability config for the engine.
5126
+ */
5127
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1alphaObservabilityConfig;
5081
5128
  /**
5082
5129
  * Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
5083
5130
  */
@@ -5155,6 +5202,52 @@ export declare namespace discoveryengine_v1alpha {
5155
5202
  */
5156
5203
  companyName?: string | null;
5157
5204
  }
5205
+ /**
5206
+ * Configuration message for the Knowledge Graph.
5207
+ */
5208
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig {
5209
+ /**
5210
+ * Specify entity types to support.
5211
+ */
5212
+ cloudKnowledgeGraphTypes?: string[] | null;
5213
+ /**
5214
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
5215
+ */
5216
+ enableCloudKnowledgeGraph?: boolean | null;
5217
+ /**
5218
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
5219
+ */
5220
+ enablePrivateKnowledgeGraph?: boolean | null;
5221
+ /**
5222
+ * Optional. Feature config for the Knowledge Graph.
5223
+ */
5224
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig;
5225
+ /**
5226
+ * Specify entity types to support.
5227
+ */
5228
+ privateKnowledgeGraphTypes?: string[] | null;
5229
+ }
5230
+ /**
5231
+ * Feature config for the Knowledge Graph.
5232
+ */
5233
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig {
5234
+ /**
5235
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
5236
+ */
5237
+ disablePrivateKgAutoComplete?: boolean | null;
5238
+ /**
5239
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
5240
+ */
5241
+ disablePrivateKgEnrichment?: boolean | null;
5242
+ /**
5243
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
5244
+ */
5245
+ disablePrivateKgQueryUiChips?: boolean | null;
5246
+ /**
5247
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
5248
+ */
5249
+ disablePrivateKgQueryUnderstanding?: boolean | null;
5250
+ }
5158
5251
  /**
5159
5252
  * Additional config specs for a Media Recommendation engine.
5160
5253
  */
@@ -5822,6 +5915,10 @@ export declare namespace discoveryengine_v1alpha {
5822
5915
  * 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.
5823
5916
  */
5824
5917
  enableStaticIndexingForBatchIngestion?: boolean | null;
5918
+ /**
5919
+ * 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.
5920
+ */
5921
+ initialFilterGroups?: string[] | null;
5825
5922
  }
5826
5923
  /**
5827
5924
  * Identity Mapping Entry that maps an external identity to an internal identity.
@@ -6756,7 +6853,7 @@ export declare namespace discoveryengine_v1alpha {
6756
6853
  nextPageToken?: string | null;
6757
6854
  }
6758
6855
  /**
6759
- * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
6856
+ * Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
6760
6857
  */
6761
6858
  export interface Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse {
6762
6859
  /**
@@ -6911,6 +7008,19 @@ export declare namespace discoveryengine_v1alpha {
6911
7008
  */
6912
7009
  mode?: string | null;
6913
7010
  }
7011
+ /**
7012
+ * Observability config for a resource.
7013
+ */
7014
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaObservabilityConfig {
7015
+ /**
7016
+ * Optional. Enables observability. If false, all other flags are ignored.
7017
+ */
7018
+ observabilityEnabled?: boolean | null;
7019
+ /**
7020
+ * Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
7021
+ */
7022
+ sensitiveLoggingEnabled?: boolean | null;
7023
+ }
6914
7024
  /**
6915
7025
  * Request message for CrawlRateManagementService.ObtainCrawlRate method.
6916
7026
  */
@@ -7009,6 +7119,27 @@ export declare namespace discoveryengine_v1alpha {
7009
7119
  */
7010
7120
  totalPanels?: number | null;
7011
7121
  }
7122
+ /**
7123
+ * Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.
7124
+ */
7125
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata {
7126
+ /**
7127
+ * Operation create time.
7128
+ */
7129
+ createTime?: string | null;
7130
+ /**
7131
+ * The number of patient IDs added to the patient filter.
7132
+ */
7133
+ filtersAddedCount?: string | null;
7134
+ /**
7135
+ * The number of patient IDs removed from the patient filter.
7136
+ */
7137
+ filtersRemovedCount?: string | null;
7138
+ /**
7139
+ * Operation last update time. If the operation is done, this is also the finish time.
7140
+ */
7141
+ updateTime?: string | null;
7142
+ }
7012
7143
  /**
7013
7144
  * Request for pausing training of an engine.
7014
7145
  */
@@ -7087,10 +7218,22 @@ export declare namespace discoveryengine_v1alpha {
7087
7218
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
7088
7219
  */
7089
7220
  effectiveSearchQpmThreshold?: string | null;
7221
+ /**
7222
+ * 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.
7223
+ */
7224
+ indexingCoreThresholdNextUpdateTime?: string | null;
7225
+ /**
7226
+ * 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.
7227
+ */
7228
+ searchQpmThresholdNextUpdateTime?: string | null;
7090
7229
  /**
7091
7230
  * Optional. The start time of the currently active billing subscription.
7092
7231
  */
7093
7232
  startTime?: string | null;
7233
+ /**
7234
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
7235
+ */
7236
+ terminateTime?: string | null;
7094
7237
  }
7095
7238
  /**
7096
7239
  * Customer provided configurations.
@@ -7109,6 +7252,10 @@ export declare namespace discoveryengine_v1alpha {
7109
7252
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
7110
7253
  */
7111
7254
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
7255
+ /**
7256
+ * Optional. Observability config for NotebookLM.
7257
+ */
7258
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1alphaObservabilityConfig;
7112
7259
  /**
7113
7260
  * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
7114
7261
  */
@@ -7784,6 +7931,19 @@ export declare namespace discoveryengine_v1alpha {
7784
7931
  */
7785
7932
  state?: string | null;
7786
7933
  }
7934
+ /**
7935
+ * Request for DataStoreService.RemovePatientFilter method.
7936
+ */
7937
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest {
7938
+ /**
7939
+ * 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
7940
+ */
7941
+ dataStore?: string | null;
7942
+ /**
7943
+ * 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.
7944
+ */
7945
+ filterGroups?: string[] | null;
7946
+ }
7787
7947
  /**
7788
7948
  * Request message for CompletionService.RemoveSuggestion method.
7789
7949
  */
@@ -7814,6 +7974,19 @@ export declare namespace discoveryengine_v1alpha {
7814
7974
  */
7815
7975
  export interface Schema$GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse {
7816
7976
  }
7977
+ /**
7978
+ * Request for DataStoreService.ReplacePatientFilter method.
7979
+ */
7980
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest {
7981
+ /**
7982
+ * 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.
7983
+ */
7984
+ dataStore?: string | null;
7985
+ /**
7986
+ * 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.
7987
+ */
7988
+ filterGroups?: string[] | null;
7989
+ }
7817
7990
  /**
7818
7991
  * Defines a reply message to user.
7819
7992
  */
@@ -8248,7 +8421,7 @@ export declare namespace discoveryengine_v1alpha {
8248
8421
  */
8249
8422
  orderBy?: string | null;
8250
8423
  /**
8251
- * 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`
8424
+ * 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`
8252
8425
  */
8253
8426
  pageCategories?: string[] | null;
8254
8427
  /**
@@ -8705,7 +8878,7 @@ export declare namespace discoveryengine_v1alpha {
8705
8878
  */
8706
8879
  allowedFieldNames?: string[] | null;
8707
8880
  /**
8708
- * 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.
8881
+ * 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.
8709
8882
  */
8710
8883
  extractedFilterBehavior?: string | null;
8711
8884
  /**
@@ -8848,7 +9021,7 @@ export declare namespace discoveryengine_v1alpha {
8848
9021
  */
8849
9022
  guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult;
8850
9023
  /**
8851
- * Natural language query understanding information for the returned results.
9024
+ * Output only. Natural language query understanding information for the returned results.
8852
9025
  */
8853
9026
  naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo;
8854
9027
  /**
@@ -10554,6 +10727,10 @@ export declare namespace discoveryengine_v1alpha {
10554
10727
  * 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.
10555
10728
  */
10556
10729
  name?: string | null;
10730
+ /**
10731
+ * Output only. The nodes associated with the Widget Config.
10732
+ */
10733
+ nodes?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigNode[];
10557
10734
  /**
10558
10735
  * 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.
10559
10736
  */
@@ -10650,7 +10827,7 @@ export declare namespace discoveryengine_v1alpha {
10650
10827
  */
10651
10828
  id?: string | null;
10652
10829
  /**
10653
- * 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.
10830
+ * 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.
10654
10831
  */
10655
10832
  name?: string | null;
10656
10833
  }
@@ -10688,7 +10865,7 @@ export declare namespace discoveryengine_v1alpha {
10688
10865
  */
10689
10866
  id?: string | null;
10690
10867
  /**
10691
- * 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.
10868
+ * 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.
10692
10869
  */
10693
10870
  name?: string | null;
10694
10871
  /**
@@ -10715,7 +10892,7 @@ export declare namespace discoveryengine_v1alpha {
10715
10892
  */
10716
10893
  id?: string | null;
10717
10894
  /**
10718
- * 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.
10895
+ * 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.
10719
10896
  */
10720
10897
  name?: string | null;
10721
10898
  }
@@ -10767,6 +10944,39 @@ export declare namespace discoveryengine_v1alpha {
10767
10944
  */
10768
10945
  url?: string | null;
10769
10946
  }
10947
+ /**
10948
+ * Represents a single reusable computational or logical unit.
10949
+ */
10950
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigNode {
10951
+ /**
10952
+ * Output only. A detailed description of what the node does.
10953
+ */
10954
+ description?: string | null;
10955
+ /**
10956
+ * Output only. A human readable name for the node.
10957
+ */
10958
+ displayName?: string | null;
10959
+ /**
10960
+ * Output only. An identifier or URL pointing to an icon representing this node type.
10961
+ */
10962
+ iconUrl?: string | null;
10963
+ /**
10964
+ * 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.
10965
+ */
10966
+ outputSchema?: {
10967
+ [key: string]: any;
10968
+ } | null;
10969
+ /**
10970
+ * 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.
10971
+ */
10972
+ parameterSchema?: {
10973
+ [key: string]: any;
10974
+ } | null;
10975
+ /**
10976
+ * Output only. The type of the node.
10977
+ */
10978
+ type?: string | null;
10979
+ }
10770
10980
  /**
10771
10981
  * Describes widget UI branding settings.
10772
10982
  */
@@ -10838,7 +11048,7 @@ export declare namespace discoveryengine_v1alpha {
10838
11048
  */
10839
11049
  enableVisualContentSummary?: boolean | null;
10840
11050
  /**
10841
- * 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`
11051
+ * 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`
10842
11052
  */
10843
11053
  features?: {
10844
11054
  [key: string]: string;
@@ -12036,7 +12246,7 @@ export declare namespace discoveryengine_v1alpha {
12036
12246
  */
12037
12247
  displayName?: string | null;
12038
12248
  /**
12039
- * 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`
12249
+ * 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`
12040
12250
  */
12041
12251
  features?: {
12042
12252
  [key: string]: string;
@@ -12045,6 +12255,10 @@ export declare namespace discoveryengine_v1alpha {
12045
12255
  * 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.
12046
12256
  */
12047
12257
  industryVertical?: string | null;
12258
+ /**
12259
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
12260
+ */
12261
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
12048
12262
  /**
12049
12263
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
12050
12264
  */
@@ -12059,6 +12273,10 @@ export declare namespace discoveryengine_v1alpha {
12059
12273
  * 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.
12060
12274
  */
12061
12275
  name?: string | null;
12276
+ /**
12277
+ * Optional. Observability config for the engine.
12278
+ */
12279
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1betaObservabilityConfig;
12062
12280
  /**
12063
12281
  * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
12064
12282
  */
@@ -12128,6 +12346,52 @@ export declare namespace discoveryengine_v1alpha {
12128
12346
  */
12129
12347
  companyName?: string | null;
12130
12348
  }
12349
+ /**
12350
+ * Configuration message for the Knowledge Graph.
12351
+ */
12352
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig {
12353
+ /**
12354
+ * Specify entity types to support.
12355
+ */
12356
+ cloudKnowledgeGraphTypes?: string[] | null;
12357
+ /**
12358
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
12359
+ */
12360
+ enableCloudKnowledgeGraph?: boolean | null;
12361
+ /**
12362
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
12363
+ */
12364
+ enablePrivateKnowledgeGraph?: boolean | null;
12365
+ /**
12366
+ * Optional. Feature config for the Knowledge Graph.
12367
+ */
12368
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig;
12369
+ /**
12370
+ * Specify entity types to support.
12371
+ */
12372
+ privateKnowledgeGraphTypes?: string[] | null;
12373
+ }
12374
+ /**
12375
+ * Feature config for the Knowledge Graph.
12376
+ */
12377
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig {
12378
+ /**
12379
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
12380
+ */
12381
+ disablePrivateKgAutoComplete?: boolean | null;
12382
+ /**
12383
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
12384
+ */
12385
+ disablePrivateKgEnrichment?: boolean | null;
12386
+ /**
12387
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
12388
+ */
12389
+ disablePrivateKgQueryUiChips?: boolean | null;
12390
+ /**
12391
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
12392
+ */
12393
+ disablePrivateKgQueryUnderstanding?: boolean | null;
12394
+ }
12131
12395
  /**
12132
12396
  * Additional config specs for a Media Recommendation engine.
12133
12397
  */
@@ -12285,6 +12549,10 @@ export declare namespace discoveryengine_v1alpha {
12285
12549
  * 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.
12286
12550
  */
12287
12551
  enableStaticIndexingForBatchIngestion?: boolean | null;
12552
+ /**
12553
+ * 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.
12554
+ */
12555
+ initialFilterGroups?: string[] | null;
12288
12556
  }
12289
12557
  /**
12290
12558
  * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
@@ -12621,6 +12889,19 @@ export declare namespace discoveryengine_v1alpha {
12621
12889
  */
12622
12890
  mode?: string | null;
12623
12891
  }
12892
+ /**
12893
+ * Observability config for a resource.
12894
+ */
12895
+ export interface Schema$GoogleCloudDiscoveryengineV1betaObservabilityConfig {
12896
+ /**
12897
+ * Optional. Enables observability. If false, all other flags are ignored.
12898
+ */
12899
+ observabilityEnabled?: boolean | null;
12900
+ /**
12901
+ * Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
12902
+ */
12903
+ sensitiveLoggingEnabled?: boolean | null;
12904
+ }
12624
12905
  /**
12625
12906
  * 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.
12626
12907
  */
@@ -12698,10 +12979,22 @@ export declare namespace discoveryengine_v1alpha {
12698
12979
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
12699
12980
  */
12700
12981
  effectiveSearchQpmThreshold?: string | null;
12982
+ /**
12983
+ * 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.
12984
+ */
12985
+ indexingCoreThresholdNextUpdateTime?: string | null;
12986
+ /**
12987
+ * 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.
12988
+ */
12989
+ searchQpmThresholdNextUpdateTime?: string | null;
12701
12990
  /**
12702
12991
  * Optional. The start time of the currently active billing subscription.
12703
12992
  */
12704
12993
  startTime?: string | null;
12994
+ /**
12995
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
12996
+ */
12997
+ terminateTime?: string | null;
12705
12998
  }
12706
12999
  /**
12707
13000
  * Customer provided configurations.
@@ -12720,6 +13013,10 @@ export declare namespace discoveryengine_v1alpha {
12720
13013
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
12721
13014
  */
12722
13015
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
13016
+ /**
13017
+ * Optional. Observability config for NotebookLM.
13018
+ */
13019
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1betaObservabilityConfig;
12723
13020
  /**
12724
13021
  * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
12725
13022
  */
@@ -13021,7 +13318,7 @@ export declare namespace discoveryengine_v1alpha {
13021
13318
  */
13022
13319
  orderBy?: string | null;
13023
13320
  /**
13024
- * 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`
13321
+ * 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`
13025
13322
  */
13026
13323
  pageCategories?: string[] | null;
13027
13324
  /**
@@ -13474,7 +13771,7 @@ export declare namespace discoveryengine_v1alpha {
13474
13771
  */
13475
13772
  allowedFieldNames?: string[] | null;
13476
13773
  /**
13477
- * 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.
13774
+ * 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.
13478
13775
  */
13479
13776
  extractedFilterBehavior?: string | null;
13480
13777
  /**
@@ -14954,7 +15251,7 @@ export declare namespace discoveryengine_v1alpha {
14954
15251
  */
14955
15252
  displayName?: string | null;
14956
15253
  /**
14957
- * 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`
15254
+ * 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`
14958
15255
  */
14959
15256
  features?: {
14960
15257
  [key: string]: string;
@@ -14963,6 +15260,10 @@ export declare namespace discoveryengine_v1alpha {
14963
15260
  * 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.
14964
15261
  */
14965
15262
  industryVertical?: string | null;
15263
+ /**
15264
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
15265
+ */
15266
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
14966
15267
  /**
14967
15268
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
14968
15269
  */
@@ -14977,6 +15278,10 @@ export declare namespace discoveryengine_v1alpha {
14977
15278
  * 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.
14978
15279
  */
14979
15280
  name?: string | null;
15281
+ /**
15282
+ * Optional. Observability config for the engine.
15283
+ */
15284
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1ObservabilityConfig;
14980
15285
  /**
14981
15286
  * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
14982
15287
  */
@@ -15046,6 +15351,52 @@ export declare namespace discoveryengine_v1alpha {
15046
15351
  */
15047
15352
  companyName?: string | null;
15048
15353
  }
15354
+ /**
15355
+ * Configuration message for the Knowledge Graph.
15356
+ */
15357
+ export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig {
15358
+ /**
15359
+ * Specify entity types to support.
15360
+ */
15361
+ cloudKnowledgeGraphTypes?: string[] | null;
15362
+ /**
15363
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
15364
+ */
15365
+ enableCloudKnowledgeGraph?: boolean | null;
15366
+ /**
15367
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
15368
+ */
15369
+ enablePrivateKnowledgeGraph?: boolean | null;
15370
+ /**
15371
+ * Optional. Feature config for the Knowledge Graph.
15372
+ */
15373
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig;
15374
+ /**
15375
+ * Specify entity types to support.
15376
+ */
15377
+ privateKnowledgeGraphTypes?: string[] | null;
15378
+ }
15379
+ /**
15380
+ * Feature config for the Knowledge Graph.
15381
+ */
15382
+ export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig {
15383
+ /**
15384
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
15385
+ */
15386
+ disablePrivateKgAutoComplete?: boolean | null;
15387
+ /**
15388
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
15389
+ */
15390
+ disablePrivateKgEnrichment?: boolean | null;
15391
+ /**
15392
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
15393
+ */
15394
+ disablePrivateKgQueryUiChips?: boolean | null;
15395
+ /**
15396
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
15397
+ */
15398
+ disablePrivateKgQueryUnderstanding?: boolean | null;
15399
+ }
15049
15400
  /**
15050
15401
  * Additional config specs for a Media Recommendation engine.
15051
15402
  */
@@ -15144,6 +15495,10 @@ export declare namespace discoveryengine_v1alpha {
15144
15495
  * 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.
15145
15496
  */
15146
15497
  enableStaticIndexingForBatchIngestion?: boolean | null;
15498
+ /**
15499
+ * 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.
15500
+ */
15501
+ initialFilterGroups?: string[] | null;
15147
15502
  }
15148
15503
  /**
15149
15504
  * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
@@ -15413,6 +15768,19 @@ export declare namespace discoveryengine_v1alpha {
15413
15768
  */
15414
15769
  mode?: string | null;
15415
15770
  }
15771
+ /**
15772
+ * Observability config for a resource.
15773
+ */
15774
+ export interface Schema$GoogleCloudDiscoveryengineV1ObservabilityConfig {
15775
+ /**
15776
+ * Optional. Enables observability. If false, all other flags are ignored.
15777
+ */
15778
+ observabilityEnabled?: boolean | null;
15779
+ /**
15780
+ * Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
15781
+ */
15782
+ sensitiveLoggingEnabled?: boolean | null;
15783
+ }
15416
15784
  /**
15417
15785
  * Metadata and configurations for a Google Cloud project in the service.
15418
15786
  */
@@ -15456,10 +15824,22 @@ export declare namespace discoveryengine_v1alpha {
15456
15824
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
15457
15825
  */
15458
15826
  effectiveSearchQpmThreshold?: string | null;
15827
+ /**
15828
+ * 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.
15829
+ */
15830
+ indexingCoreThresholdNextUpdateTime?: string | null;
15831
+ /**
15832
+ * 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.
15833
+ */
15834
+ searchQpmThresholdNextUpdateTime?: string | null;
15459
15835
  /**
15460
15836
  * Optional. The start time of the currently active billing subscription.
15461
15837
  */
15462
15838
  startTime?: string | null;
15839
+ /**
15840
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
15841
+ */
15842
+ terminateTime?: string | null;
15463
15843
  }
15464
15844
  /**
15465
15845
  * Customer provided configurations.
@@ -15478,6 +15858,10 @@ export declare namespace discoveryengine_v1alpha {
15478
15858
  * Model Armor configuration to be used for sanitizing user prompts and LLM responses.
15479
15859
  */
15480
15860
  modelArmorConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfigModelArmorConfig;
15861
+ /**
15862
+ * Optional. Observability config for NotebookLM.
15863
+ */
15864
+ observabilityConfig?: Schema$GoogleCloudDiscoveryengineV1ObservabilityConfig;
15481
15865
  /**
15482
15866
  * Optional. Whether to disable the notebook sharing feature for the project. Default to false if not specified.
15483
15867
  */
@@ -16308,7 +16692,7 @@ export declare namespace discoveryengine_v1alpha {
16308
16692
  names?: string[] | null;
16309
16693
  }
16310
16694
  /**
16311
- * Request for SourceService.BatchDeleteSourcesRequest method.
16695
+ * Request for BatchDeleteSourcesRequest method.
16312
16696
  */
16313
16697
  export interface Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest {
16314
16698
  /**
@@ -16363,10 +16747,18 @@ export declare namespace discoveryengine_v1alpha {
16363
16747
  * Indicates an error occurred while ingesting the source.
16364
16748
  */
16365
16749
  ingestionError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError;
16750
+ /**
16751
+ * Indicates that the source MIME type is blocked.
16752
+ */
16753
+ mimeTypeBlocked?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked;
16366
16754
  /**
16367
16755
  * Indicates that the source is paywalled and cannot be ingested.
16368
16756
  */
16369
16757
  paywallError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError;
16758
+ /**
16759
+ * Indicates that the policy check failed.
16760
+ */
16761
+ policyCheckFailed?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed;
16370
16762
  /**
16371
16763
  * Indicates that the source is empty.
16372
16764
  */
@@ -16443,11 +16835,21 @@ export declare namespace discoveryengine_v1alpha {
16443
16835
  */
16444
16836
  export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError {
16445
16837
  }
16838
+ /**
16839
+ * Indicates that the source MIME type is blocked.
16840
+ */
16841
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked {
16842
+ }
16446
16843
  /**
16447
16844
  * Indicates that the source is paywalled and cannot be ingested.
16448
16845
  */
16449
16846
  export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError {
16450
16847
  }
16848
+ /**
16849
+ * Indicates that the policy check failed.
16850
+ */
16851
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed {
16852
+ }
16451
16853
  /**
16452
16854
  * Indicates that the source is empty.
16453
16855
  */
@@ -17541,7 +17943,7 @@ export declare namespace discoveryengine_v1alpha {
17541
17943
  * const res = await discoveryengine.projects.patch({
17542
17944
  * // Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.
17543
17945
  * name: 'projects/my-project',
17544
- * // Optional. The list of fields to update. Supported fields: * `customer_provided_config`
17946
+ * // Optional. The list of fields to update. Supported fields: * `customer_provided_config` * `customer_provided_config.notebooklm_config.observability_config`
17545
17947
  * updateMask: 'placeholder-value',
17546
17948
  *
17547
17949
  * // Request body metadata
@@ -17756,7 +18158,7 @@ export declare namespace discoveryengine_v1alpha {
17756
18158
  */
17757
18159
  name?: string;
17758
18160
  /**
17759
- * Optional. The list of fields to update. Supported fields: * `customer_provided_config`
18161
+ * Optional. The list of fields to update. Supported fields: * `customer_provided_config` * `customer_provided_config.notebooklm_config.observability_config`
17760
18162
  */
17761
18163
  updateMask?: string;
17762
18164
  /**
@@ -20782,7 +21184,7 @@ export declare namespace discoveryengine_v1alpha {
20782
21184
  widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs;
20783
21185
  constructor(context: APIRequestContext);
20784
21186
  /**
20785
- * Completes the specified user input with keyword suggestions.
21187
+ * Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. 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.
20786
21188
  * @example
20787
21189
  * ```js
20788
21190
  * // Before running the sample:
@@ -20805,7 +21207,6 @@ export declare namespace discoveryengine_v1alpha {
20805
21207
  * // Scopes can be specified either as an array or as a single, space-delimited string.
20806
21208
  * scopes: [
20807
21209
  * 'https://www.googleapis.com/auth/cloud-platform',
20808
- * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
20809
21210
  * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
20810
21211
  * ],
20811
21212
  * });
@@ -20816,27 +21217,31 @@ export declare namespace discoveryengine_v1alpha {
20816
21217
  *
20817
21218
  * // Do the magic
20818
21219
  * const res =
20819
- * await discoveryengine.projects.locations.collections.dataStores.completeQuery(
21220
+ * await discoveryengine.projects.locations.collections.dataStores.addPatientFilter(
20820
21221
  * {
20821
- * // Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`.
21222
+ * // 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.
20822
21223
  * dataStore:
20823
21224
  * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
20824
- * // Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
20825
- * includeTailSuggestions: 'placeholder-value',
20826
- * // Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
20827
- * query: 'placeholder-value',
20828
- * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
20829
- * queryModel: 'placeholder-value',
20830
- * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
20831
- * userPseudoId: 'placeholder-value',
21225
+ *
21226
+ * // Request body metadata
21227
+ * requestBody: {
21228
+ * // request body parameters
21229
+ * // {
21230
+ * // "dataStore": "my_dataStore",
21231
+ * // "filterGroups": []
21232
+ * // }
21233
+ * },
20832
21234
  * },
20833
21235
  * );
20834
21236
  * console.log(res.data);
20835
21237
  *
20836
21238
  * // Example response
20837
21239
  * // {
20838
- * // "querySuggestions": [],
20839
- * // "tailMatchTriggered": false
21240
+ * // "done": false,
21241
+ * // "error": {},
21242
+ * // "metadata": {},
21243
+ * // "name": "my_name",
21244
+ * // "response": {}
20840
21245
  * // }
20841
21246
  * }
20842
21247
  *
@@ -20852,14 +21257,91 @@ export declare namespace discoveryengine_v1alpha {
20852
21257
  * @param callback - Optional callback that handles the response.
20853
21258
  * @returns A promise if used with async/await, or void if used with a callback.
20854
21259
  */
20855
- completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
20856
- completeQuery(params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>>;
20857
- completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
20858
- completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
20859
- completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
20860
- completeQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
21260
+ addPatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
21261
+ addPatientFilter(params?: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
21262
+ addPatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
21263
+ addPatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21264
+ addPatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21265
+ addPatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
20861
21266
  /**
20862
- * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
21267
+ * Completes the specified user input with keyword suggestions.
21268
+ * @example
21269
+ * ```js
21270
+ * // Before running the sample:
21271
+ * // - Enable the API at:
21272
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
21273
+ * // - Login into gcloud by running:
21274
+ * // ```sh
21275
+ * // $ gcloud auth application-default login
21276
+ * // ```
21277
+ * // - Install the npm module by running:
21278
+ * // ```sh
21279
+ * // $ npm install googleapis
21280
+ * // ```
21281
+ *
21282
+ * const {google} = require('googleapis');
21283
+ * const discoveryengine = google.discoveryengine('v1alpha');
21284
+ *
21285
+ * async function main() {
21286
+ * const auth = new google.auth.GoogleAuth({
21287
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
21288
+ * scopes: [
21289
+ * 'https://www.googleapis.com/auth/cloud-platform',
21290
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
21291
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
21292
+ * ],
21293
+ * });
21294
+ *
21295
+ * // Acquire an auth client, and bind it to all future calls
21296
+ * const authClient = await auth.getClient();
21297
+ * google.options({auth: authClient});
21298
+ *
21299
+ * // Do the magic
21300
+ * const res =
21301
+ * await discoveryengine.projects.locations.collections.dataStores.completeQuery(
21302
+ * {
21303
+ * // Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`.
21304
+ * dataStore:
21305
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
21306
+ * // Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
21307
+ * includeTailSuggestions: 'placeholder-value',
21308
+ * // Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
21309
+ * query: 'placeholder-value',
21310
+ * // Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
21311
+ * queryModel: 'placeholder-value',
21312
+ * // Optional. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
21313
+ * userPseudoId: 'placeholder-value',
21314
+ * },
21315
+ * );
21316
+ * console.log(res.data);
21317
+ *
21318
+ * // Example response
21319
+ * // {
21320
+ * // "querySuggestions": [],
21321
+ * // "tailMatchTriggered": false
21322
+ * // }
21323
+ * }
21324
+ *
21325
+ * main().catch(e => {
21326
+ * console.error(e);
21327
+ * throw e;
21328
+ * });
21329
+ *
21330
+ * ```
21331
+ *
21332
+ * @param params - Parameters for request
21333
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
21334
+ * @param callback - Optional callback that handles the response.
21335
+ * @returns A promise if used with async/await, or void if used with a callback.
21336
+ */
21337
+ completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
21338
+ completeQuery(params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>>;
21339
+ completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
21340
+ completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
21341
+ completeQuery(params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
21342
+ completeQuery(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>): void;
21343
+ /**
21344
+ * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.
20863
21345
  * @example
20864
21346
  * ```js
20865
21347
  * // Before running the sample:
@@ -21038,6 +21520,85 @@ export declare namespace discoveryengine_v1alpha {
21038
21520
  delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21039
21521
  delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21040
21522
  delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21523
+ /**
21524
+ * Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.
21525
+ * @example
21526
+ * ```js
21527
+ * // Before running the sample:
21528
+ * // - Enable the API at:
21529
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
21530
+ * // - Login into gcloud by running:
21531
+ * // ```sh
21532
+ * // $ gcloud auth application-default login
21533
+ * // ```
21534
+ * // - Install the npm module by running:
21535
+ * // ```sh
21536
+ * // $ npm install googleapis
21537
+ * // ```
21538
+ *
21539
+ * const {google} = require('googleapis');
21540
+ * const discoveryengine = google.discoveryengine('v1alpha');
21541
+ *
21542
+ * async function main() {
21543
+ * const auth = new google.auth.GoogleAuth({
21544
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
21545
+ * scopes: [
21546
+ * 'https://www.googleapis.com/auth/cloud-platform',
21547
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
21548
+ * ],
21549
+ * });
21550
+ *
21551
+ * // Acquire an auth client, and bind it to all future calls
21552
+ * const authClient = await auth.getClient();
21553
+ * google.options({auth: authClient});
21554
+ *
21555
+ * // Do the magic
21556
+ * const res =
21557
+ * await discoveryengine.projects.locations.collections.dataStores.deletePatientFilter(
21558
+ * {
21559
+ * // 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.
21560
+ * dataStore:
21561
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
21562
+ *
21563
+ * // Request body metadata
21564
+ * requestBody: {
21565
+ * // request body parameters
21566
+ * // {
21567
+ * // "dataStore": "my_dataStore"
21568
+ * // }
21569
+ * },
21570
+ * },
21571
+ * );
21572
+ * console.log(res.data);
21573
+ *
21574
+ * // Example response
21575
+ * // {
21576
+ * // "done": false,
21577
+ * // "error": {},
21578
+ * // "metadata": {},
21579
+ * // "name": "my_name",
21580
+ * // "response": {}
21581
+ * // }
21582
+ * }
21583
+ *
21584
+ * main().catch(e => {
21585
+ * console.error(e);
21586
+ * throw e;
21587
+ * });
21588
+ *
21589
+ * ```
21590
+ *
21591
+ * @param params - Parameters for request
21592
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
21593
+ * @param callback - Optional callback that handles the response.
21594
+ * @returns A promise if used with async/await, or void if used with a callback.
21595
+ */
21596
+ deletePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
21597
+ deletePatientFilter(params?: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
21598
+ deletePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
21599
+ deletePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21600
+ deletePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21601
+ deletePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21041
21602
  /**
21042
21603
  * Gets a DataStore.
21043
21604
  * @example
@@ -21453,6 +22014,166 @@ export declare namespace discoveryengine_v1alpha {
21453
22014
  patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
21454
22015
  patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
21455
22016
  patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
22017
+ /**
22018
+ * Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.
22019
+ * @example
22020
+ * ```js
22021
+ * // Before running the sample:
22022
+ * // - Enable the API at:
22023
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
22024
+ * // - Login into gcloud by running:
22025
+ * // ```sh
22026
+ * // $ gcloud auth application-default login
22027
+ * // ```
22028
+ * // - Install the npm module by running:
22029
+ * // ```sh
22030
+ * // $ npm install googleapis
22031
+ * // ```
22032
+ *
22033
+ * const {google} = require('googleapis');
22034
+ * const discoveryengine = google.discoveryengine('v1alpha');
22035
+ *
22036
+ * async function main() {
22037
+ * const auth = new google.auth.GoogleAuth({
22038
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
22039
+ * scopes: [
22040
+ * 'https://www.googleapis.com/auth/cloud-platform',
22041
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
22042
+ * ],
22043
+ * });
22044
+ *
22045
+ * // Acquire an auth client, and bind it to all future calls
22046
+ * const authClient = await auth.getClient();
22047
+ * google.options({auth: authClient});
22048
+ *
22049
+ * // Do the magic
22050
+ * const res =
22051
+ * await discoveryengine.projects.locations.collections.dataStores.removePatientFilter(
22052
+ * {
22053
+ * // 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
22054
+ * dataStore:
22055
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
22056
+ *
22057
+ * // Request body metadata
22058
+ * requestBody: {
22059
+ * // request body parameters
22060
+ * // {
22061
+ * // "dataStore": "my_dataStore",
22062
+ * // "filterGroups": []
22063
+ * // }
22064
+ * },
22065
+ * },
22066
+ * );
22067
+ * console.log(res.data);
22068
+ *
22069
+ * // Example response
22070
+ * // {
22071
+ * // "done": false,
22072
+ * // "error": {},
22073
+ * // "metadata": {},
22074
+ * // "name": "my_name",
22075
+ * // "response": {}
22076
+ * // }
22077
+ * }
22078
+ *
22079
+ * main().catch(e => {
22080
+ * console.error(e);
22081
+ * throw e;
22082
+ * });
22083
+ *
22084
+ * ```
22085
+ *
22086
+ * @param params - Parameters for request
22087
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
22088
+ * @param callback - Optional callback that handles the response.
22089
+ * @returns A promise if used with async/await, or void if used with a callback.
22090
+ */
22091
+ removePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
22092
+ removePatientFilter(params?: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
22093
+ removePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
22094
+ removePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
22095
+ removePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
22096
+ removePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
22097
+ /**
22098
+ * Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. 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.
22099
+ * @example
22100
+ * ```js
22101
+ * // Before running the sample:
22102
+ * // - Enable the API at:
22103
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
22104
+ * // - Login into gcloud by running:
22105
+ * // ```sh
22106
+ * // $ gcloud auth application-default login
22107
+ * // ```
22108
+ * // - Install the npm module by running:
22109
+ * // ```sh
22110
+ * // $ npm install googleapis
22111
+ * // ```
22112
+ *
22113
+ * const {google} = require('googleapis');
22114
+ * const discoveryengine = google.discoveryengine('v1alpha');
22115
+ *
22116
+ * async function main() {
22117
+ * const auth = new google.auth.GoogleAuth({
22118
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
22119
+ * scopes: [
22120
+ * 'https://www.googleapis.com/auth/cloud-platform',
22121
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
22122
+ * ],
22123
+ * });
22124
+ *
22125
+ * // Acquire an auth client, and bind it to all future calls
22126
+ * const authClient = await auth.getClient();
22127
+ * google.options({auth: authClient});
22128
+ *
22129
+ * // Do the magic
22130
+ * const res =
22131
+ * await discoveryengine.projects.locations.collections.dataStores.replacePatientFilter(
22132
+ * {
22133
+ * // 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.
22134
+ * dataStore:
22135
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
22136
+ *
22137
+ * // Request body metadata
22138
+ * requestBody: {
22139
+ * // request body parameters
22140
+ * // {
22141
+ * // "dataStore": "my_dataStore",
22142
+ * // "filterGroups": []
22143
+ * // }
22144
+ * },
22145
+ * },
22146
+ * );
22147
+ * console.log(res.data);
22148
+ *
22149
+ * // Example response
22150
+ * // {
22151
+ * // "done": false,
22152
+ * // "error": {},
22153
+ * // "metadata": {},
22154
+ * // "name": "my_name",
22155
+ * // "response": {}
22156
+ * // }
22157
+ * }
22158
+ *
22159
+ * main().catch(e => {
22160
+ * console.error(e);
22161
+ * throw e;
22162
+ * });
22163
+ *
22164
+ * ```
22165
+ *
22166
+ * @param params - Parameters for request
22167
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
22168
+ * @param callback - Optional callback that handles the response.
22169
+ * @returns A promise if used with async/await, or void if used with a callback.
22170
+ */
22171
+ replacePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
22172
+ replacePatientFilter(params?: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
22173
+ replacePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
22174
+ replacePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
22175
+ replacePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
22176
+ replacePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
21456
22177
  /**
21457
22178
  * Trains a custom model.
21458
22179
  * @example
@@ -21618,6 +22339,16 @@ export declare namespace discoveryengine_v1alpha {
21618
22339
  updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
21619
22340
  updateDocumentProcessingConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
21620
22341
  }
22342
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter extends StandardParameters {
22343
+ /**
22344
+ * 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.
22345
+ */
22346
+ dataStore?: string;
22347
+ /**
22348
+ * Request body metadata
22349
+ */
22350
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest;
22351
+ }
21621
22352
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
21622
22353
  /**
21623
22354
  * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`.
@@ -21676,6 +22407,16 @@ export declare namespace discoveryengine_v1alpha {
21676
22407
  */
21677
22408
  name?: string;
21678
22409
  }
22410
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter extends StandardParameters {
22411
+ /**
22412
+ * 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.
22413
+ */
22414
+ dataStore?: string;
22415
+ /**
22416
+ * Request body metadata
22417
+ */
22418
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest;
22419
+ }
21679
22420
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Get extends StandardParameters {
21680
22421
  /**
21681
22422
  * 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.
@@ -21726,6 +22467,26 @@ export declare namespace discoveryengine_v1alpha {
21726
22467
  */
21727
22468
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
21728
22469
  }
22470
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter extends StandardParameters {
22471
+ /**
22472
+ * 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
22473
+ */
22474
+ dataStore?: string;
22475
+ /**
22476
+ * Request body metadata
22477
+ */
22478
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest;
22479
+ }
22480
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter extends StandardParameters {
22481
+ /**
22482
+ * 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.
22483
+ */
22484
+ dataStore?: string;
22485
+ /**
22486
+ * Request body metadata
22487
+ */
22488
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest;
22489
+ }
21729
22490
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel extends StandardParameters {
21730
22491
  /**
21731
22492
  * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.
@@ -21864,7 +22625,7 @@ export declare namespace discoveryengine_v1alpha {
21864
22625
  * {
21865
22626
  * // Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document.
21866
22627
  * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche',
21867
- * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
22628
+ * // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
21868
22629
  * view: 'placeholder-value',
21869
22630
  * },
21870
22631
  * );
@@ -21937,7 +22698,7 @@ export declare namespace discoveryengine_v1alpha {
21937
22698
  * // Required. The parent data store resource name.
21938
22699
  * parent:
21939
22700
  * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
21940
- * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
22701
+ * // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
21941
22702
  * view: 'placeholder-value',
21942
22703
  * },
21943
22704
  * );
@@ -21988,7 +22749,7 @@ export declare namespace discoveryengine_v1alpha {
21988
22749
  */
21989
22750
  name?: string;
21990
22751
  /**
21991
- * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
22752
+ * The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
21992
22753
  */
21993
22754
  view?: string;
21994
22755
  }
@@ -21998,7 +22759,7 @@ export declare namespace discoveryengine_v1alpha {
21998
22759
  */
21999
22760
  parent?: string;
22000
22761
  /**
22001
- * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
22762
+ * The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
22002
22763
  */
22003
22764
  view?: string;
22004
22765
  }
@@ -29634,6 +30395,7 @@ export declare namespace discoveryengine_v1alpha {
29634
30395
  * // "llmEnabled": false,
29635
30396
  * // "minimumDataTermAccepted": false,
29636
30397
  * // "name": "my_name",
30398
+ * // "nodes": [],
29637
30399
  * // "resultDisplayType": "my_resultDisplayType",
29638
30400
  * // "solutionType": "my_solutionType",
29639
30401
  * // "uiBranding": {},
@@ -29737,6 +30499,7 @@ export declare namespace discoveryengine_v1alpha {
29737
30499
  * // "llmEnabled": false,
29738
30500
  * // "minimumDataTermAccepted": false,
29739
30501
  * // "name": "my_name",
30502
+ * // "nodes": [],
29740
30503
  * // "resultDisplayType": "my_resultDisplayType",
29741
30504
  * // "solutionType": "my_solutionType",
29742
30505
  * // "uiBranding": {},
@@ -29781,6 +30544,7 @@ export declare namespace discoveryengine_v1alpha {
29781
30544
  * // "llmEnabled": false,
29782
30545
  * // "minimumDataTermAccepted": false,
29783
30546
  * // "name": "my_name",
30547
+ * // "nodes": [],
29784
30548
  * // "resultDisplayType": "my_resultDisplayType",
29785
30549
  * // "solutionType": "my_solutionType",
29786
30550
  * // "uiBranding": {},
@@ -29905,9 +30669,11 @@ export declare namespace discoveryengine_v1alpha {
29905
30669
  * // "displayName": "my_displayName",
29906
30670
  * // "features": {},
29907
30671
  * // "industryVertical": "my_industryVertical",
30672
+ * // "knowledgeGraphConfig": {},
29908
30673
  * // "mediaRecommendationEngineConfig": {},
29909
30674
  * // "modelConfigs": {},
29910
30675
  * // "name": "my_name",
30676
+ * // "observabilityConfig": {},
29911
30677
  * // "recommendationMetadata": {},
29912
30678
  * // "searchEngineConfig": {},
29913
30679
  * // "similarDocumentsConfig": {},
@@ -30067,9 +30833,11 @@ export declare namespace discoveryengine_v1alpha {
30067
30833
  * // "displayName": "my_displayName",
30068
30834
  * // "features": {},
30069
30835
  * // "industryVertical": "my_industryVertical",
30836
+ * // "knowledgeGraphConfig": {},
30070
30837
  * // "mediaRecommendationEngineConfig": {},
30071
30838
  * // "modelConfigs": {},
30072
30839
  * // "name": "my_name",
30840
+ * // "observabilityConfig": {},
30073
30841
  * // "recommendationMetadata": {},
30074
30842
  * // "searchEngineConfig": {},
30075
30843
  * // "similarDocumentsConfig": {},
@@ -30291,9 +31059,11 @@ export declare namespace discoveryengine_v1alpha {
30291
31059
  * // "displayName": "my_displayName",
30292
31060
  * // "features": {},
30293
31061
  * // "industryVertical": "my_industryVertical",
31062
+ * // "knowledgeGraphConfig": {},
30294
31063
  * // "mediaRecommendationEngineConfig": {},
30295
31064
  * // "modelConfigs": {},
30296
31065
  * // "name": "my_name",
31066
+ * // "observabilityConfig": {},
30297
31067
  * // "recommendationMetadata": {},
30298
31068
  * // "searchEngineConfig": {},
30299
31069
  * // "similarDocumentsConfig": {},
@@ -30318,9 +31088,11 @@ export declare namespace discoveryengine_v1alpha {
30318
31088
  * // "displayName": "my_displayName",
30319
31089
  * // "features": {},
30320
31090
  * // "industryVertical": "my_industryVertical",
31091
+ * // "knowledgeGraphConfig": {},
30321
31092
  * // "mediaRecommendationEngineConfig": {},
30322
31093
  * // "modelConfigs": {},
30323
31094
  * // "name": "my_name",
31095
+ * // "observabilityConfig": {},
30324
31096
  * // "recommendationMetadata": {},
30325
31097
  * // "searchEngineConfig": {},
30326
31098
  * // "similarDocumentsConfig": {},
@@ -30407,9 +31179,11 @@ export declare namespace discoveryengine_v1alpha {
30407
31179
  * // "displayName": "my_displayName",
30408
31180
  * // "features": {},
30409
31181
  * // "industryVertical": "my_industryVertical",
31182
+ * // "knowledgeGraphConfig": {},
30410
31183
  * // "mediaRecommendationEngineConfig": {},
30411
31184
  * // "modelConfigs": {},
30412
31185
  * // "name": "my_name",
31186
+ * // "observabilityConfig": {},
30413
31187
  * // "recommendationMetadata": {},
30414
31188
  * // "searchEngineConfig": {},
30415
31189
  * // "similarDocumentsConfig": {},
@@ -30496,9 +31270,11 @@ export declare namespace discoveryengine_v1alpha {
30496
31270
  * // "displayName": "my_displayName",
30497
31271
  * // "features": {},
30498
31272
  * // "industryVertical": "my_industryVertical",
31273
+ * // "knowledgeGraphConfig": {},
30499
31274
  * // "mediaRecommendationEngineConfig": {},
30500
31275
  * // "modelConfigs": {},
30501
31276
  * // "name": "my_name",
31277
+ * // "observabilityConfig": {},
30502
31278
  * // "recommendationMetadata": {},
30503
31279
  * // "searchEngineConfig": {},
30504
31280
  * // "similarDocumentsConfig": {},
@@ -30777,6 +31553,151 @@ export declare namespace discoveryengine_v1alpha {
30777
31553
  exportMetrics(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
30778
31554
  exportMetrics(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
30779
31555
  exportMetrics(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
31556
+ /**
31557
+ * Gets the AnalyticsConfig.
31558
+ * @example
31559
+ * ```js
31560
+ * // Before running the sample:
31561
+ * // - Enable the API at:
31562
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
31563
+ * // - Login into gcloud by running:
31564
+ * // ```sh
31565
+ * // $ gcloud auth application-default login
31566
+ * // ```
31567
+ * // - Install the npm module by running:
31568
+ * // ```sh
31569
+ * // $ npm install googleapis
31570
+ * // ```
31571
+ *
31572
+ * const {google} = require('googleapis');
31573
+ * const discoveryengine = google.discoveryengine('v1alpha');
31574
+ *
31575
+ * async function main() {
31576
+ * const auth = new google.auth.GoogleAuth({
31577
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
31578
+ * scopes: [
31579
+ * 'https://www.googleapis.com/auth/cloud-platform',
31580
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
31581
+ * ],
31582
+ * });
31583
+ *
31584
+ * // Acquire an auth client, and bind it to all future calls
31585
+ * const authClient = await auth.getClient();
31586
+ * google.options({auth: authClient});
31587
+ *
31588
+ * // Do the magic
31589
+ * const res =
31590
+ * await discoveryengine.projects.locations.collections.engines.analytics.getConfig(
31591
+ * {
31592
+ * // Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
31593
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/analytics/config',
31594
+ * },
31595
+ * );
31596
+ * console.log(res.data);
31597
+ *
31598
+ * // Example response
31599
+ * // {
31600
+ * // "name": "my_name",
31601
+ * // "userLevelMetricsEnabled": false
31602
+ * // }
31603
+ * }
31604
+ *
31605
+ * main().catch(e => {
31606
+ * console.error(e);
31607
+ * throw e;
31608
+ * });
31609
+ *
31610
+ * ```
31611
+ *
31612
+ * @param params - Parameters for request
31613
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
31614
+ * @param callback - Optional callback that handles the response.
31615
+ * @returns A promise if used with async/await, or void if used with a callback.
31616
+ */
31617
+ getConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
31618
+ getConfig(params?: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>>;
31619
+ getConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
31620
+ getConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
31621
+ getConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
31622
+ getConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
31623
+ /**
31624
+ * Updates the AnalyticsConfig for analytics.
31625
+ * @example
31626
+ * ```js
31627
+ * // Before running the sample:
31628
+ * // - Enable the API at:
31629
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
31630
+ * // - Login into gcloud by running:
31631
+ * // ```sh
31632
+ * // $ gcloud auth application-default login
31633
+ * // ```
31634
+ * // - Install the npm module by running:
31635
+ * // ```sh
31636
+ * // $ npm install googleapis
31637
+ * // ```
31638
+ *
31639
+ * const {google} = require('googleapis');
31640
+ * const discoveryengine = google.discoveryengine('v1alpha');
31641
+ *
31642
+ * async function main() {
31643
+ * const auth = new google.auth.GoogleAuth({
31644
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
31645
+ * scopes: [
31646
+ * 'https://www.googleapis.com/auth/cloud-platform',
31647
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
31648
+ * ],
31649
+ * });
31650
+ *
31651
+ * // Acquire an auth client, and bind it to all future calls
31652
+ * const authClient = await auth.getClient();
31653
+ * google.options({auth: authClient});
31654
+ *
31655
+ * // Do the magic
31656
+ * const res =
31657
+ * await discoveryengine.projects.locations.collections.engines.analytics.updateConfig(
31658
+ * {
31659
+ * // Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
31660
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/analytics/config',
31661
+ * // The list of fields of AnalyticsConfig to update. If not specified, the method will perform a full replacement.
31662
+ * updateMask: 'placeholder-value',
31663
+ *
31664
+ * // Request body metadata
31665
+ * requestBody: {
31666
+ * // request body parameters
31667
+ * // {
31668
+ * // "name": "my_name",
31669
+ * // "userLevelMetricsEnabled": false
31670
+ * // }
31671
+ * },
31672
+ * },
31673
+ * );
31674
+ * console.log(res.data);
31675
+ *
31676
+ * // Example response
31677
+ * // {
31678
+ * // "name": "my_name",
31679
+ * // "userLevelMetricsEnabled": false
31680
+ * // }
31681
+ * }
31682
+ *
31683
+ * main().catch(e => {
31684
+ * console.error(e);
31685
+ * throw e;
31686
+ * });
31687
+ *
31688
+ * ```
31689
+ *
31690
+ * @param params - Parameters for request
31691
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
31692
+ * @param callback - Optional callback that handles the response.
31693
+ * @returns A promise if used with async/await, or void if used with a callback.
31694
+ */
31695
+ updateConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
31696
+ updateConfig(params?: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>>;
31697
+ updateConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
31698
+ updateConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
31699
+ updateConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
31700
+ updateConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
30780
31701
  }
30781
31702
  export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics extends StandardParameters {
30782
31703
  /**
@@ -30788,6 +31709,26 @@ export declare namespace discoveryengine_v1alpha {
30788
31709
  */
30789
31710
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaExportMetricsRequest;
30790
31711
  }
31712
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig extends StandardParameters {
31713
+ /**
31714
+ * Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
31715
+ */
31716
+ name?: string;
31717
+ }
31718
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig extends StandardParameters {
31719
+ /**
31720
+ * Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
31721
+ */
31722
+ name?: string;
31723
+ /**
31724
+ * The list of fields of AnalyticsConfig to update. If not specified, the method will perform a full replacement.
31725
+ */
31726
+ updateMask?: string;
31727
+ /**
31728
+ * Request body metadata
31729
+ */
31730
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig;
31731
+ }
30791
31732
  export class Resource$Projects$Locations$Collections$Engines$Assistants {
30792
31733
  context: APIRequestContext;
30793
31734
  agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
@@ -31147,7 +32088,7 @@ export declare namespace discoveryengine_v1alpha {
31147
32088
  * languageCode: 'placeholder-value',
31148
32089
  * // Optional. The maximum number of suggested prompts to return per agent.
31149
32090
  * maxSuggestedPrompts: 'placeholder-value',
31150
- * // Optional. Maximum number of AgentViewss to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
32091
+ * // Optional. Maximum number of AgentViews to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
31151
32092
  * pageSize: 'placeholder-value',
31152
32093
  * // Optional. A page token ListAvailableAgentViewsResponse.next_page_token, received from a previous AgentService.ListAvailableAgentViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAvailableAgentViews must match the call that provided the page token.
31153
32094
  * pageToken: 'placeholder-value',
@@ -31423,7 +32364,7 @@ export declare namespace discoveryengine_v1alpha {
31423
32364
  */
31424
32365
  maxSuggestedPrompts?: number;
31425
32366
  /**
31426
- * Optional. Maximum number of AgentViewss to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
32367
+ * Optional. Maximum number of AgentViews to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.
31427
32368
  */
31428
32369
  pageSize?: number;
31429
32370
  /**
@@ -31690,6 +32631,8 @@ export declare namespace discoveryengine_v1alpha {
31690
32631
  * {
31691
32632
  * // Required. The name of the Agent to disable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
31692
32633
  * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
32634
+ * // Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.
32635
+ * revisionId: 'placeholder-value',
31693
32636
  * },
31694
32637
  * );
31695
32638
  * console.log(res.data);
@@ -31775,6 +32718,8 @@ export declare namespace discoveryengine_v1alpha {
31775
32718
  * {
31776
32719
  * // Required. The name of the Agent to enable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
31777
32720
  * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
32721
+ * // Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.
32722
+ * revisionId: 'placeholder-value',
31778
32723
  * },
31779
32724
  * );
31780
32725
  * console.log(res.data);
@@ -32426,12 +33371,20 @@ export declare namespace discoveryengine_v1alpha {
32426
33371
  * Required. The name of the Agent to disable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
32427
33372
  */
32428
33373
  name?: string;
33374
+ /**
33375
+ * Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.
33376
+ */
33377
+ revisionId?: string;
32429
33378
  }
32430
33379
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent extends StandardParameters {
32431
33380
  /**
32432
33381
  * Required. The name of the Agent to enable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
32433
33382
  */
32434
33383
  name?: string;
33384
+ /**
33385
+ * Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.
33386
+ */
33387
+ revisionId?: string;
32435
33388
  }
32436
33389
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get extends StandardParameters {
32437
33390
  /**
@@ -36533,6 +37486,7 @@ export declare namespace discoveryengine_v1alpha {
36533
37486
  * // "llmEnabled": false,
36534
37487
  * // "minimumDataTermAccepted": false,
36535
37488
  * // "name": "my_name",
37489
+ * // "nodes": [],
36536
37490
  * // "resultDisplayType": "my_resultDisplayType",
36537
37491
  * // "solutionType": "my_solutionType",
36538
37492
  * // "uiBranding": {},
@@ -36636,6 +37590,7 @@ export declare namespace discoveryengine_v1alpha {
36636
37590
  * // "llmEnabled": false,
36637
37591
  * // "minimumDataTermAccepted": false,
36638
37592
  * // "name": "my_name",
37593
+ * // "nodes": [],
36639
37594
  * // "resultDisplayType": "my_resultDisplayType",
36640
37595
  * // "solutionType": "my_solutionType",
36641
37596
  * // "uiBranding": {},
@@ -36680,6 +37635,7 @@ export declare namespace discoveryengine_v1alpha {
36680
37635
  * // "llmEnabled": false,
36681
37636
  * // "minimumDataTermAccepted": false,
36682
37637
  * // "name": "my_name",
37638
+ * // "nodes": [],
36683
37639
  * // "resultDisplayType": "my_resultDisplayType",
36684
37640
  * // "solutionType": "my_solutionType",
36685
37641
  * // "uiBranding": {},
@@ -36926,6 +37882,84 @@ export declare namespace discoveryengine_v1alpha {
36926
37882
  userEvents: Resource$Projects$Locations$Datastores$Userevents;
36927
37883
  widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs;
36928
37884
  constructor(context: APIRequestContext);
37885
+ /**
37886
+ * Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. 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.
37887
+ * @example
37888
+ * ```js
37889
+ * // Before running the sample:
37890
+ * // - Enable the API at:
37891
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
37892
+ * // - Login into gcloud by running:
37893
+ * // ```sh
37894
+ * // $ gcloud auth application-default login
37895
+ * // ```
37896
+ * // - Install the npm module by running:
37897
+ * // ```sh
37898
+ * // $ npm install googleapis
37899
+ * // ```
37900
+ *
37901
+ * const {google} = require('googleapis');
37902
+ * const discoveryengine = google.discoveryengine('v1alpha');
37903
+ *
37904
+ * async function main() {
37905
+ * const auth = new google.auth.GoogleAuth({
37906
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
37907
+ * scopes: [
37908
+ * 'https://www.googleapis.com/auth/cloud-platform',
37909
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
37910
+ * ],
37911
+ * });
37912
+ *
37913
+ * // Acquire an auth client, and bind it to all future calls
37914
+ * const authClient = await auth.getClient();
37915
+ * google.options({auth: authClient});
37916
+ *
37917
+ * // Do the magic
37918
+ * const res =
37919
+ * await discoveryengine.projects.locations.dataStores.addPatientFilter({
37920
+ * // 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.
37921
+ * dataStore:
37922
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
37923
+ *
37924
+ * // Request body metadata
37925
+ * requestBody: {
37926
+ * // request body parameters
37927
+ * // {
37928
+ * // "dataStore": "my_dataStore",
37929
+ * // "filterGroups": []
37930
+ * // }
37931
+ * },
37932
+ * });
37933
+ * console.log(res.data);
37934
+ *
37935
+ * // Example response
37936
+ * // {
37937
+ * // "done": false,
37938
+ * // "error": {},
37939
+ * // "metadata": {},
37940
+ * // "name": "my_name",
37941
+ * // "response": {}
37942
+ * // }
37943
+ * }
37944
+ *
37945
+ * main().catch(e => {
37946
+ * console.error(e);
37947
+ * throw e;
37948
+ * });
37949
+ *
37950
+ * ```
37951
+ *
37952
+ * @param params - Parameters for request
37953
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
37954
+ * @param callback - Optional callback that handles the response.
37955
+ * @returns A promise if used with async/await, or void if used with a callback.
37956
+ */
37957
+ addPatientFilter(params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
37958
+ addPatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
37959
+ addPatientFilter(params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
37960
+ addPatientFilter(params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
37961
+ addPatientFilter(params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
37962
+ addPatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
36929
37963
  /**
36930
37964
  * Completes the specified user input with keyword suggestions.
36931
37965
  * @example
@@ -37179,6 +38213,83 @@ export declare namespace discoveryengine_v1alpha {
37179
38213
  delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
37180
38214
  delete(params: Params$Resource$Projects$Locations$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
37181
38215
  delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38216
+ /**
38217
+ * Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.
38218
+ * @example
38219
+ * ```js
38220
+ * // Before running the sample:
38221
+ * // - Enable the API at:
38222
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38223
+ * // - Login into gcloud by running:
38224
+ * // ```sh
38225
+ * // $ gcloud auth application-default login
38226
+ * // ```
38227
+ * // - Install the npm module by running:
38228
+ * // ```sh
38229
+ * // $ npm install googleapis
38230
+ * // ```
38231
+ *
38232
+ * const {google} = require('googleapis');
38233
+ * const discoveryengine = google.discoveryengine('v1alpha');
38234
+ *
38235
+ * async function main() {
38236
+ * const auth = new google.auth.GoogleAuth({
38237
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38238
+ * scopes: [
38239
+ * 'https://www.googleapis.com/auth/cloud-platform',
38240
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38241
+ * ],
38242
+ * });
38243
+ *
38244
+ * // Acquire an auth client, and bind it to all future calls
38245
+ * const authClient = await auth.getClient();
38246
+ * google.options({auth: authClient});
38247
+ *
38248
+ * // Do the magic
38249
+ * const res =
38250
+ * await discoveryengine.projects.locations.dataStores.deletePatientFilter({
38251
+ * // 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.
38252
+ * dataStore:
38253
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
38254
+ *
38255
+ * // Request body metadata
38256
+ * requestBody: {
38257
+ * // request body parameters
38258
+ * // {
38259
+ * // "dataStore": "my_dataStore"
38260
+ * // }
38261
+ * },
38262
+ * });
38263
+ * console.log(res.data);
38264
+ *
38265
+ * // Example response
38266
+ * // {
38267
+ * // "done": false,
38268
+ * // "error": {},
38269
+ * // "metadata": {},
38270
+ * // "name": "my_name",
38271
+ * // "response": {}
38272
+ * // }
38273
+ * }
38274
+ *
38275
+ * main().catch(e => {
38276
+ * console.error(e);
38277
+ * throw e;
38278
+ * });
38279
+ *
38280
+ * ```
38281
+ *
38282
+ * @param params - Parameters for request
38283
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38284
+ * @param callback - Optional callback that handles the response.
38285
+ * @returns A promise if used with async/await, or void if used with a callback.
38286
+ */
38287
+ deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38288
+ deletePatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
38289
+ deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38290
+ deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38291
+ deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38292
+ deletePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
37182
38293
  /**
37183
38294
  * Gets a DataStore.
37184
38295
  * @example
@@ -37588,6 +38699,162 @@ export declare namespace discoveryengine_v1alpha {
37588
38699
  patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
37589
38700
  patch(params: Params$Resource$Projects$Locations$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
37590
38701
  patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
38702
+ /**
38703
+ * Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.
38704
+ * @example
38705
+ * ```js
38706
+ * // Before running the sample:
38707
+ * // - Enable the API at:
38708
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38709
+ * // - Login into gcloud by running:
38710
+ * // ```sh
38711
+ * // $ gcloud auth application-default login
38712
+ * // ```
38713
+ * // - Install the npm module by running:
38714
+ * // ```sh
38715
+ * // $ npm install googleapis
38716
+ * // ```
38717
+ *
38718
+ * const {google} = require('googleapis');
38719
+ * const discoveryengine = google.discoveryengine('v1alpha');
38720
+ *
38721
+ * async function main() {
38722
+ * const auth = new google.auth.GoogleAuth({
38723
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38724
+ * scopes: [
38725
+ * 'https://www.googleapis.com/auth/cloud-platform',
38726
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38727
+ * ],
38728
+ * });
38729
+ *
38730
+ * // Acquire an auth client, and bind it to all future calls
38731
+ * const authClient = await auth.getClient();
38732
+ * google.options({auth: authClient});
38733
+ *
38734
+ * // Do the magic
38735
+ * const res =
38736
+ * await discoveryengine.projects.locations.dataStores.removePatientFilter({
38737
+ * // 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
38738
+ * dataStore:
38739
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
38740
+ *
38741
+ * // Request body metadata
38742
+ * requestBody: {
38743
+ * // request body parameters
38744
+ * // {
38745
+ * // "dataStore": "my_dataStore",
38746
+ * // "filterGroups": []
38747
+ * // }
38748
+ * },
38749
+ * });
38750
+ * console.log(res.data);
38751
+ *
38752
+ * // Example response
38753
+ * // {
38754
+ * // "done": false,
38755
+ * // "error": {},
38756
+ * // "metadata": {},
38757
+ * // "name": "my_name",
38758
+ * // "response": {}
38759
+ * // }
38760
+ * }
38761
+ *
38762
+ * main().catch(e => {
38763
+ * console.error(e);
38764
+ * throw e;
38765
+ * });
38766
+ *
38767
+ * ```
38768
+ *
38769
+ * @param params - Parameters for request
38770
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38771
+ * @param callback - Optional callback that handles the response.
38772
+ * @returns A promise if used with async/await, or void if used with a callback.
38773
+ */
38774
+ removePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38775
+ removePatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
38776
+ removePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38777
+ removePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38778
+ removePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38779
+ removePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38780
+ /**
38781
+ * Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. 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.
38782
+ * @example
38783
+ * ```js
38784
+ * // Before running the sample:
38785
+ * // - Enable the API at:
38786
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
38787
+ * // - Login into gcloud by running:
38788
+ * // ```sh
38789
+ * // $ gcloud auth application-default login
38790
+ * // ```
38791
+ * // - Install the npm module by running:
38792
+ * // ```sh
38793
+ * // $ npm install googleapis
38794
+ * // ```
38795
+ *
38796
+ * const {google} = require('googleapis');
38797
+ * const discoveryengine = google.discoveryengine('v1alpha');
38798
+ *
38799
+ * async function main() {
38800
+ * const auth = new google.auth.GoogleAuth({
38801
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
38802
+ * scopes: [
38803
+ * 'https://www.googleapis.com/auth/cloud-platform',
38804
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
38805
+ * ],
38806
+ * });
38807
+ *
38808
+ * // Acquire an auth client, and bind it to all future calls
38809
+ * const authClient = await auth.getClient();
38810
+ * google.options({auth: authClient});
38811
+ *
38812
+ * // Do the magic
38813
+ * const res =
38814
+ * await discoveryengine.projects.locations.dataStores.replacePatientFilter({
38815
+ * // 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.
38816
+ * dataStore:
38817
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
38818
+ *
38819
+ * // Request body metadata
38820
+ * requestBody: {
38821
+ * // request body parameters
38822
+ * // {
38823
+ * // "dataStore": "my_dataStore",
38824
+ * // "filterGroups": []
38825
+ * // }
38826
+ * },
38827
+ * });
38828
+ * console.log(res.data);
38829
+ *
38830
+ * // Example response
38831
+ * // {
38832
+ * // "done": false,
38833
+ * // "error": {},
38834
+ * // "metadata": {},
38835
+ * // "name": "my_name",
38836
+ * // "response": {}
38837
+ * // }
38838
+ * }
38839
+ *
38840
+ * main().catch(e => {
38841
+ * console.error(e);
38842
+ * throw e;
38843
+ * });
38844
+ *
38845
+ * ```
38846
+ *
38847
+ * @param params - Parameters for request
38848
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
38849
+ * @param callback - Optional callback that handles the response.
38850
+ * @returns A promise if used with async/await, or void if used with a callback.
38851
+ */
38852
+ replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
38853
+ replacePatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
38854
+ replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
38855
+ replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38856
+ replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
38857
+ replacePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
37591
38858
  /**
37592
38859
  * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.
37593
38860
  * @example
@@ -37671,6 +38938,16 @@ export declare namespace discoveryengine_v1alpha {
37671
38938
  updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
37672
38939
  updateDocumentProcessingConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
37673
38940
  }
38941
+ export interface Params$Resource$Projects$Locations$Datastores$Addpatientfilter extends StandardParameters {
38942
+ /**
38943
+ * 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.
38944
+ */
38945
+ dataStore?: string;
38946
+ /**
38947
+ * Request body metadata
38948
+ */
38949
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest;
38950
+ }
37674
38951
  export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters {
37675
38952
  /**
37676
38953
  * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`.
@@ -37729,6 +39006,16 @@ export declare namespace discoveryengine_v1alpha {
37729
39006
  */
37730
39007
  name?: string;
37731
39008
  }
39009
+ export interface Params$Resource$Projects$Locations$Datastores$Deletepatientfilter extends StandardParameters {
39010
+ /**
39011
+ * 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.
39012
+ */
39013
+ dataStore?: string;
39014
+ /**
39015
+ * Request body metadata
39016
+ */
39017
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest;
39018
+ }
37732
39019
  export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters {
37733
39020
  /**
37734
39021
  * 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.
@@ -37779,6 +39066,26 @@ export declare namespace discoveryengine_v1alpha {
37779
39066
  */
37780
39067
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
37781
39068
  }
39069
+ export interface Params$Resource$Projects$Locations$Datastores$Removepatientfilter extends StandardParameters {
39070
+ /**
39071
+ * 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
39072
+ */
39073
+ dataStore?: string;
39074
+ /**
39075
+ * Request body metadata
39076
+ */
39077
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest;
39078
+ }
39079
+ export interface Params$Resource$Projects$Locations$Datastores$Replacepatientfilter extends StandardParameters {
39080
+ /**
39081
+ * 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.
39082
+ */
39083
+ dataStore?: string;
39084
+ /**
39085
+ * Request body metadata
39086
+ */
39087
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest;
39088
+ }
37782
39089
  export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
37783
39090
  /**
37784
39091
  * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
@@ -37905,7 +39212,7 @@ export declare namespace discoveryengine_v1alpha {
37905
39212
  * const res = await discoveryengine.projects.locations.dataStores.branches.get({
37906
39213
  * // Required. The name of the branch to retrieve. Format: `projects/x/locations/global/dataStores/default_data_store/branches/some_branch_id`. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the document.
37907
39214
  * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche',
37908
- * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
39215
+ * // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
37909
39216
  * view: 'placeholder-value',
37910
39217
  * });
37911
39218
  * console.log(res.data);
@@ -37976,7 +39283,7 @@ export declare namespace discoveryengine_v1alpha {
37976
39283
  * // Required. The parent data store resource name.
37977
39284
  * parent:
37978
39285
  * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
37979
- * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
39286
+ * // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
37980
39287
  * view: 'placeholder-value',
37981
39288
  * },
37982
39289
  * );
@@ -38027,7 +39334,7 @@ export declare namespace discoveryengine_v1alpha {
38027
39334
  */
38028
39335
  name?: string;
38029
39336
  /**
38030
- * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
39337
+ * The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
38031
39338
  */
38032
39339
  view?: string;
38033
39340
  }
@@ -38037,7 +39344,7 @@ export declare namespace discoveryengine_v1alpha {
38037
39344
  */
38038
39345
  parent?: string;
38039
39346
  /**
38040
- * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
39347
+ * The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
38041
39348
  */
38042
39349
  view?: string;
38043
39350
  }
@@ -44640,6 +45947,7 @@ export declare namespace discoveryengine_v1alpha {
44640
45947
  * // "llmEnabled": false,
44641
45948
  * // "minimumDataTermAccepted": false,
44642
45949
  * // "name": "my_name",
45950
+ * // "nodes": [],
44643
45951
  * // "resultDisplayType": "my_resultDisplayType",
44644
45952
  * // "solutionType": "my_solutionType",
44645
45953
  * // "uiBranding": {},
@@ -44742,6 +46050,7 @@ export declare namespace discoveryengine_v1alpha {
44742
46050
  * // "llmEnabled": false,
44743
46051
  * // "minimumDataTermAccepted": false,
44744
46052
  * // "name": "my_name",
46053
+ * // "nodes": [],
44745
46054
  * // "resultDisplayType": "my_resultDisplayType",
44746
46055
  * // "solutionType": "my_solutionType",
44747
46056
  * // "uiBranding": {},
@@ -44785,6 +46094,7 @@ export declare namespace discoveryengine_v1alpha {
44785
46094
  * // "llmEnabled": false,
44786
46095
  * // "minimumDataTermAccepted": false,
44787
46096
  * // "name": "my_name",
46097
+ * // "nodes": [],
44788
46098
  * // "resultDisplayType": "my_resultDisplayType",
44789
46099
  * // "solutionType": "my_solutionType",
44790
46100
  * // "uiBranding": {},