@googleapis/discoveryengine 28.2.0 → 28.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v1alpha.ts CHANGED
@@ -598,6 +598,19 @@ export namespace discoveryengine_v1alpha {
598
598
  */
599
599
  useStaticSecrets?: boolean | null;
600
600
  }
601
+ /**
602
+ * Request for DataStoreService.AddPatientFilter method.
603
+ */
604
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
605
+ /**
606
+ * 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.
607
+ */
608
+ dataStore?: string | null;
609
+ /**
610
+ * 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.
611
+ */
612
+ filterGroups?: string[] | null;
613
+ }
601
614
  /**
602
615
  * Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).
603
616
  */
@@ -658,7 +671,7 @@ export namespace discoveryengine_v1alpha {
658
671
  userPseudoId?: string | null;
659
672
  }
660
673
  /**
661
- * Specification to boost suggestions based on the condtion of the suggestion.
674
+ * Specification to boost suggestions based on the condition of the suggestion.
662
675
  */
663
676
  export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec {
664
677
  /**
@@ -1019,6 +1032,10 @@ export namespace discoveryengine_v1alpha {
1019
1032
  * The reason why the agent was suspended. Only set if the state is SUSPENDED.
1020
1033
  */
1021
1034
  suspensionReason?: string | null;
1035
+ /**
1036
+ * Output only. The timestamp when the agent was last updated.
1037
+ */
1038
+ updateTime?: string | null;
1022
1039
  /**
1023
1040
  * Optional. Per-user annotations of the current caller for the agent.
1024
1041
  */
@@ -1163,6 +1180,19 @@ export namespace discoveryengine_v1alpha {
1163
1180
  */
1164
1181
  tableId?: string | null;
1165
1182
  }
1183
+ /**
1184
+ * The customer controllable config for Analytics.
1185
+ */
1186
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig {
1187
+ /**
1188
+ * Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
1189
+ */
1190
+ name?: string | null;
1191
+ /**
1192
+ * Whether user-level metrics are enabled.
1193
+ */
1194
+ userLevelMetricsEnabled?: boolean | null;
1195
+ }
1166
1196
  /**
1167
1197
  * Defines an answer.
1168
1198
  */
@@ -2145,7 +2175,7 @@ export namespace discoveryengine_v1alpha {
2145
2175
  */
2146
2176
  groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
2147
2177
  /**
2148
- * 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.
2178
+ * 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.
2149
2179
  */
2150
2180
  replyId?: string | null;
2151
2181
  }
@@ -2157,6 +2187,10 @@ export namespace discoveryengine_v1alpha {
2157
2187
  * Optional. Customer policy for the assistant.
2158
2188
  */
2159
2189
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy;
2190
+ /**
2191
+ * Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
2192
+ */
2193
+ defaultWebGroundingToggleOff?: boolean | null;
2160
2194
  /**
2161
2195
  * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
2162
2196
  */
@@ -2525,7 +2559,11 @@ export namespace discoveryengine_v1alpha {
2525
2559
  */
2526
2560
  clientSecret?: string | null;
2527
2561
  /**
2528
- * Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
2562
+ * Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
2563
+ */
2564
+ pkceVerificationEnabled?: boolean | null;
2565
+ /**
2566
+ * 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.
2529
2567
  */
2530
2568
  scopes?: string[] | null;
2531
2569
  /**
@@ -2868,7 +2906,7 @@ export namespace discoveryengine_v1alpha {
2868
2906
  */
2869
2907
  export interface Schema$GoogleCloudDiscoveryengineV1alphaBranch {
2870
2908
  /**
2871
- * Output only. Stistics describing a branch. This field is not populated in BranchView.BASIC view.
2909
+ * Output only. Statistics describing a branch. This field is not populated in BranchView.BRANCH_VIEW_BASIC view.
2872
2910
  */
2873
2911
  branchStats?: Schema$GoogleCloudDiscoveryengineV1alphaBranchBranchStats;
2874
2912
  /**
@@ -4539,6 +4577,15 @@ export namespace discoveryengine_v1alpha {
4539
4577
  */
4540
4578
  updateTime?: string | null;
4541
4579
  }
4580
+ /**
4581
+ * Request for DataStoreService.DeletePatientFilters method.
4582
+ */
4583
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest {
4584
+ /**
4585
+ * 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.
4586
+ */
4587
+ dataStore?: string | null;
4588
+ }
4542
4589
  /**
4543
4590
  * Metadata for DeleteSchema LRO.
4544
4591
  */
@@ -5034,13 +5081,17 @@ export namespace discoveryengine_v1alpha {
5034
5081
  */
5035
5082
  displayName?: string | null;
5036
5083
  /**
5037
- * 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`
5084
+ * 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`
5038
5085
  */
5039
5086
  features?: {[key: string]: string} | null;
5040
5087
  /**
5041
5088
  * 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.
5042
5089
  */
5043
5090
  industryVertical?: string | null;
5091
+ /**
5092
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
5093
+ */
5094
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
5044
5095
  /**
5045
5096
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
5046
5097
  */
@@ -5130,6 +5181,52 @@ export namespace discoveryengine_v1alpha {
5130
5181
  */
5131
5182
  companyName?: string | null;
5132
5183
  }
5184
+ /**
5185
+ * Configuration message for the Knowledge Graph.
5186
+ */
5187
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig {
5188
+ /**
5189
+ * Specify entity types to support.
5190
+ */
5191
+ cloudKnowledgeGraphTypes?: string[] | null;
5192
+ /**
5193
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
5194
+ */
5195
+ enableCloudKnowledgeGraph?: boolean | null;
5196
+ /**
5197
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
5198
+ */
5199
+ enablePrivateKnowledgeGraph?: boolean | null;
5200
+ /**
5201
+ * Optional. Feature config for the Knowledge Graph.
5202
+ */
5203
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig;
5204
+ /**
5205
+ * Specify entity types to support.
5206
+ */
5207
+ privateKnowledgeGraphTypes?: string[] | null;
5208
+ }
5209
+ /**
5210
+ * Feature config for the Knowledge Graph.
5211
+ */
5212
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig {
5213
+ /**
5214
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
5215
+ */
5216
+ disablePrivateKgAutoComplete?: boolean | null;
5217
+ /**
5218
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
5219
+ */
5220
+ disablePrivateKgEnrichment?: boolean | null;
5221
+ /**
5222
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
5223
+ */
5224
+ disablePrivateKgQueryUiChips?: boolean | null;
5225
+ /**
5226
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
5227
+ */
5228
+ disablePrivateKgQueryUnderstanding?: boolean | null;
5229
+ }
5133
5230
  /**
5134
5231
  * Additional config specs for a Media Recommendation engine.
5135
5232
  */
@@ -5783,6 +5880,10 @@ export namespace discoveryengine_v1alpha {
5783
5880
  * 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.
5784
5881
  */
5785
5882
  enableStaticIndexingForBatchIngestion?: boolean | null;
5883
+ /**
5884
+ * 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.
5885
+ */
5886
+ initialFilterGroups?: string[] | null;
5786
5887
  }
5787
5888
  /**
5788
5889
  * Identity Mapping Entry that maps an external identity to an internal identity.
@@ -6717,7 +6818,7 @@ export namespace discoveryengine_v1alpha {
6717
6818
  nextPageToken?: string | null;
6718
6819
  }
6719
6820
  /**
6720
- * Response message for UserLicenseService.ListLicenseConfigUsageStats method.
6821
+ * Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
6721
6822
  */
6722
6823
  export interface Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse {
6723
6824
  /**
@@ -6969,6 +7070,27 @@ export namespace discoveryengine_v1alpha {
6969
7070
  */
6970
7071
  totalPanels?: number | null;
6971
7072
  }
7073
+ /**
7074
+ * Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.
7075
+ */
7076
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata {
7077
+ /**
7078
+ * Operation create time.
7079
+ */
7080
+ createTime?: string | null;
7081
+ /**
7082
+ * The number of patient IDs added to the patient filter.
7083
+ */
7084
+ filtersAddedCount?: string | null;
7085
+ /**
7086
+ * The number of patient IDs removed from the patient filter.
7087
+ */
7088
+ filtersRemovedCount?: string | null;
7089
+ /**
7090
+ * Operation last update time. If the operation is done, this is also the finish time.
7091
+ */
7092
+ updateTime?: string | null;
7093
+ }
6972
7094
  /**
6973
7095
  * Request for pausing training of an engine.
6974
7096
  */
@@ -7048,10 +7170,22 @@ export namespace discoveryengine_v1alpha {
7048
7170
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
7049
7171
  */
7050
7172
  effectiveSearchQpmThreshold?: string | null;
7173
+ /**
7174
+ * 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.
7175
+ */
7176
+ indexingCoreThresholdNextUpdateTime?: string | null;
7177
+ /**
7178
+ * 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.
7179
+ */
7180
+ searchQpmThresholdNextUpdateTime?: string | null;
7051
7181
  /**
7052
7182
  * Optional. The start time of the currently active billing subscription.
7053
7183
  */
7054
7184
  startTime?: string | null;
7185
+ /**
7186
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
7187
+ */
7188
+ terminateTime?: string | null;
7055
7189
  }
7056
7190
  /**
7057
7191
  * Customer provided configurations.
@@ -7734,6 +7868,19 @@ export namespace discoveryengine_v1alpha {
7734
7868
  */
7735
7869
  state?: string | null;
7736
7870
  }
7871
+ /**
7872
+ * Request for DataStoreService.RemovePatientFilter method.
7873
+ */
7874
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest {
7875
+ /**
7876
+ * 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
7877
+ */
7878
+ dataStore?: string | null;
7879
+ /**
7880
+ * 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.
7881
+ */
7882
+ filterGroups?: string[] | null;
7883
+ }
7737
7884
  /**
7738
7885
  * Request message for CompletionService.RemoveSuggestion method.
7739
7886
  */
@@ -7763,6 +7910,19 @@ export namespace discoveryengine_v1alpha {
7763
7910
  * Response message for CompletionService.RemoveSuggestion method.
7764
7911
  */
7765
7912
  export interface Schema$GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse {}
7913
+ /**
7914
+ * Request for DataStoreService.ReplacePatientFilter method.
7915
+ */
7916
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest {
7917
+ /**
7918
+ * 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.
7919
+ */
7920
+ dataStore?: string | null;
7921
+ /**
7922
+ * 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.
7923
+ */
7924
+ filterGroups?: string[] | null;
7925
+ }
7766
7926
  /**
7767
7927
  * Defines a reply message to user.
7768
7928
  */
@@ -8194,7 +8354,7 @@ export namespace discoveryengine_v1alpha {
8194
8354
  */
8195
8355
  orderBy?: string | null;
8196
8356
  /**
8197
- * 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`
8357
+ * 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`
8198
8358
  */
8199
8359
  pageCategories?: string[] | null;
8200
8360
  /**
@@ -8647,7 +8807,7 @@ export namespace discoveryengine_v1alpha {
8647
8807
  */
8648
8808
  allowedFieldNames?: string[] | null;
8649
8809
  /**
8650
- * 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.
8810
+ * 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.
8651
8811
  */
8652
8812
  extractedFilterBehavior?: string | null;
8653
8813
  /**
@@ -8790,7 +8950,7 @@ export namespace discoveryengine_v1alpha {
8790
8950
  */
8791
8951
  guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult;
8792
8952
  /**
8793
- * Natural language query understanding information for the returned results.
8953
+ * Output only. Natural language query understanding information for the returned results.
8794
8954
  */
8795
8955
  naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo;
8796
8956
  /**
@@ -10481,6 +10641,10 @@ export namespace discoveryengine_v1alpha {
10481
10641
  * 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.
10482
10642
  */
10483
10643
  name?: string | null;
10644
+ /**
10645
+ * Output only. The nodes associated with the Widget Config.
10646
+ */
10647
+ nodes?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigNode[];
10484
10648
  /**
10485
10649
  * 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.
10486
10650
  */
@@ -10577,7 +10741,7 @@ export namespace discoveryengine_v1alpha {
10577
10741
  */
10578
10742
  id?: string | null;
10579
10743
  /**
10580
- * 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.
10744
+ * 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.
10581
10745
  */
10582
10746
  name?: string | null;
10583
10747
  }
@@ -10615,7 +10779,7 @@ export namespace discoveryengine_v1alpha {
10615
10779
  */
10616
10780
  id?: string | null;
10617
10781
  /**
10618
- * 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.
10782
+ * 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.
10619
10783
  */
10620
10784
  name?: string | null;
10621
10785
  /**
@@ -10644,7 +10808,7 @@ export namespace discoveryengine_v1alpha {
10644
10808
  */
10645
10809
  id?: string | null;
10646
10810
  /**
10647
- * 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.
10811
+ * 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.
10648
10812
  */
10649
10813
  name?: string | null;
10650
10814
  }
@@ -10696,6 +10860,35 @@ export namespace discoveryengine_v1alpha {
10696
10860
  */
10697
10861
  url?: string | null;
10698
10862
  }
10863
+ /**
10864
+ * Represents a single reusable computational or logical unit.
10865
+ */
10866
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigNode {
10867
+ /**
10868
+ * Output only. A detailed description of what the node does.
10869
+ */
10870
+ description?: string | null;
10871
+ /**
10872
+ * Output only. A human readable name for the node.
10873
+ */
10874
+ displayName?: string | null;
10875
+ /**
10876
+ * Output only. An identifier or URL pointing to an icon representing this node type.
10877
+ */
10878
+ iconUrl?: string | null;
10879
+ /**
10880
+ * 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.
10881
+ */
10882
+ outputSchema?: {[key: string]: any} | null;
10883
+ /**
10884
+ * 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.
10885
+ */
10886
+ parameterSchema?: {[key: string]: any} | null;
10887
+ /**
10888
+ * Output only. The type of the node.
10889
+ */
10890
+ type?: string | null;
10891
+ }
10699
10892
  /**
10700
10893
  * Describes widget UI branding settings.
10701
10894
  */
@@ -10767,7 +10960,7 @@ export namespace discoveryengine_v1alpha {
10767
10960
  */
10768
10961
  enableVisualContentSummary?: boolean | null;
10769
10962
  /**
10770
- * 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`
10963
+ * 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`
10771
10964
  */
10772
10965
  features?: {[key: string]: string} | null;
10773
10966
  /**
@@ -10937,6 +11130,10 @@ export namespace discoveryengine_v1alpha {
10937
11130
  * Optional. Customer policy for the assistant.
10938
11131
  */
10939
11132
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
11133
+ /**
11134
+ * Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
11135
+ */
11136
+ defaultWebGroundingToggleOff?: boolean | null;
10940
11137
  /**
10941
11138
  * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
10942
11139
  */
@@ -11955,13 +12152,17 @@ export namespace discoveryengine_v1alpha {
11955
12152
  */
11956
12153
  displayName?: string | null;
11957
12154
  /**
11958
- * 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`
12155
+ * 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`
11959
12156
  */
11960
12157
  features?: {[key: string]: string} | null;
11961
12158
  /**
11962
12159
  * 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.
11963
12160
  */
11964
12161
  industryVertical?: string | null;
12162
+ /**
12163
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
12164
+ */
12165
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
11965
12166
  /**
11966
12167
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
11967
12168
  */
@@ -12043,6 +12244,52 @@ export namespace discoveryengine_v1alpha {
12043
12244
  */
12044
12245
  companyName?: string | null;
12045
12246
  }
12247
+ /**
12248
+ * Configuration message for the Knowledge Graph.
12249
+ */
12250
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig {
12251
+ /**
12252
+ * Specify entity types to support.
12253
+ */
12254
+ cloudKnowledgeGraphTypes?: string[] | null;
12255
+ /**
12256
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
12257
+ */
12258
+ enableCloudKnowledgeGraph?: boolean | null;
12259
+ /**
12260
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
12261
+ */
12262
+ enablePrivateKnowledgeGraph?: boolean | null;
12263
+ /**
12264
+ * Optional. Feature config for the Knowledge Graph.
12265
+ */
12266
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig;
12267
+ /**
12268
+ * Specify entity types to support.
12269
+ */
12270
+ privateKnowledgeGraphTypes?: string[] | null;
12271
+ }
12272
+ /**
12273
+ * Feature config for the Knowledge Graph.
12274
+ */
12275
+ export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig {
12276
+ /**
12277
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
12278
+ */
12279
+ disablePrivateKgAutoComplete?: boolean | null;
12280
+ /**
12281
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
12282
+ */
12283
+ disablePrivateKgEnrichment?: boolean | null;
12284
+ /**
12285
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
12286
+ */
12287
+ disablePrivateKgQueryUiChips?: boolean | null;
12288
+ /**
12289
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
12290
+ */
12291
+ disablePrivateKgQueryUnderstanding?: boolean | null;
12292
+ }
12046
12293
  /**
12047
12294
  * Additional config specs for a Media Recommendation engine.
12048
12295
  */
@@ -12200,6 +12447,10 @@ export namespace discoveryengine_v1alpha {
12200
12447
  * 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.
12201
12448
  */
12202
12449
  enableStaticIndexingForBatchIngestion?: boolean | null;
12450
+ /**
12451
+ * 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.
12452
+ */
12453
+ initialFilterGroups?: string[] | null;
12203
12454
  }
12204
12455
  /**
12205
12456
  * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
@@ -12613,10 +12864,22 @@ export namespace discoveryengine_v1alpha {
12613
12864
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
12614
12865
  */
12615
12866
  effectiveSearchQpmThreshold?: string | null;
12867
+ /**
12868
+ * 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.
12869
+ */
12870
+ indexingCoreThresholdNextUpdateTime?: string | null;
12871
+ /**
12872
+ * 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.
12873
+ */
12874
+ searchQpmThresholdNextUpdateTime?: string | null;
12616
12875
  /**
12617
12876
  * Optional. The start time of the currently active billing subscription.
12618
12877
  */
12619
12878
  startTime?: string | null;
12879
+ /**
12880
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
12881
+ */
12882
+ terminateTime?: string | null;
12620
12883
  }
12621
12884
  /**
12622
12885
  * Customer provided configurations.
@@ -12933,7 +13196,7 @@ export namespace discoveryengine_v1alpha {
12933
13196
  */
12934
13197
  orderBy?: string | null;
12935
13198
  /**
12936
- * 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`
13199
+ * 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`
12937
13200
  */
12938
13201
  pageCategories?: string[] | null;
12939
13202
  /**
@@ -13382,7 +13645,7 @@ export namespace discoveryengine_v1alpha {
13382
13645
  */
13383
13646
  allowedFieldNames?: string[] | null;
13384
13647
  /**
13385
- * 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.
13648
+ * 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.
13386
13649
  */
13387
13650
  extractedFilterBehavior?: string | null;
13388
13651
  /**
@@ -14842,13 +15105,17 @@ export namespace discoveryengine_v1alpha {
14842
15105
  */
14843
15106
  displayName?: string | null;
14844
15107
  /**
14845
- * 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`
15108
+ * 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`
14846
15109
  */
14847
15110
  features?: {[key: string]: string} | null;
14848
15111
  /**
14849
15112
  * 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.
14850
15113
  */
14851
15114
  industryVertical?: string | null;
15115
+ /**
15116
+ * Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
15117
+ */
15118
+ knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
14852
15119
  /**
14853
15120
  * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
14854
15121
  */
@@ -14930,6 +15197,52 @@ export namespace discoveryengine_v1alpha {
14930
15197
  */
14931
15198
  companyName?: string | null;
14932
15199
  }
15200
+ /**
15201
+ * Configuration message for the Knowledge Graph.
15202
+ */
15203
+ export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig {
15204
+ /**
15205
+ * Specify entity types to support.
15206
+ */
15207
+ cloudKnowledgeGraphTypes?: string[] | null;
15208
+ /**
15209
+ * Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
15210
+ */
15211
+ enableCloudKnowledgeGraph?: boolean | null;
15212
+ /**
15213
+ * Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
15214
+ */
15215
+ enablePrivateKnowledgeGraph?: boolean | null;
15216
+ /**
15217
+ * Optional. Feature config for the Knowledge Graph.
15218
+ */
15219
+ featureConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig;
15220
+ /**
15221
+ * Specify entity types to support.
15222
+ */
15223
+ privateKnowledgeGraphTypes?: string[] | null;
15224
+ }
15225
+ /**
15226
+ * Feature config for the Knowledge Graph.
15227
+ */
15228
+ export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig {
15229
+ /**
15230
+ * Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
15231
+ */
15232
+ disablePrivateKgAutoComplete?: boolean | null;
15233
+ /**
15234
+ * Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
15235
+ */
15236
+ disablePrivateKgEnrichment?: boolean | null;
15237
+ /**
15238
+ * Whether to disable the private KG for query UI chips. Defaults to false if not specified.
15239
+ */
15240
+ disablePrivateKgQueryUiChips?: boolean | null;
15241
+ /**
15242
+ * Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
15243
+ */
15244
+ disablePrivateKgQueryUnderstanding?: boolean | null;
15245
+ }
14933
15246
  /**
14934
15247
  * Additional config specs for a Media Recommendation engine.
14935
15248
  */
@@ -15028,6 +15341,10 @@ export namespace discoveryengine_v1alpha {
15028
15341
  * 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.
15029
15342
  */
15030
15343
  enableStaticIndexingForBatchIngestion?: boolean | null;
15344
+ /**
15345
+ * 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.
15346
+ */
15347
+ initialFilterGroups?: string[] | null;
15031
15348
  }
15032
15349
  /**
15033
15350
  * IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
@@ -15340,10 +15657,22 @@ export namespace discoveryengine_v1alpha {
15340
15657
  * Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
15341
15658
  */
15342
15659
  effectiveSearchQpmThreshold?: string | null;
15660
+ /**
15661
+ * 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.
15662
+ */
15663
+ indexingCoreThresholdNextUpdateTime?: string | null;
15664
+ /**
15665
+ * 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.
15666
+ */
15667
+ searchQpmThresholdNextUpdateTime?: string | null;
15343
15668
  /**
15344
15669
  * Optional. The start time of the currently active billing subscription.
15345
15670
  */
15346
15671
  startTime?: string | null;
15672
+ /**
15673
+ * Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
15674
+ */
15675
+ terminateTime?: string | null;
15347
15676
  }
15348
15677
  /**
15349
15678
  * Customer provided configurations.
@@ -16186,7 +16515,7 @@ export namespace discoveryengine_v1alpha {
16186
16515
  names?: string[] | null;
16187
16516
  }
16188
16517
  /**
16189
- * Request for SourceService.BatchDeleteSourcesRequest method.
16518
+ * Request for BatchDeleteSourcesRequest method.
16190
16519
  */
16191
16520
  export interface Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest {
16192
16521
  /**
@@ -16241,10 +16570,18 @@ export namespace discoveryengine_v1alpha {
16241
16570
  * Indicates an error occurred while ingesting the source.
16242
16571
  */
16243
16572
  ingestionError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError;
16573
+ /**
16574
+ * Indicates that the source MIME type is blocked.
16575
+ */
16576
+ mimeTypeBlocked?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked;
16244
16577
  /**
16245
16578
  * Indicates that the source is paywalled and cannot be ingested.
16246
16579
  */
16247
16580
  paywallError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError;
16581
+ /**
16582
+ * Indicates that the policy check failed.
16583
+ */
16584
+ policyCheckFailed?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed;
16248
16585
  /**
16249
16586
  * Indicates that the source is empty.
16250
16587
  */
@@ -16316,10 +16653,18 @@ export namespace discoveryengine_v1alpha {
16316
16653
  * Indicates an error occurred while ingesting the source.
16317
16654
  */
16318
16655
  export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError {}
16656
+ /**
16657
+ * Indicates that the source MIME type is blocked.
16658
+ */
16659
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked {}
16319
16660
  /**
16320
16661
  * Indicates that the source is paywalled and cannot be ingested.
16321
16662
  */
16322
16663
  export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError {}
16664
+ /**
16665
+ * Indicates that the policy check failed.
16666
+ */
16667
+ export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed {}
16323
16668
  /**
16324
16669
  * Indicates that the source is empty.
16325
16670
  */
@@ -17852,7 +18197,7 @@ export namespace discoveryengine_v1alpha {
17852
18197
  * const res = await discoveryengine.projects.patch({
17853
18198
  * // 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.
17854
18199
  * name: 'projects/my-project',
17855
- * // Optional. The list of fields to update. Supported fields: * `customer_provided_config`
18200
+ * // Optional. The list of fields to update. Supported fields: * `customer_provided_config` * `customer_provided_config.notebooklm_config.observability_config`
17856
18201
  * updateMask: 'placeholder-value',
17857
18202
  *
17858
18203
  * // Request body metadata
@@ -18321,7 +18666,7 @@ export namespace discoveryengine_v1alpha {
18321
18666
  */
18322
18667
  name?: string;
18323
18668
  /**
18324
- * Optional. The list of fields to update. Supported fields: * `customer_provided_config`
18669
+ * Optional. The list of fields to update. Supported fields: * `customer_provided_config` * `customer_provided_config.notebooklm_config.observability_config`
18325
18670
  */
18326
18671
  updateMask?: string;
18327
18672
 
@@ -24308,7 +24653,7 @@ export namespace discoveryengine_v1alpha {
24308
24653
  }
24309
24654
 
24310
24655
  /**
24311
- * Completes the specified user input with keyword suggestions.
24656
+ * 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.
24312
24657
  * @example
24313
24658
  * ```js
24314
24659
  * // Before running the sample:
@@ -24331,7 +24676,6 @@ export namespace discoveryengine_v1alpha {
24331
24676
  * // Scopes can be specified either as an array or as a single, space-delimited string.
24332
24677
  * scopes: [
24333
24678
  * 'https://www.googleapis.com/auth/cloud-platform',
24334
- * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
24335
24679
  * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
24336
24680
  * ],
24337
24681
  * });
@@ -24342,27 +24686,31 @@ export namespace discoveryengine_v1alpha {
24342
24686
  *
24343
24687
  * // Do the magic
24344
24688
  * const res =
24345
- * await discoveryengine.projects.locations.collections.dataStores.completeQuery(
24689
+ * await discoveryengine.projects.locations.collections.dataStores.addPatientFilter(
24346
24690
  * {
24347
- * // 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`.
24691
+ * // 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.
24348
24692
  * dataStore:
24349
24693
  * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
24350
- * // 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.
24351
- * includeTailSuggestions: 'placeholder-value',
24352
- * // Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
24353
- * query: 'placeholder-value',
24354
- * // 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.
24355
- * queryModel: 'placeholder-value',
24356
- * // 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.
24357
- * userPseudoId: 'placeholder-value',
24694
+ *
24695
+ * // Request body metadata
24696
+ * requestBody: {
24697
+ * // request body parameters
24698
+ * // {
24699
+ * // "dataStore": "my_dataStore",
24700
+ * // "filterGroups": []
24701
+ * // }
24702
+ * },
24358
24703
  * },
24359
24704
  * );
24360
24705
  * console.log(res.data);
24361
24706
  *
24362
24707
  * // Example response
24363
24708
  * // {
24364
- * // "querySuggestions": [],
24365
- * // "tailMatchTriggered": false
24709
+ * // "done": false,
24710
+ * // "error": {},
24711
+ * // "metadata": {},
24712
+ * // "name": "my_name",
24713
+ * // "response": {}
24366
24714
  * // }
24367
24715
  * }
24368
24716
  *
@@ -24378,62 +24726,58 @@ export namespace discoveryengine_v1alpha {
24378
24726
  * @param callback - Optional callback that handles the response.
24379
24727
  * @returns A promise if used with async/await, or void if used with a callback.
24380
24728
  */
24381
- completeQuery(
24382
- params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24729
+ addPatientFilter(
24730
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter,
24383
24731
  options: StreamMethodOptions
24384
24732
  ): Promise<GaxiosResponseWithHTTP2<Readable>>;
24385
- completeQuery(
24386
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24733
+ addPatientFilter(
24734
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter,
24387
24735
  options?: MethodOptions
24388
- ): Promise<
24389
- GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24390
- >;
24391
- completeQuery(
24392
- params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24736
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
24737
+ addPatientFilter(
24738
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter,
24393
24739
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
24394
24740
  callback: BodyResponseCallback<Readable>
24395
24741
  ): void;
24396
- completeQuery(
24397
- params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24742
+ addPatientFilter(
24743
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter,
24398
24744
  options:
24399
24745
  | MethodOptions
24400
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>,
24401
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24746
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
24747
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
24402
24748
  ): void;
24403
- completeQuery(
24404
- params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24405
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24749
+ addPatientFilter(
24750
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter,
24751
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
24406
24752
  ): void;
24407
- completeQuery(
24408
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24753
+ addPatientFilter(
24754
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
24409
24755
  ): void;
24410
- completeQuery(
24756
+ addPatientFilter(
24411
24757
  paramsOrCallback?:
24412
- | Params$Resource$Projects$Locations$Collections$Datastores$Completequery
24413
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24758
+ | Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter
24759
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
24414
24760
  | BodyResponseCallback<Readable>,
24415
24761
  optionsOrCallback?:
24416
24762
  | MethodOptions
24417
24763
  | StreamMethodOptions
24418
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24764
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
24419
24765
  | BodyResponseCallback<Readable>,
24420
24766
  callback?:
24421
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24767
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
24422
24768
  | BodyResponseCallback<Readable>
24423
24769
  ):
24424
24770
  | void
24425
- | Promise<
24426
- GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24427
- >
24771
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
24428
24772
  | Promise<GaxiosResponseWithHTTP2<Readable>> {
24429
24773
  let params = (paramsOrCallback ||
24430
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery;
24774
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter;
24431
24775
  let options = (optionsOrCallback || {}) as MethodOptions;
24432
24776
 
24433
24777
  if (typeof paramsOrCallback === 'function') {
24434
24778
  callback = paramsOrCallback;
24435
24779
  params =
24436
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery;
24780
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter;
24437
24781
  options = {};
24438
24782
  }
24439
24783
 
@@ -24447,11 +24791,11 @@ export namespace discoveryengine_v1alpha {
24447
24791
  const parameters = {
24448
24792
  options: Object.assign(
24449
24793
  {
24450
- url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace(
24794
+ url: (rootUrl + '/v1alpha/{+dataStore}:addPatientFilter').replace(
24451
24795
  /([^:]\/)\/+/g,
24452
24796
  '$1'
24453
24797
  ),
24454
- method: 'GET',
24798
+ method: 'POST',
24455
24799
  apiVersion: '',
24456
24800
  },
24457
24801
  options
@@ -24462,19 +24806,183 @@ export namespace discoveryengine_v1alpha {
24462
24806
  context: this.context,
24463
24807
  };
24464
24808
  if (callback) {
24465
- createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>(
24809
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
24466
24810
  parameters,
24467
24811
  callback as BodyResponseCallback<unknown>
24468
24812
  );
24469
24813
  } else {
24470
- return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>(
24471
- parameters
24472
- );
24814
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
24473
24815
  }
24474
24816
  }
24475
24817
 
24476
24818
  /**
24477
- * 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.
24819
+ * Completes the specified user input with keyword suggestions.
24820
+ * @example
24821
+ * ```js
24822
+ * // Before running the sample:
24823
+ * // - Enable the API at:
24824
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
24825
+ * // - Login into gcloud by running:
24826
+ * // ```sh
24827
+ * // $ gcloud auth application-default login
24828
+ * // ```
24829
+ * // - Install the npm module by running:
24830
+ * // ```sh
24831
+ * // $ npm install googleapis
24832
+ * // ```
24833
+ *
24834
+ * const {google} = require('googleapis');
24835
+ * const discoveryengine = google.discoveryengine('v1alpha');
24836
+ *
24837
+ * async function main() {
24838
+ * const auth = new google.auth.GoogleAuth({
24839
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
24840
+ * scopes: [
24841
+ * 'https://www.googleapis.com/auth/cloud-platform',
24842
+ * 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
24843
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
24844
+ * ],
24845
+ * });
24846
+ *
24847
+ * // Acquire an auth client, and bind it to all future calls
24848
+ * const authClient = await auth.getClient();
24849
+ * google.options({auth: authClient});
24850
+ *
24851
+ * // Do the magic
24852
+ * const res =
24853
+ * await discoveryengine.projects.locations.collections.dataStores.completeQuery(
24854
+ * {
24855
+ * // 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`.
24856
+ * dataStore:
24857
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
24858
+ * // 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.
24859
+ * includeTailSuggestions: 'placeholder-value',
24860
+ * // Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
24861
+ * query: 'placeholder-value',
24862
+ * // 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.
24863
+ * queryModel: 'placeholder-value',
24864
+ * // 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.
24865
+ * userPseudoId: 'placeholder-value',
24866
+ * },
24867
+ * );
24868
+ * console.log(res.data);
24869
+ *
24870
+ * // Example response
24871
+ * // {
24872
+ * // "querySuggestions": [],
24873
+ * // "tailMatchTriggered": false
24874
+ * // }
24875
+ * }
24876
+ *
24877
+ * main().catch(e => {
24878
+ * console.error(e);
24879
+ * throw e;
24880
+ * });
24881
+ *
24882
+ * ```
24883
+ *
24884
+ * @param params - Parameters for request
24885
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
24886
+ * @param callback - Optional callback that handles the response.
24887
+ * @returns A promise if used with async/await, or void if used with a callback.
24888
+ */
24889
+ completeQuery(
24890
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24891
+ options: StreamMethodOptions
24892
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
24893
+ completeQuery(
24894
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24895
+ options?: MethodOptions
24896
+ ): Promise<
24897
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24898
+ >;
24899
+ completeQuery(
24900
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24901
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
24902
+ callback: BodyResponseCallback<Readable>
24903
+ ): void;
24904
+ completeQuery(
24905
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24906
+ options:
24907
+ | MethodOptions
24908
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>,
24909
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24910
+ ): void;
24911
+ completeQuery(
24912
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery,
24913
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24914
+ ): void;
24915
+ completeQuery(
24916
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24917
+ ): void;
24918
+ completeQuery(
24919
+ paramsOrCallback?:
24920
+ | Params$Resource$Projects$Locations$Collections$Datastores$Completequery
24921
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24922
+ | BodyResponseCallback<Readable>,
24923
+ optionsOrCallback?:
24924
+ | MethodOptions
24925
+ | StreamMethodOptions
24926
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24927
+ | BodyResponseCallback<Readable>,
24928
+ callback?:
24929
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24930
+ | BodyResponseCallback<Readable>
24931
+ ):
24932
+ | void
24933
+ | Promise<
24934
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>
24935
+ >
24936
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
24937
+ let params = (paramsOrCallback ||
24938
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery;
24939
+ let options = (optionsOrCallback || {}) as MethodOptions;
24940
+
24941
+ if (typeof paramsOrCallback === 'function') {
24942
+ callback = paramsOrCallback;
24943
+ params =
24944
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery;
24945
+ options = {};
24946
+ }
24947
+
24948
+ if (typeof optionsOrCallback === 'function') {
24949
+ callback = optionsOrCallback;
24950
+ options = {};
24951
+ }
24952
+
24953
+ const rootUrl =
24954
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
24955
+ const parameters = {
24956
+ options: Object.assign(
24957
+ {
24958
+ url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace(
24959
+ /([^:]\/)\/+/g,
24960
+ '$1'
24961
+ ),
24962
+ method: 'GET',
24963
+ apiVersion: '',
24964
+ },
24965
+ options
24966
+ ),
24967
+ params,
24968
+ requiredParams: ['dataStore'],
24969
+ pathParams: ['dataStore'],
24970
+ context: this.context,
24971
+ };
24972
+ if (callback) {
24973
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>(
24974
+ parameters,
24975
+ callback as BodyResponseCallback<unknown>
24976
+ );
24977
+ } else {
24978
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse>(
24979
+ parameters
24980
+ );
24981
+ }
24982
+ }
24983
+
24984
+ /**
24985
+ * 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.
24478
24986
  * @example
24479
24987
  * ```js
24480
24988
  * // Before running the sample:
@@ -24816,6 +25324,167 @@ export namespace discoveryengine_v1alpha {
24816
25324
  }
24817
25325
  }
24818
25326
 
25327
+ /**
25328
+ * 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.
25329
+ * @example
25330
+ * ```js
25331
+ * // Before running the sample:
25332
+ * // - Enable the API at:
25333
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
25334
+ * // - Login into gcloud by running:
25335
+ * // ```sh
25336
+ * // $ gcloud auth application-default login
25337
+ * // ```
25338
+ * // - Install the npm module by running:
25339
+ * // ```sh
25340
+ * // $ npm install googleapis
25341
+ * // ```
25342
+ *
25343
+ * const {google} = require('googleapis');
25344
+ * const discoveryengine = google.discoveryengine('v1alpha');
25345
+ *
25346
+ * async function main() {
25347
+ * const auth = new google.auth.GoogleAuth({
25348
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
25349
+ * scopes: [
25350
+ * 'https://www.googleapis.com/auth/cloud-platform',
25351
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25352
+ * ],
25353
+ * });
25354
+ *
25355
+ * // Acquire an auth client, and bind it to all future calls
25356
+ * const authClient = await auth.getClient();
25357
+ * google.options({auth: authClient});
25358
+ *
25359
+ * // Do the magic
25360
+ * const res =
25361
+ * await discoveryengine.projects.locations.collections.dataStores.deletePatientFilter(
25362
+ * {
25363
+ * // 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.
25364
+ * dataStore:
25365
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
25366
+ *
25367
+ * // Request body metadata
25368
+ * requestBody: {
25369
+ * // request body parameters
25370
+ * // {
25371
+ * // "dataStore": "my_dataStore"
25372
+ * // }
25373
+ * },
25374
+ * },
25375
+ * );
25376
+ * console.log(res.data);
25377
+ *
25378
+ * // Example response
25379
+ * // {
25380
+ * // "done": false,
25381
+ * // "error": {},
25382
+ * // "metadata": {},
25383
+ * // "name": "my_name",
25384
+ * // "response": {}
25385
+ * // }
25386
+ * }
25387
+ *
25388
+ * main().catch(e => {
25389
+ * console.error(e);
25390
+ * throw e;
25391
+ * });
25392
+ *
25393
+ * ```
25394
+ *
25395
+ * @param params - Parameters for request
25396
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25397
+ * @param callback - Optional callback that handles the response.
25398
+ * @returns A promise if used with async/await, or void if used with a callback.
25399
+ */
25400
+ deletePatientFilter(
25401
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter,
25402
+ options: StreamMethodOptions
25403
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
25404
+ deletePatientFilter(
25405
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter,
25406
+ options?: MethodOptions
25407
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
25408
+ deletePatientFilter(
25409
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter,
25410
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
25411
+ callback: BodyResponseCallback<Readable>
25412
+ ): void;
25413
+ deletePatientFilter(
25414
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter,
25415
+ options:
25416
+ | MethodOptions
25417
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
25418
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
25419
+ ): void;
25420
+ deletePatientFilter(
25421
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter,
25422
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
25423
+ ): void;
25424
+ deletePatientFilter(
25425
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
25426
+ ): void;
25427
+ deletePatientFilter(
25428
+ paramsOrCallback?:
25429
+ | Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter
25430
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
25431
+ | BodyResponseCallback<Readable>,
25432
+ optionsOrCallback?:
25433
+ | MethodOptions
25434
+ | StreamMethodOptions
25435
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
25436
+ | BodyResponseCallback<Readable>,
25437
+ callback?:
25438
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
25439
+ | BodyResponseCallback<Readable>
25440
+ ):
25441
+ | void
25442
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
25443
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
25444
+ let params = (paramsOrCallback ||
25445
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter;
25446
+ let options = (optionsOrCallback || {}) as MethodOptions;
25447
+
25448
+ if (typeof paramsOrCallback === 'function') {
25449
+ callback = paramsOrCallback;
25450
+ params =
25451
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter;
25452
+ options = {};
25453
+ }
25454
+
25455
+ if (typeof optionsOrCallback === 'function') {
25456
+ callback = optionsOrCallback;
25457
+ options = {};
25458
+ }
25459
+
25460
+ const rootUrl =
25461
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
25462
+ const parameters = {
25463
+ options: Object.assign(
25464
+ {
25465
+ url: (
25466
+ rootUrl + '/v1alpha/{+dataStore}:deletePatientFilter'
25467
+ ).replace(/([^:]\/)\/+/g, '$1'),
25468
+ method: 'POST',
25469
+ apiVersion: '',
25470
+ },
25471
+ options
25472
+ ),
25473
+ params,
25474
+ requiredParams: ['dataStore'],
25475
+ pathParams: ['dataStore'],
25476
+ context: this.context,
25477
+ };
25478
+ if (callback) {
25479
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
25480
+ parameters,
25481
+ callback as BodyResponseCallback<unknown>
25482
+ );
25483
+ } else {
25484
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
25485
+ }
25486
+ }
25487
+
24819
25488
  /**
24820
25489
  * Gets a DataStore.
24821
25490
  * @example
@@ -25664,6 +26333,330 @@ export namespace discoveryengine_v1alpha {
25664
26333
  }
25665
26334
  }
25666
26335
 
26336
+ /**
26337
+ * 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.
26338
+ * @example
26339
+ * ```js
26340
+ * // Before running the sample:
26341
+ * // - Enable the API at:
26342
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
26343
+ * // - Login into gcloud by running:
26344
+ * // ```sh
26345
+ * // $ gcloud auth application-default login
26346
+ * // ```
26347
+ * // - Install the npm module by running:
26348
+ * // ```sh
26349
+ * // $ npm install googleapis
26350
+ * // ```
26351
+ *
26352
+ * const {google} = require('googleapis');
26353
+ * const discoveryengine = google.discoveryengine('v1alpha');
26354
+ *
26355
+ * async function main() {
26356
+ * const auth = new google.auth.GoogleAuth({
26357
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
26358
+ * scopes: [
26359
+ * 'https://www.googleapis.com/auth/cloud-platform',
26360
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
26361
+ * ],
26362
+ * });
26363
+ *
26364
+ * // Acquire an auth client, and bind it to all future calls
26365
+ * const authClient = await auth.getClient();
26366
+ * google.options({auth: authClient});
26367
+ *
26368
+ * // Do the magic
26369
+ * const res =
26370
+ * await discoveryengine.projects.locations.collections.dataStores.removePatientFilter(
26371
+ * {
26372
+ * // 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
26373
+ * dataStore:
26374
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
26375
+ *
26376
+ * // Request body metadata
26377
+ * requestBody: {
26378
+ * // request body parameters
26379
+ * // {
26380
+ * // "dataStore": "my_dataStore",
26381
+ * // "filterGroups": []
26382
+ * // }
26383
+ * },
26384
+ * },
26385
+ * );
26386
+ * console.log(res.data);
26387
+ *
26388
+ * // Example response
26389
+ * // {
26390
+ * // "done": false,
26391
+ * // "error": {},
26392
+ * // "metadata": {},
26393
+ * // "name": "my_name",
26394
+ * // "response": {}
26395
+ * // }
26396
+ * }
26397
+ *
26398
+ * main().catch(e => {
26399
+ * console.error(e);
26400
+ * throw e;
26401
+ * });
26402
+ *
26403
+ * ```
26404
+ *
26405
+ * @param params - Parameters for request
26406
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
26407
+ * @param callback - Optional callback that handles the response.
26408
+ * @returns A promise if used with async/await, or void if used with a callback.
26409
+ */
26410
+ removePatientFilter(
26411
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter,
26412
+ options: StreamMethodOptions
26413
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
26414
+ removePatientFilter(
26415
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter,
26416
+ options?: MethodOptions
26417
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
26418
+ removePatientFilter(
26419
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter,
26420
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
26421
+ callback: BodyResponseCallback<Readable>
26422
+ ): void;
26423
+ removePatientFilter(
26424
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter,
26425
+ options:
26426
+ | MethodOptions
26427
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
26428
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
26429
+ ): void;
26430
+ removePatientFilter(
26431
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter,
26432
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
26433
+ ): void;
26434
+ removePatientFilter(
26435
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
26436
+ ): void;
26437
+ removePatientFilter(
26438
+ paramsOrCallback?:
26439
+ | Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter
26440
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
26441
+ | BodyResponseCallback<Readable>,
26442
+ optionsOrCallback?:
26443
+ | MethodOptions
26444
+ | StreamMethodOptions
26445
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
26446
+ | BodyResponseCallback<Readable>,
26447
+ callback?:
26448
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
26449
+ | BodyResponseCallback<Readable>
26450
+ ):
26451
+ | void
26452
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
26453
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
26454
+ let params = (paramsOrCallback ||
26455
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter;
26456
+ let options = (optionsOrCallback || {}) as MethodOptions;
26457
+
26458
+ if (typeof paramsOrCallback === 'function') {
26459
+ callback = paramsOrCallback;
26460
+ params =
26461
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter;
26462
+ options = {};
26463
+ }
26464
+
26465
+ if (typeof optionsOrCallback === 'function') {
26466
+ callback = optionsOrCallback;
26467
+ options = {};
26468
+ }
26469
+
26470
+ const rootUrl =
26471
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
26472
+ const parameters = {
26473
+ options: Object.assign(
26474
+ {
26475
+ url: (
26476
+ rootUrl + '/v1alpha/{+dataStore}:removePatientFilter'
26477
+ ).replace(/([^:]\/)\/+/g, '$1'),
26478
+ method: 'POST',
26479
+ apiVersion: '',
26480
+ },
26481
+ options
26482
+ ),
26483
+ params,
26484
+ requiredParams: ['dataStore'],
26485
+ pathParams: ['dataStore'],
26486
+ context: this.context,
26487
+ };
26488
+ if (callback) {
26489
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
26490
+ parameters,
26491
+ callback as BodyResponseCallback<unknown>
26492
+ );
26493
+ } else {
26494
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
26495
+ }
26496
+ }
26497
+
26498
+ /**
26499
+ * 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.
26500
+ * @example
26501
+ * ```js
26502
+ * // Before running the sample:
26503
+ * // - Enable the API at:
26504
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
26505
+ * // - Login into gcloud by running:
26506
+ * // ```sh
26507
+ * // $ gcloud auth application-default login
26508
+ * // ```
26509
+ * // - Install the npm module by running:
26510
+ * // ```sh
26511
+ * // $ npm install googleapis
26512
+ * // ```
26513
+ *
26514
+ * const {google} = require('googleapis');
26515
+ * const discoveryengine = google.discoveryengine('v1alpha');
26516
+ *
26517
+ * async function main() {
26518
+ * const auth = new google.auth.GoogleAuth({
26519
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
26520
+ * scopes: [
26521
+ * 'https://www.googleapis.com/auth/cloud-platform',
26522
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
26523
+ * ],
26524
+ * });
26525
+ *
26526
+ * // Acquire an auth client, and bind it to all future calls
26527
+ * const authClient = await auth.getClient();
26528
+ * google.options({auth: authClient});
26529
+ *
26530
+ * // Do the magic
26531
+ * const res =
26532
+ * await discoveryengine.projects.locations.collections.dataStores.replacePatientFilter(
26533
+ * {
26534
+ * // 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.
26535
+ * dataStore:
26536
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
26537
+ *
26538
+ * // Request body metadata
26539
+ * requestBody: {
26540
+ * // request body parameters
26541
+ * // {
26542
+ * // "dataStore": "my_dataStore",
26543
+ * // "filterGroups": []
26544
+ * // }
26545
+ * },
26546
+ * },
26547
+ * );
26548
+ * console.log(res.data);
26549
+ *
26550
+ * // Example response
26551
+ * // {
26552
+ * // "done": false,
26553
+ * // "error": {},
26554
+ * // "metadata": {},
26555
+ * // "name": "my_name",
26556
+ * // "response": {}
26557
+ * // }
26558
+ * }
26559
+ *
26560
+ * main().catch(e => {
26561
+ * console.error(e);
26562
+ * throw e;
26563
+ * });
26564
+ *
26565
+ * ```
26566
+ *
26567
+ * @param params - Parameters for request
26568
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
26569
+ * @param callback - Optional callback that handles the response.
26570
+ * @returns A promise if used with async/await, or void if used with a callback.
26571
+ */
26572
+ replacePatientFilter(
26573
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter,
26574
+ options: StreamMethodOptions
26575
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
26576
+ replacePatientFilter(
26577
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter,
26578
+ options?: MethodOptions
26579
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
26580
+ replacePatientFilter(
26581
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter,
26582
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
26583
+ callback: BodyResponseCallback<Readable>
26584
+ ): void;
26585
+ replacePatientFilter(
26586
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter,
26587
+ options:
26588
+ | MethodOptions
26589
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
26590
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
26591
+ ): void;
26592
+ replacePatientFilter(
26593
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter,
26594
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
26595
+ ): void;
26596
+ replacePatientFilter(
26597
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
26598
+ ): void;
26599
+ replacePatientFilter(
26600
+ paramsOrCallback?:
26601
+ | Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter
26602
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
26603
+ | BodyResponseCallback<Readable>,
26604
+ optionsOrCallback?:
26605
+ | MethodOptions
26606
+ | StreamMethodOptions
26607
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
26608
+ | BodyResponseCallback<Readable>,
26609
+ callback?:
26610
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
26611
+ | BodyResponseCallback<Readable>
26612
+ ):
26613
+ | void
26614
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
26615
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
26616
+ let params = (paramsOrCallback ||
26617
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter;
26618
+ let options = (optionsOrCallback || {}) as MethodOptions;
26619
+
26620
+ if (typeof paramsOrCallback === 'function') {
26621
+ callback = paramsOrCallback;
26622
+ params =
26623
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter;
26624
+ options = {};
26625
+ }
26626
+
26627
+ if (typeof optionsOrCallback === 'function') {
26628
+ callback = optionsOrCallback;
26629
+ options = {};
26630
+ }
26631
+
26632
+ const rootUrl =
26633
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
26634
+ const parameters = {
26635
+ options: Object.assign(
26636
+ {
26637
+ url: (
26638
+ rootUrl + '/v1alpha/{+dataStore}:replacePatientFilter'
26639
+ ).replace(/([^:]\/)\/+/g, '$1'),
26640
+ method: 'POST',
26641
+ apiVersion: '',
26642
+ },
26643
+ options
26644
+ ),
26645
+ params,
26646
+ requiredParams: ['dataStore'],
26647
+ pathParams: ['dataStore'],
26648
+ context: this.context,
26649
+ };
26650
+ if (callback) {
26651
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
26652
+ parameters,
26653
+ callback as BodyResponseCallback<unknown>
26654
+ );
26655
+ } else {
26656
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
26657
+ }
26658
+ }
26659
+
25667
26660
  /**
25668
26661
  * Trains a custom model.
25669
26662
  * @example
@@ -25998,6 +26991,17 @@ export namespace discoveryengine_v1alpha {
25998
26991
  }
25999
26992
  }
26000
26993
 
26994
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter extends StandardParameters {
26995
+ /**
26996
+ * 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.
26997
+ */
26998
+ dataStore?: string;
26999
+
27000
+ /**
27001
+ * Request body metadata
27002
+ */
27003
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest;
27004
+ }
26001
27005
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
26002
27006
  /**
26003
27007
  * 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`.
@@ -26057,6 +27061,17 @@ export namespace discoveryengine_v1alpha {
26057
27061
  */
26058
27062
  name?: string;
26059
27063
  }
27064
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter extends StandardParameters {
27065
+ /**
27066
+ * 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.
27067
+ */
27068
+ dataStore?: string;
27069
+
27070
+ /**
27071
+ * Request body metadata
27072
+ */
27073
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest;
27074
+ }
26060
27075
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Get extends StandardParameters {
26061
27076
  /**
26062
27077
  * 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.
@@ -26108,6 +27123,28 @@ export namespace discoveryengine_v1alpha {
26108
27123
  */
26109
27124
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
26110
27125
  }
27126
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter extends StandardParameters {
27127
+ /**
27128
+ * 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
27129
+ */
27130
+ dataStore?: string;
27131
+
27132
+ /**
27133
+ * Request body metadata
27134
+ */
27135
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest;
27136
+ }
27137
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter extends StandardParameters {
27138
+ /**
27139
+ * 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.
27140
+ */
27141
+ dataStore?: string;
27142
+
27143
+ /**
27144
+ * Request body metadata
27145
+ */
27146
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest;
27147
+ }
26111
27148
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel extends StandardParameters {
26112
27149
  /**
26113
27150
  * 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.
@@ -26348,7 +27385,7 @@ export namespace discoveryengine_v1alpha {
26348
27385
  * {
26349
27386
  * // 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.
26350
27387
  * name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche',
26351
- * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
27388
+ * // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
26352
27389
  * view: 'placeholder-value',
26353
27390
  * },
26354
27391
  * );
@@ -26507,7 +27544,7 @@ export namespace discoveryengine_v1alpha {
26507
27544
  * // Required. The parent data store resource name.
26508
27545
  * parent:
26509
27546
  * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
26510
- * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
27547
+ * // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
26511
27548
  * view: 'placeholder-value',
26512
27549
  * },
26513
27550
  * );
@@ -26647,7 +27684,7 @@ export namespace discoveryengine_v1alpha {
26647
27684
  */
26648
27685
  name?: string;
26649
27686
  /**
26650
- * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
27687
+ * The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
26651
27688
  */
26652
27689
  view?: string;
26653
27690
  }
@@ -26657,7 +27694,7 @@ export namespace discoveryengine_v1alpha {
26657
27694
  */
26658
27695
  parent?: string;
26659
27696
  /**
26660
- * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
27697
+ * The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
26661
27698
  */
26662
27699
  view?: string;
26663
27700
  }
@@ -41328,6 +42365,7 @@ export namespace discoveryengine_v1alpha {
41328
42365
  * // "llmEnabled": false,
41329
42366
  * // "minimumDataTermAccepted": false,
41330
42367
  * // "name": "my_name",
42368
+ * // "nodes": [],
41331
42369
  * // "resultDisplayType": "my_resultDisplayType",
41332
42370
  * // "solutionType": "my_solutionType",
41333
42371
  * // "uiBranding": {},
@@ -41517,6 +42555,7 @@ export namespace discoveryengine_v1alpha {
41517
42555
  * // "llmEnabled": false,
41518
42556
  * // "minimumDataTermAccepted": false,
41519
42557
  * // "name": "my_name",
42558
+ * // "nodes": [],
41520
42559
  * // "resultDisplayType": "my_resultDisplayType",
41521
42560
  * // "solutionType": "my_solutionType",
41522
42561
  * // "uiBranding": {},
@@ -41561,6 +42600,7 @@ export namespace discoveryengine_v1alpha {
41561
42600
  * // "llmEnabled": false,
41562
42601
  * // "minimumDataTermAccepted": false,
41563
42602
  * // "name": "my_name",
42603
+ * // "nodes": [],
41564
42604
  * // "resultDisplayType": "my_resultDisplayType",
41565
42605
  * // "solutionType": "my_solutionType",
41566
42606
  * // "uiBranding": {},
@@ -41812,6 +42852,7 @@ export namespace discoveryengine_v1alpha {
41812
42852
  * // "displayName": "my_displayName",
41813
42853
  * // "features": {},
41814
42854
  * // "industryVertical": "my_industryVertical",
42855
+ * // "knowledgeGraphConfig": {},
41815
42856
  * // "mediaRecommendationEngineConfig": {},
41816
42857
  * // "modelConfigs": {},
41817
42858
  * // "name": "my_name",
@@ -42137,6 +43178,7 @@ export namespace discoveryengine_v1alpha {
42137
43178
  * // "displayName": "my_displayName",
42138
43179
  * // "features": {},
42139
43180
  * // "industryVertical": "my_industryVertical",
43181
+ * // "knowledgeGraphConfig": {},
42140
43182
  * // "mediaRecommendationEngineConfig": {},
42141
43183
  * // "modelConfigs": {},
42142
43184
  * // "name": "my_name",
@@ -42625,6 +43667,7 @@ export namespace discoveryengine_v1alpha {
42625
43667
  * // "displayName": "my_displayName",
42626
43668
  * // "features": {},
42627
43669
  * // "industryVertical": "my_industryVertical",
43670
+ * // "knowledgeGraphConfig": {},
42628
43671
  * // "mediaRecommendationEngineConfig": {},
42629
43672
  * // "modelConfigs": {},
42630
43673
  * // "name": "my_name",
@@ -42652,6 +43695,7 @@ export namespace discoveryengine_v1alpha {
42652
43695
  * // "displayName": "my_displayName",
42653
43696
  * // "features": {},
42654
43697
  * // "industryVertical": "my_industryVertical",
43698
+ * // "knowledgeGraphConfig": {},
42655
43699
  * // "mediaRecommendationEngineConfig": {},
42656
43700
  * // "modelConfigs": {},
42657
43701
  * // "name": "my_name",
@@ -42827,6 +43871,7 @@ export namespace discoveryengine_v1alpha {
42827
43871
  * // "displayName": "my_displayName",
42828
43872
  * // "features": {},
42829
43873
  * // "industryVertical": "my_industryVertical",
43874
+ * // "knowledgeGraphConfig": {},
42830
43875
  * // "mediaRecommendationEngineConfig": {},
42831
43876
  * // "modelConfigs": {},
42832
43877
  * // "name": "my_name",
@@ -43005,6 +44050,7 @@ export namespace discoveryengine_v1alpha {
43005
44050
  * // "displayName": "my_displayName",
43006
44051
  * // "features": {},
43007
44052
  * // "industryVertical": "my_industryVertical",
44053
+ * // "knowledgeGraphConfig": {},
43008
44054
  * // "mediaRecommendationEngineConfig": {},
43009
44055
  * // "modelConfigs": {},
43010
44056
  * // "name": "my_name",
@@ -43549,6 +44595,323 @@ export namespace discoveryengine_v1alpha {
43549
44595
  return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
43550
44596
  }
43551
44597
  }
44598
+
44599
+ /**
44600
+ * Gets the AnalyticsConfig.
44601
+ * @example
44602
+ * ```js
44603
+ * // Before running the sample:
44604
+ * // - Enable the API at:
44605
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
44606
+ * // - Login into gcloud by running:
44607
+ * // ```sh
44608
+ * // $ gcloud auth application-default login
44609
+ * // ```
44610
+ * // - Install the npm module by running:
44611
+ * // ```sh
44612
+ * // $ npm install googleapis
44613
+ * // ```
44614
+ *
44615
+ * const {google} = require('googleapis');
44616
+ * const discoveryengine = google.discoveryengine('v1alpha');
44617
+ *
44618
+ * async function main() {
44619
+ * const auth = new google.auth.GoogleAuth({
44620
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
44621
+ * scopes: [
44622
+ * 'https://www.googleapis.com/auth/cloud-platform',
44623
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
44624
+ * ],
44625
+ * });
44626
+ *
44627
+ * // Acquire an auth client, and bind it to all future calls
44628
+ * const authClient = await auth.getClient();
44629
+ * google.options({auth: authClient});
44630
+ *
44631
+ * // Do the magic
44632
+ * const res =
44633
+ * await discoveryengine.projects.locations.collections.engines.analytics.getConfig(
44634
+ * {
44635
+ * // Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
44636
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/analytics/config',
44637
+ * },
44638
+ * );
44639
+ * console.log(res.data);
44640
+ *
44641
+ * // Example response
44642
+ * // {
44643
+ * // "name": "my_name",
44644
+ * // "userLevelMetricsEnabled": false
44645
+ * // }
44646
+ * }
44647
+ *
44648
+ * main().catch(e => {
44649
+ * console.error(e);
44650
+ * throw e;
44651
+ * });
44652
+ *
44653
+ * ```
44654
+ *
44655
+ * @param params - Parameters for request
44656
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
44657
+ * @param callback - Optional callback that handles the response.
44658
+ * @returns A promise if used with async/await, or void if used with a callback.
44659
+ */
44660
+ getConfig(
44661
+ params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig,
44662
+ options: StreamMethodOptions
44663
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
44664
+ getConfig(
44665
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig,
44666
+ options?: MethodOptions
44667
+ ): Promise<
44668
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44669
+ >;
44670
+ getConfig(
44671
+ params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig,
44672
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
44673
+ callback: BodyResponseCallback<Readable>
44674
+ ): void;
44675
+ getConfig(
44676
+ params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig,
44677
+ options:
44678
+ | MethodOptions
44679
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>,
44680
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44681
+ ): void;
44682
+ getConfig(
44683
+ params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig,
44684
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44685
+ ): void;
44686
+ getConfig(
44687
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44688
+ ): void;
44689
+ getConfig(
44690
+ paramsOrCallback?:
44691
+ | Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig
44692
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44693
+ | BodyResponseCallback<Readable>,
44694
+ optionsOrCallback?:
44695
+ | MethodOptions
44696
+ | StreamMethodOptions
44697
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44698
+ | BodyResponseCallback<Readable>,
44699
+ callback?:
44700
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44701
+ | BodyResponseCallback<Readable>
44702
+ ):
44703
+ | void
44704
+ | Promise<
44705
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44706
+ >
44707
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
44708
+ let params = (paramsOrCallback ||
44709
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig;
44710
+ let options = (optionsOrCallback || {}) as MethodOptions;
44711
+
44712
+ if (typeof paramsOrCallback === 'function') {
44713
+ callback = paramsOrCallback;
44714
+ params =
44715
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig;
44716
+ options = {};
44717
+ }
44718
+
44719
+ if (typeof optionsOrCallback === 'function') {
44720
+ callback = optionsOrCallback;
44721
+ options = {};
44722
+ }
44723
+
44724
+ const rootUrl =
44725
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
44726
+ const parameters = {
44727
+ options: Object.assign(
44728
+ {
44729
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
44730
+ method: 'GET',
44731
+ apiVersion: '',
44732
+ },
44733
+ options
44734
+ ),
44735
+ params,
44736
+ requiredParams: ['name'],
44737
+ pathParams: ['name'],
44738
+ context: this.context,
44739
+ };
44740
+ if (callback) {
44741
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>(
44742
+ parameters,
44743
+ callback as BodyResponseCallback<unknown>
44744
+ );
44745
+ } else {
44746
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>(
44747
+ parameters
44748
+ );
44749
+ }
44750
+ }
44751
+
44752
+ /**
44753
+ * Updates the AnalyticsConfig for analytics.
44754
+ * @example
44755
+ * ```js
44756
+ * // Before running the sample:
44757
+ * // - Enable the API at:
44758
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
44759
+ * // - Login into gcloud by running:
44760
+ * // ```sh
44761
+ * // $ gcloud auth application-default login
44762
+ * // ```
44763
+ * // - Install the npm module by running:
44764
+ * // ```sh
44765
+ * // $ npm install googleapis
44766
+ * // ```
44767
+ *
44768
+ * const {google} = require('googleapis');
44769
+ * const discoveryengine = google.discoveryengine('v1alpha');
44770
+ *
44771
+ * async function main() {
44772
+ * const auth = new google.auth.GoogleAuth({
44773
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
44774
+ * scopes: [
44775
+ * 'https://www.googleapis.com/auth/cloud-platform',
44776
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
44777
+ * ],
44778
+ * });
44779
+ *
44780
+ * // Acquire an auth client, and bind it to all future calls
44781
+ * const authClient = await auth.getClient();
44782
+ * google.options({auth: authClient});
44783
+ *
44784
+ * // Do the magic
44785
+ * const res =
44786
+ * await discoveryengine.projects.locations.collections.engines.analytics.updateConfig(
44787
+ * {
44788
+ * // Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
44789
+ * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/analytics/config',
44790
+ * // The list of fields of AnalyticsConfig to update. If not specified, the method will perform a full replacement.
44791
+ * updateMask: 'placeholder-value',
44792
+ *
44793
+ * // Request body metadata
44794
+ * requestBody: {
44795
+ * // request body parameters
44796
+ * // {
44797
+ * // "name": "my_name",
44798
+ * // "userLevelMetricsEnabled": false
44799
+ * // }
44800
+ * },
44801
+ * },
44802
+ * );
44803
+ * console.log(res.data);
44804
+ *
44805
+ * // Example response
44806
+ * // {
44807
+ * // "name": "my_name",
44808
+ * // "userLevelMetricsEnabled": false
44809
+ * // }
44810
+ * }
44811
+ *
44812
+ * main().catch(e => {
44813
+ * console.error(e);
44814
+ * throw e;
44815
+ * });
44816
+ *
44817
+ * ```
44818
+ *
44819
+ * @param params - Parameters for request
44820
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
44821
+ * @param callback - Optional callback that handles the response.
44822
+ * @returns A promise if used with async/await, or void if used with a callback.
44823
+ */
44824
+ updateConfig(
44825
+ params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig,
44826
+ options: StreamMethodOptions
44827
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
44828
+ updateConfig(
44829
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig,
44830
+ options?: MethodOptions
44831
+ ): Promise<
44832
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44833
+ >;
44834
+ updateConfig(
44835
+ params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig,
44836
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
44837
+ callback: BodyResponseCallback<Readable>
44838
+ ): void;
44839
+ updateConfig(
44840
+ params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig,
44841
+ options:
44842
+ | MethodOptions
44843
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>,
44844
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44845
+ ): void;
44846
+ updateConfig(
44847
+ params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig,
44848
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44849
+ ): void;
44850
+ updateConfig(
44851
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44852
+ ): void;
44853
+ updateConfig(
44854
+ paramsOrCallback?:
44855
+ | Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig
44856
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44857
+ | BodyResponseCallback<Readable>,
44858
+ optionsOrCallback?:
44859
+ | MethodOptions
44860
+ | StreamMethodOptions
44861
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44862
+ | BodyResponseCallback<Readable>,
44863
+ callback?:
44864
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44865
+ | BodyResponseCallback<Readable>
44866
+ ):
44867
+ | void
44868
+ | Promise<
44869
+ GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>
44870
+ >
44871
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
44872
+ let params = (paramsOrCallback ||
44873
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig;
44874
+ let options = (optionsOrCallback || {}) as MethodOptions;
44875
+
44876
+ if (typeof paramsOrCallback === 'function') {
44877
+ callback = paramsOrCallback;
44878
+ params =
44879
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig;
44880
+ options = {};
44881
+ }
44882
+
44883
+ if (typeof optionsOrCallback === 'function') {
44884
+ callback = optionsOrCallback;
44885
+ options = {};
44886
+ }
44887
+
44888
+ const rootUrl =
44889
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
44890
+ const parameters = {
44891
+ options: Object.assign(
44892
+ {
44893
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
44894
+ method: 'PATCH',
44895
+ apiVersion: '',
44896
+ },
44897
+ options
44898
+ ),
44899
+ params,
44900
+ requiredParams: ['name'],
44901
+ pathParams: ['name'],
44902
+ context: this.context,
44903
+ };
44904
+ if (callback) {
44905
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>(
44906
+ parameters,
44907
+ callback as BodyResponseCallback<unknown>
44908
+ );
44909
+ } else {
44910
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>(
44911
+ parameters
44912
+ );
44913
+ }
44914
+ }
43552
44915
  }
43553
44916
 
43554
44917
  export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics extends StandardParameters {
@@ -43562,6 +44925,27 @@ export namespace discoveryengine_v1alpha {
43562
44925
  */
43563
44926
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaExportMetricsRequest;
43564
44927
  }
44928
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig extends StandardParameters {
44929
+ /**
44930
+ * Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
44931
+ */
44932
+ name?: string;
44933
+ }
44934
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig extends StandardParameters {
44935
+ /**
44936
+ * Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
44937
+ */
44938
+ name?: string;
44939
+ /**
44940
+ * The list of fields of AnalyticsConfig to update. If not specified, the method will perform a full replacement.
44941
+ */
44942
+ updateMask?: string;
44943
+
44944
+ /**
44945
+ * Request body metadata
44946
+ */
44947
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig;
44948
+ }
43565
44949
 
43566
44950
  export class Resource$Projects$Locations$Collections$Engines$Assistants {
43567
44951
  context: APIRequestContext;
@@ -43627,6 +45011,7 @@ export namespace discoveryengine_v1alpha {
43627
45011
  * // request body parameters
43628
45012
  * // {
43629
45013
  * // "customerPolicy": {},
45014
+ * // "defaultWebGroundingToggleOff": false,
43630
45015
  * // "description": "my_description",
43631
45016
  * // "disableLocationContext": false,
43632
45017
  * // "displayName": "my_displayName",
@@ -43643,6 +45028,7 @@ export namespace discoveryengine_v1alpha {
43643
45028
  * // Example response
43644
45029
  * // {
43645
45030
  * // "customerPolicy": {},
45031
+ * // "defaultWebGroundingToggleOff": false,
43646
45032
  * // "description": "my_description",
43647
45033
  * // "disableLocationContext": false,
43648
45034
  * // "displayName": "my_displayName",
@@ -43947,6 +45333,7 @@ export namespace discoveryengine_v1alpha {
43947
45333
  * // Example response
43948
45334
  * // {
43949
45335
  * // "customerPolicy": {},
45336
+ * // "defaultWebGroundingToggleOff": false,
43950
45337
  * // "description": "my_description",
43951
45338
  * // "disableLocationContext": false,
43952
45339
  * // "displayName": "my_displayName",
@@ -44270,7 +45657,7 @@ export namespace discoveryengine_v1alpha {
44270
45657
  * languageCode: 'placeholder-value',
44271
45658
  * // Optional. The maximum number of suggested prompts to return per agent.
44272
45659
  * maxSuggestedPrompts: 'placeholder-value',
44273
- * // 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.
45660
+ * // 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.
44274
45661
  * pageSize: 'placeholder-value',
44275
45662
  * // 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.
44276
45663
  * pageToken: 'placeholder-value',
@@ -44443,6 +45830,7 @@ export namespace discoveryengine_v1alpha {
44443
45830
  * // request body parameters
44444
45831
  * // {
44445
45832
  * // "customerPolicy": {},
45833
+ * // "defaultWebGroundingToggleOff": false,
44446
45834
  * // "description": "my_description",
44447
45835
  * // "disableLocationContext": false,
44448
45836
  * // "displayName": "my_displayName",
@@ -44459,6 +45847,7 @@ export namespace discoveryengine_v1alpha {
44459
45847
  * // Example response
44460
45848
  * // {
44461
45849
  * // "customerPolicy": {},
45850
+ * // "defaultWebGroundingToggleOff": false,
44462
45851
  * // "description": "my_description",
44463
45852
  * // "disableLocationContext": false,
44464
45853
  * // "displayName": "my_displayName",
@@ -44808,7 +46197,7 @@ export namespace discoveryengine_v1alpha {
44808
46197
  */
44809
46198
  maxSuggestedPrompts?: number;
44810
46199
  /**
44811
- * 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.
46200
+ * 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.
44812
46201
  */
44813
46202
  pageSize?: number;
44814
46203
  /**
@@ -45258,6 +46647,8 @@ export namespace discoveryengine_v1alpha {
45258
46647
  * {
45259
46648
  * // Required. The name of the Agent to disable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
45260
46649
  * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
46650
+ * // Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.
46651
+ * revisionId: 'placeholder-value',
45261
46652
  * },
45262
46653
  * );
45263
46654
  * console.log(res.data);
@@ -45432,6 +46823,8 @@ export namespace discoveryengine_v1alpha {
45432
46823
  * {
45433
46824
  * // Required. The name of the Agent to enable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
45434
46825
  * name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
46826
+ * // Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.
46827
+ * revisionId: 'placeholder-value',
45435
46828
  * },
45436
46829
  * );
45437
46830
  * console.log(res.data);
@@ -46774,12 +48167,20 @@ export namespace discoveryengine_v1alpha {
46774
48167
  * Required. The name of the Agent to disable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
46775
48168
  */
46776
48169
  name?: string;
48170
+ /**
48171
+ * Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.
48172
+ */
48173
+ revisionId?: string;
46777
48174
  }
46778
48175
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent extends StandardParameters {
46779
48176
  /**
46780
48177
  * Required. The name of the Agent to enable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
46781
48178
  */
46782
48179
  name?: string;
48180
+ /**
48181
+ * Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.
48182
+ */
48183
+ revisionId?: string;
46783
48184
  }
46784
48185
  export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get extends StandardParameters {
46785
48186
  /**
@@ -54494,6 +55895,7 @@ export namespace discoveryengine_v1alpha {
54494
55895
  * // "llmEnabled": false,
54495
55896
  * // "minimumDataTermAccepted": false,
54496
55897
  * // "name": "my_name",
55898
+ * // "nodes": [],
54497
55899
  * // "resultDisplayType": "my_resultDisplayType",
54498
55900
  * // "solutionType": "my_solutionType",
54499
55901
  * // "uiBranding": {},
@@ -54683,6 +56085,7 @@ export namespace discoveryengine_v1alpha {
54683
56085
  * // "llmEnabled": false,
54684
56086
  * // "minimumDataTermAccepted": false,
54685
56087
  * // "name": "my_name",
56088
+ * // "nodes": [],
54686
56089
  * // "resultDisplayType": "my_resultDisplayType",
54687
56090
  * // "solutionType": "my_solutionType",
54688
56091
  * // "uiBranding": {},
@@ -54727,6 +56130,7 @@ export namespace discoveryengine_v1alpha {
54727
56130
  * // "llmEnabled": false,
54728
56131
  * // "minimumDataTermAccepted": false,
54729
56132
  * // "name": "my_name",
56133
+ * // "nodes": [],
54730
56134
  * // "resultDisplayType": "my_resultDisplayType",
54731
56135
  * // "solutionType": "my_solutionType",
54732
56136
  * // "uiBranding": {},
@@ -55280,6 +56684,167 @@ export namespace discoveryengine_v1alpha {
55280
56684
  new Resource$Projects$Locations$Datastores$Widgetconfigs(this.context);
55281
56685
  }
55282
56686
 
56687
+ /**
56688
+ * 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.
56689
+ * @example
56690
+ * ```js
56691
+ * // Before running the sample:
56692
+ * // - Enable the API at:
56693
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
56694
+ * // - Login into gcloud by running:
56695
+ * // ```sh
56696
+ * // $ gcloud auth application-default login
56697
+ * // ```
56698
+ * // - Install the npm module by running:
56699
+ * // ```sh
56700
+ * // $ npm install googleapis
56701
+ * // ```
56702
+ *
56703
+ * const {google} = require('googleapis');
56704
+ * const discoveryengine = google.discoveryengine('v1alpha');
56705
+ *
56706
+ * async function main() {
56707
+ * const auth = new google.auth.GoogleAuth({
56708
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
56709
+ * scopes: [
56710
+ * 'https://www.googleapis.com/auth/cloud-platform',
56711
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
56712
+ * ],
56713
+ * });
56714
+ *
56715
+ * // Acquire an auth client, and bind it to all future calls
56716
+ * const authClient = await auth.getClient();
56717
+ * google.options({auth: authClient});
56718
+ *
56719
+ * // Do the magic
56720
+ * const res =
56721
+ * await discoveryengine.projects.locations.dataStores.addPatientFilter({
56722
+ * // 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.
56723
+ * dataStore:
56724
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
56725
+ *
56726
+ * // Request body metadata
56727
+ * requestBody: {
56728
+ * // request body parameters
56729
+ * // {
56730
+ * // "dataStore": "my_dataStore",
56731
+ * // "filterGroups": []
56732
+ * // }
56733
+ * },
56734
+ * });
56735
+ * console.log(res.data);
56736
+ *
56737
+ * // Example response
56738
+ * // {
56739
+ * // "done": false,
56740
+ * // "error": {},
56741
+ * // "metadata": {},
56742
+ * // "name": "my_name",
56743
+ * // "response": {}
56744
+ * // }
56745
+ * }
56746
+ *
56747
+ * main().catch(e => {
56748
+ * console.error(e);
56749
+ * throw e;
56750
+ * });
56751
+ *
56752
+ * ```
56753
+ *
56754
+ * @param params - Parameters for request
56755
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
56756
+ * @param callback - Optional callback that handles the response.
56757
+ * @returns A promise if used with async/await, or void if used with a callback.
56758
+ */
56759
+ addPatientFilter(
56760
+ params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter,
56761
+ options: StreamMethodOptions
56762
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
56763
+ addPatientFilter(
56764
+ params?: Params$Resource$Projects$Locations$Datastores$Addpatientfilter,
56765
+ options?: MethodOptions
56766
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
56767
+ addPatientFilter(
56768
+ params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter,
56769
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
56770
+ callback: BodyResponseCallback<Readable>
56771
+ ): void;
56772
+ addPatientFilter(
56773
+ params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter,
56774
+ options:
56775
+ | MethodOptions
56776
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
56777
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
56778
+ ): void;
56779
+ addPatientFilter(
56780
+ params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter,
56781
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
56782
+ ): void;
56783
+ addPatientFilter(
56784
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
56785
+ ): void;
56786
+ addPatientFilter(
56787
+ paramsOrCallback?:
56788
+ | Params$Resource$Projects$Locations$Datastores$Addpatientfilter
56789
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
56790
+ | BodyResponseCallback<Readable>,
56791
+ optionsOrCallback?:
56792
+ | MethodOptions
56793
+ | StreamMethodOptions
56794
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
56795
+ | BodyResponseCallback<Readable>,
56796
+ callback?:
56797
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
56798
+ | BodyResponseCallback<Readable>
56799
+ ):
56800
+ | void
56801
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
56802
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
56803
+ let params = (paramsOrCallback ||
56804
+ {}) as Params$Resource$Projects$Locations$Datastores$Addpatientfilter;
56805
+ let options = (optionsOrCallback || {}) as MethodOptions;
56806
+
56807
+ if (typeof paramsOrCallback === 'function') {
56808
+ callback = paramsOrCallback;
56809
+ params =
56810
+ {} as Params$Resource$Projects$Locations$Datastores$Addpatientfilter;
56811
+ options = {};
56812
+ }
56813
+
56814
+ if (typeof optionsOrCallback === 'function') {
56815
+ callback = optionsOrCallback;
56816
+ options = {};
56817
+ }
56818
+
56819
+ const rootUrl =
56820
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
56821
+ const parameters = {
56822
+ options: Object.assign(
56823
+ {
56824
+ url: (rootUrl + '/v1alpha/{+dataStore}:addPatientFilter').replace(
56825
+ /([^:]\/)\/+/g,
56826
+ '$1'
56827
+ ),
56828
+ method: 'POST',
56829
+ apiVersion: '',
56830
+ },
56831
+ options
56832
+ ),
56833
+ params,
56834
+ requiredParams: ['dataStore'],
56835
+ pathParams: ['dataStore'],
56836
+ context: this.context,
56837
+ };
56838
+ if (callback) {
56839
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
56840
+ parameters,
56841
+ callback as BodyResponseCallback<unknown>
56842
+ );
56843
+ } else {
56844
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
56845
+ }
56846
+ }
56847
+
55283
56848
  /**
55284
56849
  * Completes the specified user input with keyword suggestions.
55285
56850
  * @example
@@ -55783,6 +57348,165 @@ export namespace discoveryengine_v1alpha {
55783
57348
  }
55784
57349
  }
55785
57350
 
57351
+ /**
57352
+ * 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.
57353
+ * @example
57354
+ * ```js
57355
+ * // Before running the sample:
57356
+ * // - Enable the API at:
57357
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
57358
+ * // - Login into gcloud by running:
57359
+ * // ```sh
57360
+ * // $ gcloud auth application-default login
57361
+ * // ```
57362
+ * // - Install the npm module by running:
57363
+ * // ```sh
57364
+ * // $ npm install googleapis
57365
+ * // ```
57366
+ *
57367
+ * const {google} = require('googleapis');
57368
+ * const discoveryengine = google.discoveryengine('v1alpha');
57369
+ *
57370
+ * async function main() {
57371
+ * const auth = new google.auth.GoogleAuth({
57372
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
57373
+ * scopes: [
57374
+ * 'https://www.googleapis.com/auth/cloud-platform',
57375
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
57376
+ * ],
57377
+ * });
57378
+ *
57379
+ * // Acquire an auth client, and bind it to all future calls
57380
+ * const authClient = await auth.getClient();
57381
+ * google.options({auth: authClient});
57382
+ *
57383
+ * // Do the magic
57384
+ * const res =
57385
+ * await discoveryengine.projects.locations.dataStores.deletePatientFilter({
57386
+ * // 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.
57387
+ * dataStore:
57388
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
57389
+ *
57390
+ * // Request body metadata
57391
+ * requestBody: {
57392
+ * // request body parameters
57393
+ * // {
57394
+ * // "dataStore": "my_dataStore"
57395
+ * // }
57396
+ * },
57397
+ * });
57398
+ * console.log(res.data);
57399
+ *
57400
+ * // Example response
57401
+ * // {
57402
+ * // "done": false,
57403
+ * // "error": {},
57404
+ * // "metadata": {},
57405
+ * // "name": "my_name",
57406
+ * // "response": {}
57407
+ * // }
57408
+ * }
57409
+ *
57410
+ * main().catch(e => {
57411
+ * console.error(e);
57412
+ * throw e;
57413
+ * });
57414
+ *
57415
+ * ```
57416
+ *
57417
+ * @param params - Parameters for request
57418
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
57419
+ * @param callback - Optional callback that handles the response.
57420
+ * @returns A promise if used with async/await, or void if used with a callback.
57421
+ */
57422
+ deletePatientFilter(
57423
+ params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter,
57424
+ options: StreamMethodOptions
57425
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
57426
+ deletePatientFilter(
57427
+ params?: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter,
57428
+ options?: MethodOptions
57429
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
57430
+ deletePatientFilter(
57431
+ params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter,
57432
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
57433
+ callback: BodyResponseCallback<Readable>
57434
+ ): void;
57435
+ deletePatientFilter(
57436
+ params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter,
57437
+ options:
57438
+ | MethodOptions
57439
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
57440
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
57441
+ ): void;
57442
+ deletePatientFilter(
57443
+ params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter,
57444
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
57445
+ ): void;
57446
+ deletePatientFilter(
57447
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
57448
+ ): void;
57449
+ deletePatientFilter(
57450
+ paramsOrCallback?:
57451
+ | Params$Resource$Projects$Locations$Datastores$Deletepatientfilter
57452
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
57453
+ | BodyResponseCallback<Readable>,
57454
+ optionsOrCallback?:
57455
+ | MethodOptions
57456
+ | StreamMethodOptions
57457
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
57458
+ | BodyResponseCallback<Readable>,
57459
+ callback?:
57460
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
57461
+ | BodyResponseCallback<Readable>
57462
+ ):
57463
+ | void
57464
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
57465
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
57466
+ let params = (paramsOrCallback ||
57467
+ {}) as Params$Resource$Projects$Locations$Datastores$Deletepatientfilter;
57468
+ let options = (optionsOrCallback || {}) as MethodOptions;
57469
+
57470
+ if (typeof paramsOrCallback === 'function') {
57471
+ callback = paramsOrCallback;
57472
+ params =
57473
+ {} as Params$Resource$Projects$Locations$Datastores$Deletepatientfilter;
57474
+ options = {};
57475
+ }
57476
+
57477
+ if (typeof optionsOrCallback === 'function') {
57478
+ callback = optionsOrCallback;
57479
+ options = {};
57480
+ }
57481
+
57482
+ const rootUrl =
57483
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
57484
+ const parameters = {
57485
+ options: Object.assign(
57486
+ {
57487
+ url: (
57488
+ rootUrl + '/v1alpha/{+dataStore}:deletePatientFilter'
57489
+ ).replace(/([^:]\/)\/+/g, '$1'),
57490
+ method: 'POST',
57491
+ apiVersion: '',
57492
+ },
57493
+ options
57494
+ ),
57495
+ params,
57496
+ requiredParams: ['dataStore'],
57497
+ pathParams: ['dataStore'],
57498
+ context: this.context,
57499
+ };
57500
+ if (callback) {
57501
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
57502
+ parameters,
57503
+ callback as BodyResponseCallback<unknown>
57504
+ );
57505
+ } else {
57506
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
57507
+ }
57508
+ }
57509
+
55786
57510
  /**
55787
57511
  * Gets a DataStore.
55788
57512
  * @example
@@ -56622,6 +58346,326 @@ export namespace discoveryengine_v1alpha {
56622
58346
  }
56623
58347
  }
56624
58348
 
58349
+ /**
58350
+ * 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.
58351
+ * @example
58352
+ * ```js
58353
+ * // Before running the sample:
58354
+ * // - Enable the API at:
58355
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
58356
+ * // - Login into gcloud by running:
58357
+ * // ```sh
58358
+ * // $ gcloud auth application-default login
58359
+ * // ```
58360
+ * // - Install the npm module by running:
58361
+ * // ```sh
58362
+ * // $ npm install googleapis
58363
+ * // ```
58364
+ *
58365
+ * const {google} = require('googleapis');
58366
+ * const discoveryengine = google.discoveryengine('v1alpha');
58367
+ *
58368
+ * async function main() {
58369
+ * const auth = new google.auth.GoogleAuth({
58370
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
58371
+ * scopes: [
58372
+ * 'https://www.googleapis.com/auth/cloud-platform',
58373
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
58374
+ * ],
58375
+ * });
58376
+ *
58377
+ * // Acquire an auth client, and bind it to all future calls
58378
+ * const authClient = await auth.getClient();
58379
+ * google.options({auth: authClient});
58380
+ *
58381
+ * // Do the magic
58382
+ * const res =
58383
+ * await discoveryengine.projects.locations.dataStores.removePatientFilter({
58384
+ * // 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
58385
+ * dataStore:
58386
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
58387
+ *
58388
+ * // Request body metadata
58389
+ * requestBody: {
58390
+ * // request body parameters
58391
+ * // {
58392
+ * // "dataStore": "my_dataStore",
58393
+ * // "filterGroups": []
58394
+ * // }
58395
+ * },
58396
+ * });
58397
+ * console.log(res.data);
58398
+ *
58399
+ * // Example response
58400
+ * // {
58401
+ * // "done": false,
58402
+ * // "error": {},
58403
+ * // "metadata": {},
58404
+ * // "name": "my_name",
58405
+ * // "response": {}
58406
+ * // }
58407
+ * }
58408
+ *
58409
+ * main().catch(e => {
58410
+ * console.error(e);
58411
+ * throw e;
58412
+ * });
58413
+ *
58414
+ * ```
58415
+ *
58416
+ * @param params - Parameters for request
58417
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
58418
+ * @param callback - Optional callback that handles the response.
58419
+ * @returns A promise if used with async/await, or void if used with a callback.
58420
+ */
58421
+ removePatientFilter(
58422
+ params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter,
58423
+ options: StreamMethodOptions
58424
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
58425
+ removePatientFilter(
58426
+ params?: Params$Resource$Projects$Locations$Datastores$Removepatientfilter,
58427
+ options?: MethodOptions
58428
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
58429
+ removePatientFilter(
58430
+ params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter,
58431
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
58432
+ callback: BodyResponseCallback<Readable>
58433
+ ): void;
58434
+ removePatientFilter(
58435
+ params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter,
58436
+ options:
58437
+ | MethodOptions
58438
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
58439
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
58440
+ ): void;
58441
+ removePatientFilter(
58442
+ params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter,
58443
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
58444
+ ): void;
58445
+ removePatientFilter(
58446
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
58447
+ ): void;
58448
+ removePatientFilter(
58449
+ paramsOrCallback?:
58450
+ | Params$Resource$Projects$Locations$Datastores$Removepatientfilter
58451
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
58452
+ | BodyResponseCallback<Readable>,
58453
+ optionsOrCallback?:
58454
+ | MethodOptions
58455
+ | StreamMethodOptions
58456
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
58457
+ | BodyResponseCallback<Readable>,
58458
+ callback?:
58459
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
58460
+ | BodyResponseCallback<Readable>
58461
+ ):
58462
+ | void
58463
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
58464
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
58465
+ let params = (paramsOrCallback ||
58466
+ {}) as Params$Resource$Projects$Locations$Datastores$Removepatientfilter;
58467
+ let options = (optionsOrCallback || {}) as MethodOptions;
58468
+
58469
+ if (typeof paramsOrCallback === 'function') {
58470
+ callback = paramsOrCallback;
58471
+ params =
58472
+ {} as Params$Resource$Projects$Locations$Datastores$Removepatientfilter;
58473
+ options = {};
58474
+ }
58475
+
58476
+ if (typeof optionsOrCallback === 'function') {
58477
+ callback = optionsOrCallback;
58478
+ options = {};
58479
+ }
58480
+
58481
+ const rootUrl =
58482
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
58483
+ const parameters = {
58484
+ options: Object.assign(
58485
+ {
58486
+ url: (
58487
+ rootUrl + '/v1alpha/{+dataStore}:removePatientFilter'
58488
+ ).replace(/([^:]\/)\/+/g, '$1'),
58489
+ method: 'POST',
58490
+ apiVersion: '',
58491
+ },
58492
+ options
58493
+ ),
58494
+ params,
58495
+ requiredParams: ['dataStore'],
58496
+ pathParams: ['dataStore'],
58497
+ context: this.context,
58498
+ };
58499
+ if (callback) {
58500
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
58501
+ parameters,
58502
+ callback as BodyResponseCallback<unknown>
58503
+ );
58504
+ } else {
58505
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
58506
+ }
58507
+ }
58508
+
58509
+ /**
58510
+ * 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.
58511
+ * @example
58512
+ * ```js
58513
+ * // Before running the sample:
58514
+ * // - Enable the API at:
58515
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
58516
+ * // - Login into gcloud by running:
58517
+ * // ```sh
58518
+ * // $ gcloud auth application-default login
58519
+ * // ```
58520
+ * // - Install the npm module by running:
58521
+ * // ```sh
58522
+ * // $ npm install googleapis
58523
+ * // ```
58524
+ *
58525
+ * const {google} = require('googleapis');
58526
+ * const discoveryengine = google.discoveryengine('v1alpha');
58527
+ *
58528
+ * async function main() {
58529
+ * const auth = new google.auth.GoogleAuth({
58530
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
58531
+ * scopes: [
58532
+ * 'https://www.googleapis.com/auth/cloud-platform',
58533
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
58534
+ * ],
58535
+ * });
58536
+ *
58537
+ * // Acquire an auth client, and bind it to all future calls
58538
+ * const authClient = await auth.getClient();
58539
+ * google.options({auth: authClient});
58540
+ *
58541
+ * // Do the magic
58542
+ * const res =
58543
+ * await discoveryengine.projects.locations.dataStores.replacePatientFilter({
58544
+ * // 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.
58545
+ * dataStore:
58546
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
58547
+ *
58548
+ * // Request body metadata
58549
+ * requestBody: {
58550
+ * // request body parameters
58551
+ * // {
58552
+ * // "dataStore": "my_dataStore",
58553
+ * // "filterGroups": []
58554
+ * // }
58555
+ * },
58556
+ * });
58557
+ * console.log(res.data);
58558
+ *
58559
+ * // Example response
58560
+ * // {
58561
+ * // "done": false,
58562
+ * // "error": {},
58563
+ * // "metadata": {},
58564
+ * // "name": "my_name",
58565
+ * // "response": {}
58566
+ * // }
58567
+ * }
58568
+ *
58569
+ * main().catch(e => {
58570
+ * console.error(e);
58571
+ * throw e;
58572
+ * });
58573
+ *
58574
+ * ```
58575
+ *
58576
+ * @param params - Parameters for request
58577
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
58578
+ * @param callback - Optional callback that handles the response.
58579
+ * @returns A promise if used with async/await, or void if used with a callback.
58580
+ */
58581
+ replacePatientFilter(
58582
+ params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter,
58583
+ options: StreamMethodOptions
58584
+ ): Promise<GaxiosResponseWithHTTP2<Readable>>;
58585
+ replacePatientFilter(
58586
+ params?: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter,
58587
+ options?: MethodOptions
58588
+ ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
58589
+ replacePatientFilter(
58590
+ params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter,
58591
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
58592
+ callback: BodyResponseCallback<Readable>
58593
+ ): void;
58594
+ replacePatientFilter(
58595
+ params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter,
58596
+ options:
58597
+ | MethodOptions
58598
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
58599
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
58600
+ ): void;
58601
+ replacePatientFilter(
58602
+ params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter,
58603
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
58604
+ ): void;
58605
+ replacePatientFilter(
58606
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
58607
+ ): void;
58608
+ replacePatientFilter(
58609
+ paramsOrCallback?:
58610
+ | Params$Resource$Projects$Locations$Datastores$Replacepatientfilter
58611
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
58612
+ | BodyResponseCallback<Readable>,
58613
+ optionsOrCallback?:
58614
+ | MethodOptions
58615
+ | StreamMethodOptions
58616
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
58617
+ | BodyResponseCallback<Readable>,
58618
+ callback?:
58619
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
58620
+ | BodyResponseCallback<Readable>
58621
+ ):
58622
+ | void
58623
+ | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
58624
+ | Promise<GaxiosResponseWithHTTP2<Readable>> {
58625
+ let params = (paramsOrCallback ||
58626
+ {}) as Params$Resource$Projects$Locations$Datastores$Replacepatientfilter;
58627
+ let options = (optionsOrCallback || {}) as MethodOptions;
58628
+
58629
+ if (typeof paramsOrCallback === 'function') {
58630
+ callback = paramsOrCallback;
58631
+ params =
58632
+ {} as Params$Resource$Projects$Locations$Datastores$Replacepatientfilter;
58633
+ options = {};
58634
+ }
58635
+
58636
+ if (typeof optionsOrCallback === 'function') {
58637
+ callback = optionsOrCallback;
58638
+ options = {};
58639
+ }
58640
+
58641
+ const rootUrl =
58642
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
58643
+ const parameters = {
58644
+ options: Object.assign(
58645
+ {
58646
+ url: (
58647
+ rootUrl + '/v1alpha/{+dataStore}:replacePatientFilter'
58648
+ ).replace(/([^:]\/)\/+/g, '$1'),
58649
+ method: 'POST',
58650
+ apiVersion: '',
58651
+ },
58652
+ options
58653
+ ),
58654
+ params,
58655
+ requiredParams: ['dataStore'],
58656
+ pathParams: ['dataStore'],
58657
+ context: this.context,
58658
+ };
58659
+ if (callback) {
58660
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
58661
+ parameters,
58662
+ callback as BodyResponseCallback<unknown>
58663
+ );
58664
+ } else {
58665
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
58666
+ }
58667
+ }
58668
+
56625
58669
  /**
56626
58670
  * 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.
56627
58671
  * @example
@@ -56791,6 +58835,17 @@ export namespace discoveryengine_v1alpha {
56791
58835
  }
56792
58836
  }
56793
58837
 
58838
+ export interface Params$Resource$Projects$Locations$Datastores$Addpatientfilter extends StandardParameters {
58839
+ /**
58840
+ * 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.
58841
+ */
58842
+ dataStore?: string;
58843
+
58844
+ /**
58845
+ * Request body metadata
58846
+ */
58847
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest;
58848
+ }
56794
58849
  export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters {
56795
58850
  /**
56796
58851
  * 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`.
@@ -56850,6 +58905,17 @@ export namespace discoveryengine_v1alpha {
56850
58905
  */
56851
58906
  name?: string;
56852
58907
  }
58908
+ export interface Params$Resource$Projects$Locations$Datastores$Deletepatientfilter extends StandardParameters {
58909
+ /**
58910
+ * 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.
58911
+ */
58912
+ dataStore?: string;
58913
+
58914
+ /**
58915
+ * Request body metadata
58916
+ */
58917
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest;
58918
+ }
56853
58919
  export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters {
56854
58920
  /**
56855
58921
  * 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.
@@ -56901,6 +58967,28 @@ export namespace discoveryengine_v1alpha {
56901
58967
  */
56902
58968
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
56903
58969
  }
58970
+ export interface Params$Resource$Projects$Locations$Datastores$Removepatientfilter extends StandardParameters {
58971
+ /**
58972
+ * 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
58973
+ */
58974
+ dataStore?: string;
58975
+
58976
+ /**
58977
+ * Request body metadata
58978
+ */
58979
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest;
58980
+ }
58981
+ export interface Params$Resource$Projects$Locations$Datastores$Replacepatientfilter extends StandardParameters {
58982
+ /**
58983
+ * 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.
58984
+ */
58985
+ dataStore?: string;
58986
+
58987
+ /**
58988
+ * Request body metadata
58989
+ */
58990
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest;
58991
+ }
56904
58992
  export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
56905
58993
  /**
56906
58994
  * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
@@ -57128,7 +59216,7 @@ export namespace discoveryengine_v1alpha {
57128
59216
  * const res = await discoveryengine.projects.locations.dataStores.branches.get({
57129
59217
  * // 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.
57130
59218
  * name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche',
57131
- * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
59219
+ * // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
57132
59220
  * view: 'placeholder-value',
57133
59221
  * });
57134
59222
  * console.log(res.data);
@@ -57285,7 +59373,7 @@ export namespace discoveryengine_v1alpha {
57285
59373
  * // Required. The parent data store resource name.
57286
59374
  * parent:
57287
59375
  * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
57288
- * // The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
59376
+ * // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
57289
59377
  * view: 'placeholder-value',
57290
59378
  * },
57291
59379
  * );
@@ -57425,7 +59513,7 @@ export namespace discoveryengine_v1alpha {
57425
59513
  */
57426
59514
  name?: string;
57427
59515
  /**
57428
- * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
59516
+ * The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
57429
59517
  */
57430
59518
  view?: string;
57431
59519
  }
@@ -57435,7 +59523,7 @@ export namespace discoveryengine_v1alpha {
57435
59523
  */
57436
59524
  parent?: string;
57437
59525
  /**
57438
- * The view to apply to the returned Branch. Defaults to Branch.BranchView.BASIC if unspecified.
59526
+ * The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
57439
59527
  */
57440
59528
  view?: string;
57441
59529
  }
@@ -70106,6 +72194,7 @@ export namespace discoveryengine_v1alpha {
70106
72194
  * // "llmEnabled": false,
70107
72195
  * // "minimumDataTermAccepted": false,
70108
72196
  * // "name": "my_name",
72197
+ * // "nodes": [],
70109
72198
  * // "resultDisplayType": "my_resultDisplayType",
70110
72199
  * // "solutionType": "my_solutionType",
70111
72200
  * // "uiBranding": {},
@@ -70294,6 +72383,7 @@ export namespace discoveryengine_v1alpha {
70294
72383
  * // "llmEnabled": false,
70295
72384
  * // "minimumDataTermAccepted": false,
70296
72385
  * // "name": "my_name",
72386
+ * // "nodes": [],
70297
72387
  * // "resultDisplayType": "my_resultDisplayType",
70298
72388
  * // "solutionType": "my_solutionType",
70299
72389
  * // "uiBranding": {},
@@ -70337,6 +72427,7 @@ export namespace discoveryengine_v1alpha {
70337
72427
  * // "llmEnabled": false,
70338
72428
  * // "minimumDataTermAccepted": false,
70339
72429
  * // "name": "my_name",
72430
+ * // "nodes": [],
70340
72431
  * // "resultDisplayType": "my_resultDisplayType",
70341
72432
  * // "solutionType": "my_solutionType",
70342
72433
  * // "uiBranding": {},