@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/CHANGELOG.md +14 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +488 -16
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +1341 -83
- package/build/v1alpha.js +330 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +297 -11
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +484 -16
- package/v1alpha.ts +2170 -79
- package/v1beta.ts +297 -11
package/build/v1alpha.d.ts
CHANGED
|
@@ -564,6 +564,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
564
564
|
*/
|
|
565
565
|
useStaticSecrets?: boolean | null;
|
|
566
566
|
}
|
|
567
|
+
/**
|
|
568
|
+
* Request for DataStoreService.AddPatientFilter method.
|
|
569
|
+
*/
|
|
570
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
|
|
571
|
+
/**
|
|
572
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.
|
|
573
|
+
*/
|
|
574
|
+
dataStore?: string | null;
|
|
575
|
+
/**
|
|
576
|
+
* Required. Names of the Group resources to use as a basis for the patient filter, in format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Group/{group_id\}`. if the caller does not have permission to access the FHIR store, regardless of whether it exists, PERMISSION_DENIED error is returned. If the discovery engine service account does not have permission to access the FHIR store, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the group is not found at the location, a RESOURCE_NOT_FOUND error will be returned. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.
|
|
577
|
+
*/
|
|
578
|
+
filterGroups?: string[] | null;
|
|
579
|
+
}
|
|
567
580
|
/**
|
|
568
581
|
* Stores the definition of an agent that uses ADK and is deployed to Agent Engine (formerly known as Reasoning Engine).
|
|
569
582
|
*/
|
|
@@ -624,7 +637,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
624
637
|
userPseudoId?: string | null;
|
|
625
638
|
}
|
|
626
639
|
/**
|
|
627
|
-
* Specification to boost suggestions based on the
|
|
640
|
+
* Specification to boost suggestions based on the condition of the suggestion.
|
|
628
641
|
*/
|
|
629
642
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec {
|
|
630
643
|
/**
|
|
@@ -985,6 +998,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
985
998
|
* The reason why the agent was suspended. Only set if the state is SUSPENDED.
|
|
986
999
|
*/
|
|
987
1000
|
suspensionReason?: string | null;
|
|
1001
|
+
/**
|
|
1002
|
+
* Output only. The timestamp when the agent was last updated.
|
|
1003
|
+
*/
|
|
1004
|
+
updateTime?: string | null;
|
|
988
1005
|
/**
|
|
989
1006
|
* Optional. Per-user annotations of the current caller for the agent.
|
|
990
1007
|
*/
|
|
@@ -1131,6 +1148,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
1131
1148
|
*/
|
|
1132
1149
|
tableId?: string | null;
|
|
1133
1150
|
}
|
|
1151
|
+
/**
|
|
1152
|
+
* The customer controllable config for Analytics.
|
|
1153
|
+
*/
|
|
1154
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig {
|
|
1155
|
+
/**
|
|
1156
|
+
* Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
|
|
1157
|
+
*/
|
|
1158
|
+
name?: string | null;
|
|
1159
|
+
/**
|
|
1160
|
+
* Whether user-level metrics are enabled.
|
|
1161
|
+
*/
|
|
1162
|
+
userLevelMetricsEnabled?: boolean | null;
|
|
1163
|
+
}
|
|
1134
1164
|
/**
|
|
1135
1165
|
* Defines an answer.
|
|
1136
1166
|
*/
|
|
@@ -2123,7 +2153,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2123
2153
|
*/
|
|
2124
2154
|
groundedContent?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContent;
|
|
2125
2155
|
/**
|
|
2126
|
-
* Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple
|
|
2156
|
+
* Output only. When set, uniquely identifies a reply within the `AssistAnswer` resource. During an AssistantService.StreamAssist call, multiple `Reply` messages with the same ID can occur within the response stream (across multiple StreamAssistResponse messages). These represent parts of a single `Reply` message in the final `AssistAnswer` resource.
|
|
2127
2157
|
*/
|
|
2128
2158
|
replyId?: string | null;
|
|
2129
2159
|
}
|
|
@@ -2135,6 +2165,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2135
2165
|
* Optional. Customer policy for the assistant.
|
|
2136
2166
|
*/
|
|
2137
2167
|
customerPolicy?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy;
|
|
2168
|
+
/**
|
|
2169
|
+
* 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.
|
|
2170
|
+
*/
|
|
2171
|
+
defaultWebGroundingToggleOff?: boolean | null;
|
|
2138
2172
|
/**
|
|
2139
2173
|
* Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
|
|
2140
2174
|
*/
|
|
@@ -2503,7 +2537,11 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2503
2537
|
*/
|
|
2504
2538
|
clientSecret?: string | null;
|
|
2505
2539
|
/**
|
|
2506
|
-
*
|
|
2540
|
+
* Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
|
|
2541
|
+
*/
|
|
2542
|
+
pkceVerificationEnabled?: boolean | null;
|
|
2543
|
+
/**
|
|
2544
|
+
* Optional. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events` If omitted, no additional scopes are requested beyond those required by the authorization uri. If set, it will overwrite the scopes in the authorization uri when acquiring user authorization.
|
|
2507
2545
|
*/
|
|
2508
2546
|
scopes?: string[] | null;
|
|
2509
2547
|
/**
|
|
@@ -2847,7 +2885,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
2847
2885
|
*/
|
|
2848
2886
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaBranch {
|
|
2849
2887
|
/**
|
|
2850
|
-
* Output only.
|
|
2888
|
+
* Output only. Statistics describing a branch. This field is not populated in BranchView.BRANCH_VIEW_BASIC view.
|
|
2851
2889
|
*/
|
|
2852
2890
|
branchStats?: Schema$GoogleCloudDiscoveryengineV1alphaBranchBranchStats;
|
|
2853
2891
|
/**
|
|
@@ -4543,6 +4581,15 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
4543
4581
|
*/
|
|
4544
4582
|
updateTime?: string | null;
|
|
4545
4583
|
}
|
|
4584
|
+
/**
|
|
4585
|
+
* Request for DataStoreService.DeletePatientFilters method.
|
|
4586
|
+
*/
|
|
4587
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest {
|
|
4588
|
+
/**
|
|
4589
|
+
* Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.
|
|
4590
|
+
*/
|
|
4591
|
+
dataStore?: string | null;
|
|
4592
|
+
}
|
|
4546
4593
|
/**
|
|
4547
4594
|
* Metadata for DeleteSchema LRO.
|
|
4548
4595
|
*/
|
|
@@ -5047,7 +5094,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5047
5094
|
*/
|
|
5048
5095
|
displayName?: string | null;
|
|
5049
5096
|
/**
|
|
5050
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload`
|
|
5097
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails`
|
|
5051
5098
|
*/
|
|
5052
5099
|
features?: {
|
|
5053
5100
|
[key: string]: string;
|
|
@@ -5056,6 +5103,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5056
5103
|
* Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
|
|
5057
5104
|
*/
|
|
5058
5105
|
industryVertical?: string | null;
|
|
5106
|
+
/**
|
|
5107
|
+
* Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
5108
|
+
*/
|
|
5109
|
+
knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
|
|
5059
5110
|
/**
|
|
5060
5111
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
5061
5112
|
*/
|
|
@@ -5147,6 +5198,52 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5147
5198
|
*/
|
|
5148
5199
|
companyName?: string | null;
|
|
5149
5200
|
}
|
|
5201
|
+
/**
|
|
5202
|
+
* Configuration message for the Knowledge Graph.
|
|
5203
|
+
*/
|
|
5204
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig {
|
|
5205
|
+
/**
|
|
5206
|
+
* Specify entity types to support.
|
|
5207
|
+
*/
|
|
5208
|
+
cloudKnowledgeGraphTypes?: string[] | null;
|
|
5209
|
+
/**
|
|
5210
|
+
* Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
|
|
5211
|
+
*/
|
|
5212
|
+
enableCloudKnowledgeGraph?: boolean | null;
|
|
5213
|
+
/**
|
|
5214
|
+
* Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
|
|
5215
|
+
*/
|
|
5216
|
+
enablePrivateKnowledgeGraph?: boolean | null;
|
|
5217
|
+
/**
|
|
5218
|
+
* Optional. Feature config for the Knowledge Graph.
|
|
5219
|
+
*/
|
|
5220
|
+
featureConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig;
|
|
5221
|
+
/**
|
|
5222
|
+
* Specify entity types to support.
|
|
5223
|
+
*/
|
|
5224
|
+
privateKnowledgeGraphTypes?: string[] | null;
|
|
5225
|
+
}
|
|
5226
|
+
/**
|
|
5227
|
+
* Feature config for the Knowledge Graph.
|
|
5228
|
+
*/
|
|
5229
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig {
|
|
5230
|
+
/**
|
|
5231
|
+
* Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
|
|
5232
|
+
*/
|
|
5233
|
+
disablePrivateKgAutoComplete?: boolean | null;
|
|
5234
|
+
/**
|
|
5235
|
+
* Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
|
|
5236
|
+
*/
|
|
5237
|
+
disablePrivateKgEnrichment?: boolean | null;
|
|
5238
|
+
/**
|
|
5239
|
+
* Whether to disable the private KG for query UI chips. Defaults to false if not specified.
|
|
5240
|
+
*/
|
|
5241
|
+
disablePrivateKgQueryUiChips?: boolean | null;
|
|
5242
|
+
/**
|
|
5243
|
+
* Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
|
|
5244
|
+
*/
|
|
5245
|
+
disablePrivateKgQueryUnderstanding?: boolean | null;
|
|
5246
|
+
}
|
|
5150
5247
|
/**
|
|
5151
5248
|
* Additional config specs for a Media Recommendation engine.
|
|
5152
5249
|
*/
|
|
@@ -5814,6 +5911,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
5814
5911
|
* 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.
|
|
5815
5912
|
*/
|
|
5816
5913
|
enableStaticIndexingForBatchIngestion?: boolean | null;
|
|
5914
|
+
/**
|
|
5915
|
+
* 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.
|
|
5916
|
+
*/
|
|
5917
|
+
initialFilterGroups?: string[] | null;
|
|
5817
5918
|
}
|
|
5818
5919
|
/**
|
|
5819
5920
|
* Identity Mapping Entry that maps an external identity to an internal identity.
|
|
@@ -6748,7 +6849,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
6748
6849
|
nextPageToken?: string | null;
|
|
6749
6850
|
}
|
|
6750
6851
|
/**
|
|
6751
|
-
* Response message for UserLicenseService.
|
|
6852
|
+
* Response message for UserLicenseService.ListLicenseConfigsUsageStats method.
|
|
6752
6853
|
*/
|
|
6753
6854
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaListLicenseConfigsUsageStatsResponse {
|
|
6754
6855
|
/**
|
|
@@ -7001,6 +7102,27 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7001
7102
|
*/
|
|
7002
7103
|
totalPanels?: number | null;
|
|
7003
7104
|
}
|
|
7105
|
+
/**
|
|
7106
|
+
* Metadata related to the progress of the various patient filter operations. This will be returned by the google.longrunning.Operation.metadata field.
|
|
7107
|
+
*/
|
|
7108
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata {
|
|
7109
|
+
/**
|
|
7110
|
+
* Operation create time.
|
|
7111
|
+
*/
|
|
7112
|
+
createTime?: string | null;
|
|
7113
|
+
/**
|
|
7114
|
+
* The number of patient IDs added to the patient filter.
|
|
7115
|
+
*/
|
|
7116
|
+
filtersAddedCount?: string | null;
|
|
7117
|
+
/**
|
|
7118
|
+
* The number of patient IDs removed from the patient filter.
|
|
7119
|
+
*/
|
|
7120
|
+
filtersRemovedCount?: string | null;
|
|
7121
|
+
/**
|
|
7122
|
+
* Operation last update time. If the operation is done, this is also the finish time.
|
|
7123
|
+
*/
|
|
7124
|
+
updateTime?: string | null;
|
|
7125
|
+
}
|
|
7004
7126
|
/**
|
|
7005
7127
|
* Request for pausing training of an engine.
|
|
7006
7128
|
*/
|
|
@@ -7079,10 +7201,22 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7079
7201
|
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
7080
7202
|
*/
|
|
7081
7203
|
effectiveSearchQpmThreshold?: string | null;
|
|
7204
|
+
/**
|
|
7205
|
+
* 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.
|
|
7206
|
+
*/
|
|
7207
|
+
indexingCoreThresholdNextUpdateTime?: string | null;
|
|
7208
|
+
/**
|
|
7209
|
+
* 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.
|
|
7210
|
+
*/
|
|
7211
|
+
searchQpmThresholdNextUpdateTime?: string | null;
|
|
7082
7212
|
/**
|
|
7083
7213
|
* Optional. The start time of the currently active billing subscription.
|
|
7084
7214
|
*/
|
|
7085
7215
|
startTime?: string | null;
|
|
7216
|
+
/**
|
|
7217
|
+
* Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
|
|
7218
|
+
*/
|
|
7219
|
+
terminateTime?: string | null;
|
|
7086
7220
|
}
|
|
7087
7221
|
/**
|
|
7088
7222
|
* Customer provided configurations.
|
|
@@ -7776,6 +7910,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7776
7910
|
*/
|
|
7777
7911
|
state?: string | null;
|
|
7778
7912
|
}
|
|
7913
|
+
/**
|
|
7914
|
+
* Request for DataStoreService.RemovePatientFilter method.
|
|
7915
|
+
*/
|
|
7916
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest {
|
|
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 does not have a patient filter, a NOT_FOUND 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 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.
|
|
7923
|
+
*/
|
|
7924
|
+
filterGroups?: string[] | null;
|
|
7925
|
+
}
|
|
7779
7926
|
/**
|
|
7780
7927
|
* Request message for CompletionService.RemoveSuggestion method.
|
|
7781
7928
|
*/
|
|
@@ -7806,6 +7953,19 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
7806
7953
|
*/
|
|
7807
7954
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaRemoveSuggestionResponse {
|
|
7808
7955
|
}
|
|
7956
|
+
/**
|
|
7957
|
+
* Request for DataStoreService.ReplacePatientFilter method.
|
|
7958
|
+
*/
|
|
7959
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest {
|
|
7960
|
+
/**
|
|
7961
|
+
* 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.
|
|
7962
|
+
*/
|
|
7963
|
+
dataStore?: string | null;
|
|
7964
|
+
/**
|
|
7965
|
+
* 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.
|
|
7966
|
+
*/
|
|
7967
|
+
filterGroups?: string[] | null;
|
|
7968
|
+
}
|
|
7809
7969
|
/**
|
|
7810
7970
|
* Defines a reply message to user.
|
|
7811
7971
|
*/
|
|
@@ -8240,7 +8400,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8240
8400
|
*/
|
|
8241
8401
|
orderBy?: string | null;
|
|
8242
8402
|
/**
|
|
8243
|
-
* 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
|
|
8403
|
+
* 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`
|
|
8244
8404
|
*/
|
|
8245
8405
|
pageCategories?: string[] | null;
|
|
8246
8406
|
/**
|
|
@@ -8697,7 +8857,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8697
8857
|
*/
|
|
8698
8858
|
allowedFieldNames?: string[] | null;
|
|
8699
8859
|
/**
|
|
8700
|
-
* 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.
|
|
8860
|
+
* 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.
|
|
8701
8861
|
*/
|
|
8702
8862
|
extractedFilterBehavior?: string | null;
|
|
8703
8863
|
/**
|
|
@@ -8840,7 +9000,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
8840
9000
|
*/
|
|
8841
9001
|
guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult;
|
|
8842
9002
|
/**
|
|
8843
|
-
* Natural language query understanding information for the returned results.
|
|
9003
|
+
* Output only. Natural language query understanding information for the returned results.
|
|
8844
9004
|
*/
|
|
8845
9005
|
naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo;
|
|
8846
9006
|
/**
|
|
@@ -10546,6 +10706,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10546
10706
|
* 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.
|
|
10547
10707
|
*/
|
|
10548
10708
|
name?: string | null;
|
|
10709
|
+
/**
|
|
10710
|
+
* Output only. The nodes associated with the Widget Config.
|
|
10711
|
+
*/
|
|
10712
|
+
nodes?: Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigNode[];
|
|
10549
10713
|
/**
|
|
10550
10714
|
* 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.
|
|
10551
10715
|
*/
|
|
@@ -10642,7 +10806,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10642
10806
|
*/
|
|
10643
10807
|
id?: string | null;
|
|
10644
10808
|
/**
|
|
10645
|
-
* 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.
|
|
10809
|
+
* 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.
|
|
10646
10810
|
*/
|
|
10647
10811
|
name?: string | null;
|
|
10648
10812
|
}
|
|
@@ -10680,7 +10844,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10680
10844
|
*/
|
|
10681
10845
|
id?: string | null;
|
|
10682
10846
|
/**
|
|
10683
|
-
* 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.
|
|
10847
|
+
* 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.
|
|
10684
10848
|
*/
|
|
10685
10849
|
name?: string | null;
|
|
10686
10850
|
/**
|
|
@@ -10707,7 +10871,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10707
10871
|
*/
|
|
10708
10872
|
id?: string | null;
|
|
10709
10873
|
/**
|
|
10710
|
-
* 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.
|
|
10874
|
+
* 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.
|
|
10711
10875
|
*/
|
|
10712
10876
|
name?: string | null;
|
|
10713
10877
|
}
|
|
@@ -10759,6 +10923,39 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10759
10923
|
*/
|
|
10760
10924
|
url?: string | null;
|
|
10761
10925
|
}
|
|
10926
|
+
/**
|
|
10927
|
+
* Represents a single reusable computational or logical unit.
|
|
10928
|
+
*/
|
|
10929
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaWidgetConfigNode {
|
|
10930
|
+
/**
|
|
10931
|
+
* Output only. A detailed description of what the node does.
|
|
10932
|
+
*/
|
|
10933
|
+
description?: string | null;
|
|
10934
|
+
/**
|
|
10935
|
+
* Output only. A human readable name for the node.
|
|
10936
|
+
*/
|
|
10937
|
+
displayName?: string | null;
|
|
10938
|
+
/**
|
|
10939
|
+
* Output only. An identifier or URL pointing to an icon representing this node type.
|
|
10940
|
+
*/
|
|
10941
|
+
iconUrl?: string | null;
|
|
10942
|
+
/**
|
|
10943
|
+
* 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.
|
|
10944
|
+
*/
|
|
10945
|
+
outputSchema?: {
|
|
10946
|
+
[key: string]: any;
|
|
10947
|
+
} | null;
|
|
10948
|
+
/**
|
|
10949
|
+
* 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.
|
|
10950
|
+
*/
|
|
10951
|
+
parameterSchema?: {
|
|
10952
|
+
[key: string]: any;
|
|
10953
|
+
} | null;
|
|
10954
|
+
/**
|
|
10955
|
+
* Output only. The type of the node.
|
|
10956
|
+
*/
|
|
10957
|
+
type?: string | null;
|
|
10958
|
+
}
|
|
10762
10959
|
/**
|
|
10763
10960
|
* Describes widget UI branding settings.
|
|
10764
10961
|
*/
|
|
@@ -10830,7 +11027,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
10830
11027
|
*/
|
|
10831
11028
|
enableVisualContentSummary?: boolean | null;
|
|
10832
11029
|
/**
|
|
10833
|
-
* 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`
|
|
11030
|
+
* 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`
|
|
10834
11031
|
*/
|
|
10835
11032
|
features?: {
|
|
10836
11033
|
[key: string]: string;
|
|
@@ -11004,6 +11201,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
11004
11201
|
* Optional. Customer policy for the assistant.
|
|
11005
11202
|
*/
|
|
11006
11203
|
customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
11204
|
+
/**
|
|
11205
|
+
* 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.
|
|
11206
|
+
*/
|
|
11207
|
+
defaultWebGroundingToggleOff?: boolean | null;
|
|
11007
11208
|
/**
|
|
11008
11209
|
* Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
|
|
11009
11210
|
*/
|
|
@@ -12024,7 +12225,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12024
12225
|
*/
|
|
12025
12226
|
displayName?: string | null;
|
|
12026
12227
|
/**
|
|
12027
|
-
* 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`
|
|
12228
|
+
* 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`
|
|
12028
12229
|
*/
|
|
12029
12230
|
features?: {
|
|
12030
12231
|
[key: string]: string;
|
|
@@ -12033,6 +12234,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12033
12234
|
* 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.
|
|
12034
12235
|
*/
|
|
12035
12236
|
industryVertical?: string | null;
|
|
12237
|
+
/**
|
|
12238
|
+
* Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
12239
|
+
*/
|
|
12240
|
+
knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
|
|
12036
12241
|
/**
|
|
12037
12242
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
12038
12243
|
*/
|
|
@@ -12116,6 +12321,52 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12116
12321
|
*/
|
|
12117
12322
|
companyName?: string | null;
|
|
12118
12323
|
}
|
|
12324
|
+
/**
|
|
12325
|
+
* Configuration message for the Knowledge Graph.
|
|
12326
|
+
*/
|
|
12327
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig {
|
|
12328
|
+
/**
|
|
12329
|
+
* Specify entity types to support.
|
|
12330
|
+
*/
|
|
12331
|
+
cloudKnowledgeGraphTypes?: string[] | null;
|
|
12332
|
+
/**
|
|
12333
|
+
* Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
|
|
12334
|
+
*/
|
|
12335
|
+
enableCloudKnowledgeGraph?: boolean | null;
|
|
12336
|
+
/**
|
|
12337
|
+
* Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
|
|
12338
|
+
*/
|
|
12339
|
+
enablePrivateKnowledgeGraph?: boolean | null;
|
|
12340
|
+
/**
|
|
12341
|
+
* Optional. Feature config for the Knowledge Graph.
|
|
12342
|
+
*/
|
|
12343
|
+
featureConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig;
|
|
12344
|
+
/**
|
|
12345
|
+
* Specify entity types to support.
|
|
12346
|
+
*/
|
|
12347
|
+
privateKnowledgeGraphTypes?: string[] | null;
|
|
12348
|
+
}
|
|
12349
|
+
/**
|
|
12350
|
+
* Feature config for the Knowledge Graph.
|
|
12351
|
+
*/
|
|
12352
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig {
|
|
12353
|
+
/**
|
|
12354
|
+
* Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
|
|
12355
|
+
*/
|
|
12356
|
+
disablePrivateKgAutoComplete?: boolean | null;
|
|
12357
|
+
/**
|
|
12358
|
+
* Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
|
|
12359
|
+
*/
|
|
12360
|
+
disablePrivateKgEnrichment?: boolean | null;
|
|
12361
|
+
/**
|
|
12362
|
+
* Whether to disable the private KG for query UI chips. Defaults to false if not specified.
|
|
12363
|
+
*/
|
|
12364
|
+
disablePrivateKgQueryUiChips?: boolean | null;
|
|
12365
|
+
/**
|
|
12366
|
+
* Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
|
|
12367
|
+
*/
|
|
12368
|
+
disablePrivateKgQueryUnderstanding?: boolean | null;
|
|
12369
|
+
}
|
|
12119
12370
|
/**
|
|
12120
12371
|
* Additional config specs for a Media Recommendation engine.
|
|
12121
12372
|
*/
|
|
@@ -12273,6 +12524,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12273
12524
|
* 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.
|
|
12274
12525
|
*/
|
|
12275
12526
|
enableStaticIndexingForBatchIngestion?: boolean | null;
|
|
12527
|
+
/**
|
|
12528
|
+
* 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.
|
|
12529
|
+
*/
|
|
12530
|
+
initialFilterGroups?: string[] | null;
|
|
12276
12531
|
}
|
|
12277
12532
|
/**
|
|
12278
12533
|
* IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
|
|
@@ -12686,10 +12941,22 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
12686
12941
|
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
12687
12942
|
*/
|
|
12688
12943
|
effectiveSearchQpmThreshold?: string | null;
|
|
12944
|
+
/**
|
|
12945
|
+
* 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.
|
|
12946
|
+
*/
|
|
12947
|
+
indexingCoreThresholdNextUpdateTime?: string | null;
|
|
12948
|
+
/**
|
|
12949
|
+
* 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.
|
|
12950
|
+
*/
|
|
12951
|
+
searchQpmThresholdNextUpdateTime?: string | null;
|
|
12689
12952
|
/**
|
|
12690
12953
|
* Optional. The start time of the currently active billing subscription.
|
|
12691
12954
|
*/
|
|
12692
12955
|
startTime?: string | null;
|
|
12956
|
+
/**
|
|
12957
|
+
* Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
|
|
12958
|
+
*/
|
|
12959
|
+
terminateTime?: string | null;
|
|
12693
12960
|
}
|
|
12694
12961
|
/**
|
|
12695
12962
|
* Customer provided configurations.
|
|
@@ -13009,7 +13276,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13009
13276
|
*/
|
|
13010
13277
|
orderBy?: string | null;
|
|
13011
13278
|
/**
|
|
13012
|
-
* 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
|
|
13279
|
+
* 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`
|
|
13013
13280
|
*/
|
|
13014
13281
|
pageCategories?: string[] | null;
|
|
13015
13282
|
/**
|
|
@@ -13462,7 +13729,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
13462
13729
|
*/
|
|
13463
13730
|
allowedFieldNames?: string[] | null;
|
|
13464
13731
|
/**
|
|
13465
|
-
* 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.
|
|
13732
|
+
* 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.
|
|
13466
13733
|
*/
|
|
13467
13734
|
extractedFilterBehavior?: string | null;
|
|
13468
13735
|
/**
|
|
@@ -14942,7 +15209,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
14942
15209
|
*/
|
|
14943
15210
|
displayName?: string | null;
|
|
14944
15211
|
/**
|
|
14945
|
-
* 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`
|
|
15212
|
+
* 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`
|
|
14946
15213
|
*/
|
|
14947
15214
|
features?: {
|
|
14948
15215
|
[key: string]: string;
|
|
@@ -14951,6 +15218,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
14951
15218
|
* 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.
|
|
14952
15219
|
*/
|
|
14953
15220
|
industryVertical?: string | null;
|
|
15221
|
+
/**
|
|
15222
|
+
* Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
|
|
15223
|
+
*/
|
|
15224
|
+
knowledgeGraphConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
|
|
14954
15225
|
/**
|
|
14955
15226
|
* Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
|
|
14956
15227
|
*/
|
|
@@ -15034,6 +15305,52 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15034
15305
|
*/
|
|
15035
15306
|
companyName?: string | null;
|
|
15036
15307
|
}
|
|
15308
|
+
/**
|
|
15309
|
+
* Configuration message for the Knowledge Graph.
|
|
15310
|
+
*/
|
|
15311
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig {
|
|
15312
|
+
/**
|
|
15313
|
+
* Specify entity types to support.
|
|
15314
|
+
*/
|
|
15315
|
+
cloudKnowledgeGraphTypes?: string[] | null;
|
|
15316
|
+
/**
|
|
15317
|
+
* Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified.
|
|
15318
|
+
*/
|
|
15319
|
+
enableCloudKnowledgeGraph?: boolean | null;
|
|
15320
|
+
/**
|
|
15321
|
+
* Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified.
|
|
15322
|
+
*/
|
|
15323
|
+
enablePrivateKnowledgeGraph?: boolean | null;
|
|
15324
|
+
/**
|
|
15325
|
+
* Optional. Feature config for the Knowledge Graph.
|
|
15326
|
+
*/
|
|
15327
|
+
featureConfig?: Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig;
|
|
15328
|
+
/**
|
|
15329
|
+
* Specify entity types to support.
|
|
15330
|
+
*/
|
|
15331
|
+
privateKnowledgeGraphTypes?: string[] | null;
|
|
15332
|
+
}
|
|
15333
|
+
/**
|
|
15334
|
+
* Feature config for the Knowledge Graph.
|
|
15335
|
+
*/
|
|
15336
|
+
export interface Schema$GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig {
|
|
15337
|
+
/**
|
|
15338
|
+
* Whether to disable the private KG auto complete for the engine. Defaults to false if not specified.
|
|
15339
|
+
*/
|
|
15340
|
+
disablePrivateKgAutoComplete?: boolean | null;
|
|
15341
|
+
/**
|
|
15342
|
+
* Whether to disable the private KG enrichment for the engine. Defaults to false if not specified.
|
|
15343
|
+
*/
|
|
15344
|
+
disablePrivateKgEnrichment?: boolean | null;
|
|
15345
|
+
/**
|
|
15346
|
+
* Whether to disable the private KG for query UI chips. Defaults to false if not specified.
|
|
15347
|
+
*/
|
|
15348
|
+
disablePrivateKgQueryUiChips?: boolean | null;
|
|
15349
|
+
/**
|
|
15350
|
+
* Whether to disable the private KG query understanding for the engine. Defaults to false if not specified.
|
|
15351
|
+
*/
|
|
15352
|
+
disablePrivateKgQueryUnderstanding?: boolean | null;
|
|
15353
|
+
}
|
|
15037
15354
|
/**
|
|
15038
15355
|
* Additional config specs for a Media Recommendation engine.
|
|
15039
15356
|
*/
|
|
@@ -15132,6 +15449,10 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15132
15449
|
* 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.
|
|
15133
15450
|
*/
|
|
15134
15451
|
enableStaticIndexingForBatchIngestion?: boolean | null;
|
|
15452
|
+
/**
|
|
15453
|
+
* 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.
|
|
15454
|
+
*/
|
|
15455
|
+
initialFilterGroups?: string[] | null;
|
|
15135
15456
|
}
|
|
15136
15457
|
/**
|
|
15137
15458
|
* IdentityMappingEntry LongRunningOperation metadata for IdentityMappingStoreService.ImportIdentityMappings and IdentityMappingStoreService.PurgeIdentityMappings
|
|
@@ -15444,10 +15765,22 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
15444
15765
|
* Optional. The currently effective Search QPM threshold in queries per minute. This is the threshold against which QPM usage is compared for overage calculations.
|
|
15445
15766
|
*/
|
|
15446
15767
|
effectiveSearchQpmThreshold?: string | null;
|
|
15768
|
+
/**
|
|
15769
|
+
* 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.
|
|
15770
|
+
*/
|
|
15771
|
+
indexingCoreThresholdNextUpdateTime?: string | null;
|
|
15772
|
+
/**
|
|
15773
|
+
* 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.
|
|
15774
|
+
*/
|
|
15775
|
+
searchQpmThresholdNextUpdateTime?: string | null;
|
|
15447
15776
|
/**
|
|
15448
15777
|
* Optional. The start time of the currently active billing subscription.
|
|
15449
15778
|
*/
|
|
15450
15779
|
startTime?: string | null;
|
|
15780
|
+
/**
|
|
15781
|
+
* Output only. The latest terminate effective time of search qpm and indexing core subscriptions.
|
|
15782
|
+
*/
|
|
15783
|
+
terminateTime?: string | null;
|
|
15451
15784
|
}
|
|
15452
15785
|
/**
|
|
15453
15786
|
* Customer provided configurations.
|
|
@@ -16296,7 +16629,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16296
16629
|
names?: string[] | null;
|
|
16297
16630
|
}
|
|
16298
16631
|
/**
|
|
16299
|
-
* Request for
|
|
16632
|
+
* Request for BatchDeleteSourcesRequest method.
|
|
16300
16633
|
*/
|
|
16301
16634
|
export interface Schema$GoogleCloudNotebooklmV1alphaBatchDeleteSourcesRequest {
|
|
16302
16635
|
/**
|
|
@@ -16351,10 +16684,18 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16351
16684
|
* Indicates an error occurred while ingesting the source.
|
|
16352
16685
|
*/
|
|
16353
16686
|
ingestionError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError;
|
|
16687
|
+
/**
|
|
16688
|
+
* Indicates that the source MIME type is blocked.
|
|
16689
|
+
*/
|
|
16690
|
+
mimeTypeBlocked?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked;
|
|
16354
16691
|
/**
|
|
16355
16692
|
* Indicates that the source is paywalled and cannot be ingested.
|
|
16356
16693
|
*/
|
|
16357
16694
|
paywallError?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError;
|
|
16695
|
+
/**
|
|
16696
|
+
* Indicates that the policy check failed.
|
|
16697
|
+
*/
|
|
16698
|
+
policyCheckFailed?: Schema$GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed;
|
|
16358
16699
|
/**
|
|
16359
16700
|
* Indicates that the source is empty.
|
|
16360
16701
|
*/
|
|
@@ -16431,11 +16772,21 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
16431
16772
|
*/
|
|
16432
16773
|
export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonIngestionError {
|
|
16433
16774
|
}
|
|
16775
|
+
/**
|
|
16776
|
+
* Indicates that the source MIME type is blocked.
|
|
16777
|
+
*/
|
|
16778
|
+
export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonMimeTypeBlocked {
|
|
16779
|
+
}
|
|
16434
16780
|
/**
|
|
16435
16781
|
* Indicates that the source is paywalled and cannot be ingested.
|
|
16436
16782
|
*/
|
|
16437
16783
|
export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPaywallError {
|
|
16438
16784
|
}
|
|
16785
|
+
/**
|
|
16786
|
+
* Indicates that the policy check failed.
|
|
16787
|
+
*/
|
|
16788
|
+
export interface Schema$GoogleCloudNotebooklmV1alphaFailureReasonPolicyCheckFailed {
|
|
16789
|
+
}
|
|
16439
16790
|
/**
|
|
16440
16791
|
* Indicates that the source is empty.
|
|
16441
16792
|
*/
|
|
@@ -17529,7 +17880,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
17529
17880
|
* const res = await discoveryengine.projects.patch({
|
|
17530
17881
|
* // 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.
|
|
17531
17882
|
* name: 'projects/my-project',
|
|
17532
|
-
* // Optional. The list of fields to update. Supported fields: * `customer_provided_config`
|
|
17883
|
+
* // Optional. The list of fields to update. Supported fields: * `customer_provided_config` * `customer_provided_config.notebooklm_config.observability_config`
|
|
17533
17884
|
* updateMask: 'placeholder-value',
|
|
17534
17885
|
*
|
|
17535
17886
|
* // Request body metadata
|
|
@@ -17744,7 +18095,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
17744
18095
|
*/
|
|
17745
18096
|
name?: string;
|
|
17746
18097
|
/**
|
|
17747
|
-
* Optional. The list of fields to update. Supported fields: * `customer_provided_config`
|
|
18098
|
+
* Optional. The list of fields to update. Supported fields: * `customer_provided_config` * `customer_provided_config.notebooklm_config.observability_config`
|
|
17748
18099
|
*/
|
|
17749
18100
|
updateMask?: string;
|
|
17750
18101
|
/**
|
|
@@ -20769,6 +21120,86 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
20769
21120
|
userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents;
|
|
20770
21121
|
widgetConfigs: Resource$Projects$Locations$Collections$Datastores$Widgetconfigs;
|
|
20771
21122
|
constructor(context: APIRequestContext);
|
|
21123
|
+
/**
|
|
21124
|
+
* 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.
|
|
21125
|
+
* @example
|
|
21126
|
+
* ```js
|
|
21127
|
+
* // Before running the sample:
|
|
21128
|
+
* // - Enable the API at:
|
|
21129
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21130
|
+
* // - Login into gcloud by running:
|
|
21131
|
+
* // ```sh
|
|
21132
|
+
* // $ gcloud auth application-default login
|
|
21133
|
+
* // ```
|
|
21134
|
+
* // - Install the npm module by running:
|
|
21135
|
+
* // ```sh
|
|
21136
|
+
* // $ npm install googleapis
|
|
21137
|
+
* // ```
|
|
21138
|
+
*
|
|
21139
|
+
* const {google} = require('googleapis');
|
|
21140
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
21141
|
+
*
|
|
21142
|
+
* async function main() {
|
|
21143
|
+
* const auth = new google.auth.GoogleAuth({
|
|
21144
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21145
|
+
* scopes: [
|
|
21146
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21147
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21148
|
+
* ],
|
|
21149
|
+
* });
|
|
21150
|
+
*
|
|
21151
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
21152
|
+
* const authClient = await auth.getClient();
|
|
21153
|
+
* google.options({auth: authClient});
|
|
21154
|
+
*
|
|
21155
|
+
* // Do the magic
|
|
21156
|
+
* const res =
|
|
21157
|
+
* await discoveryengine.projects.locations.collections.dataStores.addPatientFilter(
|
|
21158
|
+
* {
|
|
21159
|
+
* // 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.
|
|
21160
|
+
* dataStore:
|
|
21161
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
21162
|
+
*
|
|
21163
|
+
* // Request body metadata
|
|
21164
|
+
* requestBody: {
|
|
21165
|
+
* // request body parameters
|
|
21166
|
+
* // {
|
|
21167
|
+
* // "dataStore": "my_dataStore",
|
|
21168
|
+
* // "filterGroups": []
|
|
21169
|
+
* // }
|
|
21170
|
+
* },
|
|
21171
|
+
* },
|
|
21172
|
+
* );
|
|
21173
|
+
* console.log(res.data);
|
|
21174
|
+
*
|
|
21175
|
+
* // Example response
|
|
21176
|
+
* // {
|
|
21177
|
+
* // "done": false,
|
|
21178
|
+
* // "error": {},
|
|
21179
|
+
* // "metadata": {},
|
|
21180
|
+
* // "name": "my_name",
|
|
21181
|
+
* // "response": {}
|
|
21182
|
+
* // }
|
|
21183
|
+
* }
|
|
21184
|
+
*
|
|
21185
|
+
* main().catch(e => {
|
|
21186
|
+
* console.error(e);
|
|
21187
|
+
* throw e;
|
|
21188
|
+
* });
|
|
21189
|
+
*
|
|
21190
|
+
* ```
|
|
21191
|
+
*
|
|
21192
|
+
* @param params - Parameters for request
|
|
21193
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21194
|
+
* @param callback - Optional callback that handles the response.
|
|
21195
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21196
|
+
*/
|
|
21197
|
+
addPatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21198
|
+
addPatientFilter(params?: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
21199
|
+
addPatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21200
|
+
addPatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21201
|
+
addPatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21202
|
+
addPatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
20772
21203
|
/**
|
|
20773
21204
|
* Completes the specified user input with keyword suggestions.
|
|
20774
21205
|
* @example
|
|
@@ -21026,6 +21457,85 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21026
21457
|
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21027
21458
|
delete(params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21028
21459
|
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21460
|
+
/**
|
|
21461
|
+
* 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.
|
|
21462
|
+
* @example
|
|
21463
|
+
* ```js
|
|
21464
|
+
* // Before running the sample:
|
|
21465
|
+
* // - Enable the API at:
|
|
21466
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21467
|
+
* // - Login into gcloud by running:
|
|
21468
|
+
* // ```sh
|
|
21469
|
+
* // $ gcloud auth application-default login
|
|
21470
|
+
* // ```
|
|
21471
|
+
* // - Install the npm module by running:
|
|
21472
|
+
* // ```sh
|
|
21473
|
+
* // $ npm install googleapis
|
|
21474
|
+
* // ```
|
|
21475
|
+
*
|
|
21476
|
+
* const {google} = require('googleapis');
|
|
21477
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
21478
|
+
*
|
|
21479
|
+
* async function main() {
|
|
21480
|
+
* const auth = new google.auth.GoogleAuth({
|
|
21481
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21482
|
+
* scopes: [
|
|
21483
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21484
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21485
|
+
* ],
|
|
21486
|
+
* });
|
|
21487
|
+
*
|
|
21488
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
21489
|
+
* const authClient = await auth.getClient();
|
|
21490
|
+
* google.options({auth: authClient});
|
|
21491
|
+
*
|
|
21492
|
+
* // Do the magic
|
|
21493
|
+
* const res =
|
|
21494
|
+
* await discoveryengine.projects.locations.collections.dataStores.deletePatientFilter(
|
|
21495
|
+
* {
|
|
21496
|
+
* // 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.
|
|
21497
|
+
* dataStore:
|
|
21498
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
21499
|
+
*
|
|
21500
|
+
* // Request body metadata
|
|
21501
|
+
* requestBody: {
|
|
21502
|
+
* // request body parameters
|
|
21503
|
+
* // {
|
|
21504
|
+
* // "dataStore": "my_dataStore"
|
|
21505
|
+
* // }
|
|
21506
|
+
* },
|
|
21507
|
+
* },
|
|
21508
|
+
* );
|
|
21509
|
+
* console.log(res.data);
|
|
21510
|
+
*
|
|
21511
|
+
* // Example response
|
|
21512
|
+
* // {
|
|
21513
|
+
* // "done": false,
|
|
21514
|
+
* // "error": {},
|
|
21515
|
+
* // "metadata": {},
|
|
21516
|
+
* // "name": "my_name",
|
|
21517
|
+
* // "response": {}
|
|
21518
|
+
* // }
|
|
21519
|
+
* }
|
|
21520
|
+
*
|
|
21521
|
+
* main().catch(e => {
|
|
21522
|
+
* console.error(e);
|
|
21523
|
+
* throw e;
|
|
21524
|
+
* });
|
|
21525
|
+
*
|
|
21526
|
+
* ```
|
|
21527
|
+
*
|
|
21528
|
+
* @param params - Parameters for request
|
|
21529
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21530
|
+
* @param callback - Optional callback that handles the response.
|
|
21531
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21532
|
+
*/
|
|
21533
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21534
|
+
deletePatientFilter(params?: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
21535
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21536
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21537
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21538
|
+
deletePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21029
21539
|
/**
|
|
21030
21540
|
* Gets a DataStore.
|
|
21031
21541
|
* @example
|
|
@@ -21441,6 +21951,166 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21441
21951
|
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
21442
21952
|
patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
21443
21953
|
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
21954
|
+
/**
|
|
21955
|
+
* 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.
|
|
21956
|
+
* @example
|
|
21957
|
+
* ```js
|
|
21958
|
+
* // Before running the sample:
|
|
21959
|
+
* // - Enable the API at:
|
|
21960
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21961
|
+
* // - Login into gcloud by running:
|
|
21962
|
+
* // ```sh
|
|
21963
|
+
* // $ gcloud auth application-default login
|
|
21964
|
+
* // ```
|
|
21965
|
+
* // - Install the npm module by running:
|
|
21966
|
+
* // ```sh
|
|
21967
|
+
* // $ npm install googleapis
|
|
21968
|
+
* // ```
|
|
21969
|
+
*
|
|
21970
|
+
* const {google} = require('googleapis');
|
|
21971
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
21972
|
+
*
|
|
21973
|
+
* async function main() {
|
|
21974
|
+
* const auth = new google.auth.GoogleAuth({
|
|
21975
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21976
|
+
* scopes: [
|
|
21977
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21978
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21979
|
+
* ],
|
|
21980
|
+
* });
|
|
21981
|
+
*
|
|
21982
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
21983
|
+
* const authClient = await auth.getClient();
|
|
21984
|
+
* google.options({auth: authClient});
|
|
21985
|
+
*
|
|
21986
|
+
* // Do the magic
|
|
21987
|
+
* const res =
|
|
21988
|
+
* await discoveryengine.projects.locations.collections.dataStores.removePatientFilter(
|
|
21989
|
+
* {
|
|
21990
|
+
* // 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
|
|
21991
|
+
* dataStore:
|
|
21992
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
21993
|
+
*
|
|
21994
|
+
* // Request body metadata
|
|
21995
|
+
* requestBody: {
|
|
21996
|
+
* // request body parameters
|
|
21997
|
+
* // {
|
|
21998
|
+
* // "dataStore": "my_dataStore",
|
|
21999
|
+
* // "filterGroups": []
|
|
22000
|
+
* // }
|
|
22001
|
+
* },
|
|
22002
|
+
* },
|
|
22003
|
+
* );
|
|
22004
|
+
* console.log(res.data);
|
|
22005
|
+
*
|
|
22006
|
+
* // Example response
|
|
22007
|
+
* // {
|
|
22008
|
+
* // "done": false,
|
|
22009
|
+
* // "error": {},
|
|
22010
|
+
* // "metadata": {},
|
|
22011
|
+
* // "name": "my_name",
|
|
22012
|
+
* // "response": {}
|
|
22013
|
+
* // }
|
|
22014
|
+
* }
|
|
22015
|
+
*
|
|
22016
|
+
* main().catch(e => {
|
|
22017
|
+
* console.error(e);
|
|
22018
|
+
* throw e;
|
|
22019
|
+
* });
|
|
22020
|
+
*
|
|
22021
|
+
* ```
|
|
22022
|
+
*
|
|
22023
|
+
* @param params - Parameters for request
|
|
22024
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
22025
|
+
* @param callback - Optional callback that handles the response.
|
|
22026
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
22027
|
+
*/
|
|
22028
|
+
removePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
22029
|
+
removePatientFilter(params?: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
22030
|
+
removePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
22031
|
+
removePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
22032
|
+
removePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
22033
|
+
removePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
22034
|
+
/**
|
|
22035
|
+
* 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.
|
|
22036
|
+
* @example
|
|
22037
|
+
* ```js
|
|
22038
|
+
* // Before running the sample:
|
|
22039
|
+
* // - Enable the API at:
|
|
22040
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
22041
|
+
* // - Login into gcloud by running:
|
|
22042
|
+
* // ```sh
|
|
22043
|
+
* // $ gcloud auth application-default login
|
|
22044
|
+
* // ```
|
|
22045
|
+
* // - Install the npm module by running:
|
|
22046
|
+
* // ```sh
|
|
22047
|
+
* // $ npm install googleapis
|
|
22048
|
+
* // ```
|
|
22049
|
+
*
|
|
22050
|
+
* const {google} = require('googleapis');
|
|
22051
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
22052
|
+
*
|
|
22053
|
+
* async function main() {
|
|
22054
|
+
* const auth = new google.auth.GoogleAuth({
|
|
22055
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
22056
|
+
* scopes: [
|
|
22057
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
22058
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
22059
|
+
* ],
|
|
22060
|
+
* });
|
|
22061
|
+
*
|
|
22062
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
22063
|
+
* const authClient = await auth.getClient();
|
|
22064
|
+
* google.options({auth: authClient});
|
|
22065
|
+
*
|
|
22066
|
+
* // Do the magic
|
|
22067
|
+
* const res =
|
|
22068
|
+
* await discoveryengine.projects.locations.collections.dataStores.replacePatientFilter(
|
|
22069
|
+
* {
|
|
22070
|
+
* // 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.
|
|
22071
|
+
* dataStore:
|
|
22072
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
22073
|
+
*
|
|
22074
|
+
* // Request body metadata
|
|
22075
|
+
* requestBody: {
|
|
22076
|
+
* // request body parameters
|
|
22077
|
+
* // {
|
|
22078
|
+
* // "dataStore": "my_dataStore",
|
|
22079
|
+
* // "filterGroups": []
|
|
22080
|
+
* // }
|
|
22081
|
+
* },
|
|
22082
|
+
* },
|
|
22083
|
+
* );
|
|
22084
|
+
* console.log(res.data);
|
|
22085
|
+
*
|
|
22086
|
+
* // Example response
|
|
22087
|
+
* // {
|
|
22088
|
+
* // "done": false,
|
|
22089
|
+
* // "error": {},
|
|
22090
|
+
* // "metadata": {},
|
|
22091
|
+
* // "name": "my_name",
|
|
22092
|
+
* // "response": {}
|
|
22093
|
+
* // }
|
|
22094
|
+
* }
|
|
22095
|
+
*
|
|
22096
|
+
* main().catch(e => {
|
|
22097
|
+
* console.error(e);
|
|
22098
|
+
* throw e;
|
|
22099
|
+
* });
|
|
22100
|
+
*
|
|
22101
|
+
* ```
|
|
22102
|
+
*
|
|
22103
|
+
* @param params - Parameters for request
|
|
22104
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
22105
|
+
* @param callback - Optional callback that handles the response.
|
|
22106
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
22107
|
+
*/
|
|
22108
|
+
replacePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
22109
|
+
replacePatientFilter(params?: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
22110
|
+
replacePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
22111
|
+
replacePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
22112
|
+
replacePatientFilter(params: Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
22113
|
+
replacePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
21444
22114
|
/**
|
|
21445
22115
|
* Trains a custom model.
|
|
21446
22116
|
* @example
|
|
@@ -21606,6 +22276,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21606
22276
|
updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
|
|
21607
22277
|
updateDocumentProcessingConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
|
|
21608
22278
|
}
|
|
22279
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Addpatientfilter extends StandardParameters {
|
|
22280
|
+
/**
|
|
22281
|
+
* 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.
|
|
22282
|
+
*/
|
|
22283
|
+
dataStore?: string;
|
|
22284
|
+
/**
|
|
22285
|
+
* Request body metadata
|
|
22286
|
+
*/
|
|
22287
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest;
|
|
22288
|
+
}
|
|
21609
22289
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery extends StandardParameters {
|
|
21610
22290
|
/**
|
|
21611
22291
|
* 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`.
|
|
@@ -21664,6 +22344,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21664
22344
|
*/
|
|
21665
22345
|
name?: string;
|
|
21666
22346
|
}
|
|
22347
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Deletepatientfilter extends StandardParameters {
|
|
22348
|
+
/**
|
|
22349
|
+
* 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.
|
|
22350
|
+
*/
|
|
22351
|
+
dataStore?: string;
|
|
22352
|
+
/**
|
|
22353
|
+
* Request body metadata
|
|
22354
|
+
*/
|
|
22355
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest;
|
|
22356
|
+
}
|
|
21667
22357
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Get extends StandardParameters {
|
|
21668
22358
|
/**
|
|
21669
22359
|
* 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.
|
|
@@ -21714,6 +22404,26 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21714
22404
|
*/
|
|
21715
22405
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
|
|
21716
22406
|
}
|
|
22407
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Removepatientfilter extends StandardParameters {
|
|
22408
|
+
/**
|
|
22409
|
+
* 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
|
|
22410
|
+
*/
|
|
22411
|
+
dataStore?: string;
|
|
22412
|
+
/**
|
|
22413
|
+
* Request body metadata
|
|
22414
|
+
*/
|
|
22415
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest;
|
|
22416
|
+
}
|
|
22417
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Replacepatientfilter extends StandardParameters {
|
|
22418
|
+
/**
|
|
22419
|
+
* 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.
|
|
22420
|
+
*/
|
|
22421
|
+
dataStore?: string;
|
|
22422
|
+
/**
|
|
22423
|
+
* Request body metadata
|
|
22424
|
+
*/
|
|
22425
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest;
|
|
22426
|
+
}
|
|
21717
22427
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel extends StandardParameters {
|
|
21718
22428
|
/**
|
|
21719
22429
|
* 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.
|
|
@@ -21852,7 +22562,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21852
22562
|
* {
|
|
21853
22563
|
* // 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.
|
|
21854
22564
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/branches/my-branche',
|
|
21855
|
-
* // The view to apply to the returned Branch. Defaults to
|
|
22565
|
+
* // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
|
|
21856
22566
|
* view: 'placeholder-value',
|
|
21857
22567
|
* },
|
|
21858
22568
|
* );
|
|
@@ -21925,7 +22635,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21925
22635
|
* // Required. The parent data store resource name.
|
|
21926
22636
|
* parent:
|
|
21927
22637
|
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
21928
|
-
* // The view to apply to the returned Branch. Defaults to
|
|
22638
|
+
* // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
|
|
21929
22639
|
* view: 'placeholder-value',
|
|
21930
22640
|
* },
|
|
21931
22641
|
* );
|
|
@@ -21976,7 +22686,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21976
22686
|
*/
|
|
21977
22687
|
name?: string;
|
|
21978
22688
|
/**
|
|
21979
|
-
* The view to apply to the returned Branch. Defaults to
|
|
22689
|
+
* The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
|
|
21980
22690
|
*/
|
|
21981
22691
|
view?: string;
|
|
21982
22692
|
}
|
|
@@ -21986,7 +22696,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
21986
22696
|
*/
|
|
21987
22697
|
parent?: string;
|
|
21988
22698
|
/**
|
|
21989
|
-
* The view to apply to the returned Branch. Defaults to
|
|
22699
|
+
* The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
|
|
21990
22700
|
*/
|
|
21991
22701
|
view?: string;
|
|
21992
22702
|
}
|
|
@@ -29622,6 +30332,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
29622
30332
|
* // "llmEnabled": false,
|
|
29623
30333
|
* // "minimumDataTermAccepted": false,
|
|
29624
30334
|
* // "name": "my_name",
|
|
30335
|
+
* // "nodes": [],
|
|
29625
30336
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
29626
30337
|
* // "solutionType": "my_solutionType",
|
|
29627
30338
|
* // "uiBranding": {},
|
|
@@ -29725,6 +30436,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
29725
30436
|
* // "llmEnabled": false,
|
|
29726
30437
|
* // "minimumDataTermAccepted": false,
|
|
29727
30438
|
* // "name": "my_name",
|
|
30439
|
+
* // "nodes": [],
|
|
29728
30440
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
29729
30441
|
* // "solutionType": "my_solutionType",
|
|
29730
30442
|
* // "uiBranding": {},
|
|
@@ -29769,6 +30481,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
29769
30481
|
* // "llmEnabled": false,
|
|
29770
30482
|
* // "minimumDataTermAccepted": false,
|
|
29771
30483
|
* // "name": "my_name",
|
|
30484
|
+
* // "nodes": [],
|
|
29772
30485
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
29773
30486
|
* // "solutionType": "my_solutionType",
|
|
29774
30487
|
* // "uiBranding": {},
|
|
@@ -29893,6 +30606,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
29893
30606
|
* // "displayName": "my_displayName",
|
|
29894
30607
|
* // "features": {},
|
|
29895
30608
|
* // "industryVertical": "my_industryVertical",
|
|
30609
|
+
* // "knowledgeGraphConfig": {},
|
|
29896
30610
|
* // "mediaRecommendationEngineConfig": {},
|
|
29897
30611
|
* // "modelConfigs": {},
|
|
29898
30612
|
* // "name": "my_name",
|
|
@@ -30055,6 +30769,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30055
30769
|
* // "displayName": "my_displayName",
|
|
30056
30770
|
* // "features": {},
|
|
30057
30771
|
* // "industryVertical": "my_industryVertical",
|
|
30772
|
+
* // "knowledgeGraphConfig": {},
|
|
30058
30773
|
* // "mediaRecommendationEngineConfig": {},
|
|
30059
30774
|
* // "modelConfigs": {},
|
|
30060
30775
|
* // "name": "my_name",
|
|
@@ -30279,6 +30994,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30279
30994
|
* // "displayName": "my_displayName",
|
|
30280
30995
|
* // "features": {},
|
|
30281
30996
|
* // "industryVertical": "my_industryVertical",
|
|
30997
|
+
* // "knowledgeGraphConfig": {},
|
|
30282
30998
|
* // "mediaRecommendationEngineConfig": {},
|
|
30283
30999
|
* // "modelConfigs": {},
|
|
30284
31000
|
* // "name": "my_name",
|
|
@@ -30306,6 +31022,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30306
31022
|
* // "displayName": "my_displayName",
|
|
30307
31023
|
* // "features": {},
|
|
30308
31024
|
* // "industryVertical": "my_industryVertical",
|
|
31025
|
+
* // "knowledgeGraphConfig": {},
|
|
30309
31026
|
* // "mediaRecommendationEngineConfig": {},
|
|
30310
31027
|
* // "modelConfigs": {},
|
|
30311
31028
|
* // "name": "my_name",
|
|
@@ -30395,6 +31112,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30395
31112
|
* // "displayName": "my_displayName",
|
|
30396
31113
|
* // "features": {},
|
|
30397
31114
|
* // "industryVertical": "my_industryVertical",
|
|
31115
|
+
* // "knowledgeGraphConfig": {},
|
|
30398
31116
|
* // "mediaRecommendationEngineConfig": {},
|
|
30399
31117
|
* // "modelConfigs": {},
|
|
30400
31118
|
* // "name": "my_name",
|
|
@@ -30484,6 +31202,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30484
31202
|
* // "displayName": "my_displayName",
|
|
30485
31203
|
* // "features": {},
|
|
30486
31204
|
* // "industryVertical": "my_industryVertical",
|
|
31205
|
+
* // "knowledgeGraphConfig": {},
|
|
30487
31206
|
* // "mediaRecommendationEngineConfig": {},
|
|
30488
31207
|
* // "modelConfigs": {},
|
|
30489
31208
|
* // "name": "my_name",
|
|
@@ -30765,24 +31484,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30765
31484
|
exportMetrics(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
30766
31485
|
exportMetrics(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
30767
31486
|
exportMetrics(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
30768
|
-
}
|
|
30769
|
-
export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics extends StandardParameters {
|
|
30770
|
-
/**
|
|
30771
|
-
* Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/analytics`.
|
|
30772
|
-
*/
|
|
30773
|
-
analytics?: string;
|
|
30774
|
-
/**
|
|
30775
|
-
* Request body metadata
|
|
30776
|
-
*/
|
|
30777
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaExportMetricsRequest;
|
|
30778
|
-
}
|
|
30779
|
-
export class Resource$Projects$Locations$Collections$Engines$Assistants {
|
|
30780
|
-
context: APIRequestContext;
|
|
30781
|
-
agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
|
|
30782
|
-
cannedQueries: Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries;
|
|
30783
|
-
constructor(context: APIRequestContext);
|
|
30784
31487
|
/**
|
|
30785
|
-
*
|
|
31488
|
+
* Gets the AnalyticsConfig.
|
|
30786
31489
|
* @example
|
|
30787
31490
|
* ```js
|
|
30788
31491
|
* // Before running the sample:
|
|
@@ -30805,7 +31508,6 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30805
31508
|
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
30806
31509
|
* scopes: [
|
|
30807
31510
|
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
30808
|
-
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
30809
31511
|
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
30810
31512
|
* ],
|
|
30811
31513
|
* });
|
|
@@ -30816,42 +31518,18 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30816
31518
|
*
|
|
30817
31519
|
* // Do the magic
|
|
30818
31520
|
* const res =
|
|
30819
|
-
* await discoveryengine.projects.locations.collections.engines.
|
|
31521
|
+
* await discoveryengine.projects.locations.collections.engines.analytics.getConfig(
|
|
30820
31522
|
* {
|
|
30821
|
-
* // Required. The
|
|
30822
|
-
*
|
|
30823
|
-
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
30824
|
-
* parent:
|
|
30825
|
-
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
30826
|
-
*
|
|
30827
|
-
* // Request body metadata
|
|
30828
|
-
* requestBody: {
|
|
30829
|
-
* // request body parameters
|
|
30830
|
-
* // {
|
|
30831
|
-
* // "customerPolicy": {},
|
|
30832
|
-
* // "description": "my_description",
|
|
30833
|
-
* // "disableLocationContext": false,
|
|
30834
|
-
* // "displayName": "my_displayName",
|
|
30835
|
-
* // "enabledTools": {},
|
|
30836
|
-
* // "generationConfig": {},
|
|
30837
|
-
* // "name": "my_name",
|
|
30838
|
-
* // "webGroundingType": "my_webGroundingType"
|
|
30839
|
-
* // }
|
|
30840
|
-
* },
|
|
31523
|
+
* // Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
|
|
31524
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/analytics/config',
|
|
30841
31525
|
* },
|
|
30842
31526
|
* );
|
|
30843
31527
|
* console.log(res.data);
|
|
30844
31528
|
*
|
|
30845
31529
|
* // Example response
|
|
30846
31530
|
* // {
|
|
30847
|
-
* // "customerPolicy": {},
|
|
30848
|
-
* // "description": "my_description",
|
|
30849
|
-
* // "disableLocationContext": false,
|
|
30850
|
-
* // "displayName": "my_displayName",
|
|
30851
|
-
* // "enabledTools": {},
|
|
30852
|
-
* // "generationConfig": {},
|
|
30853
31531
|
* // "name": "my_name",
|
|
30854
|
-
* // "
|
|
31532
|
+
* // "userLevelMetricsEnabled": false
|
|
30855
31533
|
* // }
|
|
30856
31534
|
* }
|
|
30857
31535
|
*
|
|
@@ -30867,14 +31545,222 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30867
31545
|
* @param callback - Optional callback that handles the response.
|
|
30868
31546
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
30869
31547
|
*/
|
|
30870
|
-
|
|
30871
|
-
|
|
30872
|
-
|
|
30873
|
-
|
|
30874
|
-
|
|
30875
|
-
|
|
31548
|
+
getConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31549
|
+
getConfig(params?: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>>;
|
|
31550
|
+
getConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31551
|
+
getConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
|
|
31552
|
+
getConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
|
|
31553
|
+
getConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
|
|
30876
31554
|
/**
|
|
30877
|
-
*
|
|
31555
|
+
* Updates the AnalyticsConfig for analytics.
|
|
31556
|
+
* @example
|
|
31557
|
+
* ```js
|
|
31558
|
+
* // Before running the sample:
|
|
31559
|
+
* // - Enable the API at:
|
|
31560
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31561
|
+
* // - Login into gcloud by running:
|
|
31562
|
+
* // ```sh
|
|
31563
|
+
* // $ gcloud auth application-default login
|
|
31564
|
+
* // ```
|
|
31565
|
+
* // - Install the npm module by running:
|
|
31566
|
+
* // ```sh
|
|
31567
|
+
* // $ npm install googleapis
|
|
31568
|
+
* // ```
|
|
31569
|
+
*
|
|
31570
|
+
* const {google} = require('googleapis');
|
|
31571
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31572
|
+
*
|
|
31573
|
+
* async function main() {
|
|
31574
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31575
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31576
|
+
* scopes: [
|
|
31577
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31578
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31579
|
+
* ],
|
|
31580
|
+
* });
|
|
31581
|
+
*
|
|
31582
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31583
|
+
* const authClient = await auth.getClient();
|
|
31584
|
+
* google.options({auth: authClient});
|
|
31585
|
+
*
|
|
31586
|
+
* // Do the magic
|
|
31587
|
+
* const res =
|
|
31588
|
+
* await discoveryengine.projects.locations.collections.engines.analytics.updateConfig(
|
|
31589
|
+
* {
|
|
31590
|
+
* // Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
|
|
31591
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/analytics/config',
|
|
31592
|
+
* // The list of fields of AnalyticsConfig to update. If not specified, the method will perform a full replacement.
|
|
31593
|
+
* updateMask: 'placeholder-value',
|
|
31594
|
+
*
|
|
31595
|
+
* // Request body metadata
|
|
31596
|
+
* requestBody: {
|
|
31597
|
+
* // request body parameters
|
|
31598
|
+
* // {
|
|
31599
|
+
* // "name": "my_name",
|
|
31600
|
+
* // "userLevelMetricsEnabled": false
|
|
31601
|
+
* // }
|
|
31602
|
+
* },
|
|
31603
|
+
* },
|
|
31604
|
+
* );
|
|
31605
|
+
* console.log(res.data);
|
|
31606
|
+
*
|
|
31607
|
+
* // Example response
|
|
31608
|
+
* // {
|
|
31609
|
+
* // "name": "my_name",
|
|
31610
|
+
* // "userLevelMetricsEnabled": false
|
|
31611
|
+
* // }
|
|
31612
|
+
* }
|
|
31613
|
+
*
|
|
31614
|
+
* main().catch(e => {
|
|
31615
|
+
* console.error(e);
|
|
31616
|
+
* throw e;
|
|
31617
|
+
* });
|
|
31618
|
+
*
|
|
31619
|
+
* ```
|
|
31620
|
+
*
|
|
31621
|
+
* @param params - Parameters for request
|
|
31622
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31623
|
+
* @param callback - Optional callback that handles the response.
|
|
31624
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31625
|
+
*/
|
|
31626
|
+
updateConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31627
|
+
updateConfig(params?: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>>;
|
|
31628
|
+
updateConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31629
|
+
updateConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
|
|
31630
|
+
updateConfig(params: Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
|
|
31631
|
+
updateConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig>): void;
|
|
31632
|
+
}
|
|
31633
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Exportmetrics extends StandardParameters {
|
|
31634
|
+
/**
|
|
31635
|
+
* Required. The analytics resource name under the engine where the metrics are created. The format is `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/analytics`.
|
|
31636
|
+
*/
|
|
31637
|
+
analytics?: string;
|
|
31638
|
+
/**
|
|
31639
|
+
* Request body metadata
|
|
31640
|
+
*/
|
|
31641
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaExportMetricsRequest;
|
|
31642
|
+
}
|
|
31643
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Getconfig extends StandardParameters {
|
|
31644
|
+
/**
|
|
31645
|
+
* Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
|
|
31646
|
+
*/
|
|
31647
|
+
name?: string;
|
|
31648
|
+
}
|
|
31649
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Analytics$Updateconfig extends StandardParameters {
|
|
31650
|
+
/**
|
|
31651
|
+
* Required. The resource name of the analytics customer config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/analytics/config`
|
|
31652
|
+
*/
|
|
31653
|
+
name?: string;
|
|
31654
|
+
/**
|
|
31655
|
+
* The list of fields of AnalyticsConfig to update. If not specified, the method will perform a full replacement.
|
|
31656
|
+
*/
|
|
31657
|
+
updateMask?: string;
|
|
31658
|
+
/**
|
|
31659
|
+
* Request body metadata
|
|
31660
|
+
*/
|
|
31661
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnalyticsConfig;
|
|
31662
|
+
}
|
|
31663
|
+
export class Resource$Projects$Locations$Collections$Engines$Assistants {
|
|
31664
|
+
context: APIRequestContext;
|
|
31665
|
+
agents: Resource$Projects$Locations$Collections$Engines$Assistants$Agents;
|
|
31666
|
+
cannedQueries: Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries;
|
|
31667
|
+
constructor(context: APIRequestContext);
|
|
31668
|
+
/**
|
|
31669
|
+
* Creates an Assistant.
|
|
31670
|
+
* @example
|
|
31671
|
+
* ```js
|
|
31672
|
+
* // Before running the sample:
|
|
31673
|
+
* // - Enable the API at:
|
|
31674
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
31675
|
+
* // - Login into gcloud by running:
|
|
31676
|
+
* // ```sh
|
|
31677
|
+
* // $ gcloud auth application-default login
|
|
31678
|
+
* // ```
|
|
31679
|
+
* // - Install the npm module by running:
|
|
31680
|
+
* // ```sh
|
|
31681
|
+
* // $ npm install googleapis
|
|
31682
|
+
* // ```
|
|
31683
|
+
*
|
|
31684
|
+
* const {google} = require('googleapis');
|
|
31685
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
31686
|
+
*
|
|
31687
|
+
* async function main() {
|
|
31688
|
+
* const auth = new google.auth.GoogleAuth({
|
|
31689
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
31690
|
+
* scopes: [
|
|
31691
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
31692
|
+
* 'https://www.googleapis.com/auth/discoveryengine.assist.readwrite',
|
|
31693
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
31694
|
+
* ],
|
|
31695
|
+
* });
|
|
31696
|
+
*
|
|
31697
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
31698
|
+
* const authClient = await auth.getClient();
|
|
31699
|
+
* google.options({auth: authClient});
|
|
31700
|
+
*
|
|
31701
|
+
* // Do the magic
|
|
31702
|
+
* const res =
|
|
31703
|
+
* await discoveryengine.projects.locations.collections.engines.assistants.create(
|
|
31704
|
+
* {
|
|
31705
|
+
* // Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
|
|
31706
|
+
* assistantId: 'placeholder-value',
|
|
31707
|
+
* // Required. The parent resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
31708
|
+
* parent:
|
|
31709
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
31710
|
+
*
|
|
31711
|
+
* // Request body metadata
|
|
31712
|
+
* requestBody: {
|
|
31713
|
+
* // request body parameters
|
|
31714
|
+
* // {
|
|
31715
|
+
* // "customerPolicy": {},
|
|
31716
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
31717
|
+
* // "description": "my_description",
|
|
31718
|
+
* // "disableLocationContext": false,
|
|
31719
|
+
* // "displayName": "my_displayName",
|
|
31720
|
+
* // "enabledTools": {},
|
|
31721
|
+
* // "generationConfig": {},
|
|
31722
|
+
* // "name": "my_name",
|
|
31723
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
31724
|
+
* // }
|
|
31725
|
+
* },
|
|
31726
|
+
* },
|
|
31727
|
+
* );
|
|
31728
|
+
* console.log(res.data);
|
|
31729
|
+
*
|
|
31730
|
+
* // Example response
|
|
31731
|
+
* // {
|
|
31732
|
+
* // "customerPolicy": {},
|
|
31733
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
31734
|
+
* // "description": "my_description",
|
|
31735
|
+
* // "disableLocationContext": false,
|
|
31736
|
+
* // "displayName": "my_displayName",
|
|
31737
|
+
* // "enabledTools": {},
|
|
31738
|
+
* // "generationConfig": {},
|
|
31739
|
+
* // "name": "my_name",
|
|
31740
|
+
* // "webGroundingType": "my_webGroundingType"
|
|
31741
|
+
* // }
|
|
31742
|
+
* }
|
|
31743
|
+
*
|
|
31744
|
+
* main().catch(e => {
|
|
31745
|
+
* console.error(e);
|
|
31746
|
+
* throw e;
|
|
31747
|
+
* });
|
|
31748
|
+
*
|
|
31749
|
+
* ```
|
|
31750
|
+
*
|
|
31751
|
+
* @param params - Parameters for request
|
|
31752
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
31753
|
+
* @param callback - Optional callback that handles the response.
|
|
31754
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
31755
|
+
*/
|
|
31756
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
31757
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>>;
|
|
31758
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
31759
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>): void;
|
|
31760
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Assistants$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>): void;
|
|
31761
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAssistant>): void;
|
|
31762
|
+
/**
|
|
31763
|
+
* Deletes an Assistant.
|
|
30878
31764
|
* @example
|
|
30879
31765
|
* ```js
|
|
30880
31766
|
* // Before running the sample:
|
|
@@ -30984,6 +31870,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
30984
31870
|
* // Example response
|
|
30985
31871
|
* // {
|
|
30986
31872
|
* // "customerPolicy": {},
|
|
31873
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
30987
31874
|
* // "description": "my_description",
|
|
30988
31875
|
* // "disableLocationContext": false,
|
|
30989
31876
|
* // "displayName": "my_displayName",
|
|
@@ -31132,7 +32019,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31132
32019
|
* languageCode: 'placeholder-value',
|
|
31133
32020
|
* // Optional. The maximum number of suggested prompts to return per agent.
|
|
31134
32021
|
* maxSuggestedPrompts: 'placeholder-value',
|
|
31135
|
-
* // Optional. Maximum number of
|
|
32022
|
+
* // 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.
|
|
31136
32023
|
* pageSize: 'placeholder-value',
|
|
31137
32024
|
* // 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.
|
|
31138
32025
|
* pageToken: 'placeholder-value',
|
|
@@ -31217,6 +32104,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31217
32104
|
* // request body parameters
|
|
31218
32105
|
* // {
|
|
31219
32106
|
* // "customerPolicy": {},
|
|
32107
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
31220
32108
|
* // "description": "my_description",
|
|
31221
32109
|
* // "disableLocationContext": false,
|
|
31222
32110
|
* // "displayName": "my_displayName",
|
|
@@ -31233,6 +32121,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31233
32121
|
* // Example response
|
|
31234
32122
|
* // {
|
|
31235
32123
|
* // "customerPolicy": {},
|
|
32124
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
31236
32125
|
* // "description": "my_description",
|
|
31237
32126
|
* // "disableLocationContext": false,
|
|
31238
32127
|
* // "displayName": "my_displayName",
|
|
@@ -31406,7 +32295,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31406
32295
|
*/
|
|
31407
32296
|
maxSuggestedPrompts?: number;
|
|
31408
32297
|
/**
|
|
31409
|
-
* Optional. Maximum number of
|
|
32298
|
+
* 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.
|
|
31410
32299
|
*/
|
|
31411
32300
|
pageSize?: number;
|
|
31412
32301
|
/**
|
|
@@ -31673,6 +32562,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31673
32562
|
* {
|
|
31674
32563
|
* // Required. The name of the Agent to disable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
31675
32564
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
|
|
32565
|
+
* // Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.
|
|
32566
|
+
* revisionId: 'placeholder-value',
|
|
31676
32567
|
* },
|
|
31677
32568
|
* );
|
|
31678
32569
|
* console.log(res.data);
|
|
@@ -31758,6 +32649,8 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
31758
32649
|
* {
|
|
31759
32650
|
* // Required. The name of the Agent to enable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
31760
32651
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/assistants/my-assistant/agents/my-agent',
|
|
32652
|
+
* // Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.
|
|
32653
|
+
* revisionId: 'placeholder-value',
|
|
31761
32654
|
* },
|
|
31762
32655
|
* );
|
|
31763
32656
|
* console.log(res.data);
|
|
@@ -32409,12 +33302,20 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
32409
33302
|
* Required. The name of the Agent to disable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
32410
33303
|
*/
|
|
32411
33304
|
name?: string;
|
|
33305
|
+
/**
|
|
33306
|
+
* Optional. The Revision ID of the Agent to disable. If not specified, the latest revision will be disabled.
|
|
33307
|
+
*/
|
|
33308
|
+
revisionId?: string;
|
|
32412
33309
|
}
|
|
32413
33310
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Enableagent extends StandardParameters {
|
|
32414
33311
|
/**
|
|
32415
33312
|
* Required. The name of the Agent to enable. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
32416
33313
|
*/
|
|
32417
33314
|
name?: string;
|
|
33315
|
+
/**
|
|
33316
|
+
* Optional. The Revision ID of the Agent to enable. If not specified, the latest revision will be enabled.
|
|
33317
|
+
*/
|
|
33318
|
+
revisionId?: string;
|
|
32418
33319
|
}
|
|
32419
33320
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Assistants$Agents$Get extends StandardParameters {
|
|
32420
33321
|
/**
|
|
@@ -36516,6 +37417,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
36516
37417
|
* // "llmEnabled": false,
|
|
36517
37418
|
* // "minimumDataTermAccepted": false,
|
|
36518
37419
|
* // "name": "my_name",
|
|
37420
|
+
* // "nodes": [],
|
|
36519
37421
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
36520
37422
|
* // "solutionType": "my_solutionType",
|
|
36521
37423
|
* // "uiBranding": {},
|
|
@@ -36619,6 +37521,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
36619
37521
|
* // "llmEnabled": false,
|
|
36620
37522
|
* // "minimumDataTermAccepted": false,
|
|
36621
37523
|
* // "name": "my_name",
|
|
37524
|
+
* // "nodes": [],
|
|
36622
37525
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
36623
37526
|
* // "solutionType": "my_solutionType",
|
|
36624
37527
|
* // "uiBranding": {},
|
|
@@ -36663,6 +37566,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
36663
37566
|
* // "llmEnabled": false,
|
|
36664
37567
|
* // "minimumDataTermAccepted": false,
|
|
36665
37568
|
* // "name": "my_name",
|
|
37569
|
+
* // "nodes": [],
|
|
36666
37570
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
36667
37571
|
* // "solutionType": "my_solutionType",
|
|
36668
37572
|
* // "uiBranding": {},
|
|
@@ -36909,6 +37813,84 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
36909
37813
|
userEvents: Resource$Projects$Locations$Datastores$Userevents;
|
|
36910
37814
|
widgetConfigs: Resource$Projects$Locations$Datastores$Widgetconfigs;
|
|
36911
37815
|
constructor(context: APIRequestContext);
|
|
37816
|
+
/**
|
|
37817
|
+
* 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.
|
|
37818
|
+
* @example
|
|
37819
|
+
* ```js
|
|
37820
|
+
* // Before running the sample:
|
|
37821
|
+
* // - Enable the API at:
|
|
37822
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
37823
|
+
* // - Login into gcloud by running:
|
|
37824
|
+
* // ```sh
|
|
37825
|
+
* // $ gcloud auth application-default login
|
|
37826
|
+
* // ```
|
|
37827
|
+
* // - Install the npm module by running:
|
|
37828
|
+
* // ```sh
|
|
37829
|
+
* // $ npm install googleapis
|
|
37830
|
+
* // ```
|
|
37831
|
+
*
|
|
37832
|
+
* const {google} = require('googleapis');
|
|
37833
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
37834
|
+
*
|
|
37835
|
+
* async function main() {
|
|
37836
|
+
* const auth = new google.auth.GoogleAuth({
|
|
37837
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
37838
|
+
* scopes: [
|
|
37839
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
37840
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
37841
|
+
* ],
|
|
37842
|
+
* });
|
|
37843
|
+
*
|
|
37844
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
37845
|
+
* const authClient = await auth.getClient();
|
|
37846
|
+
* google.options({auth: authClient});
|
|
37847
|
+
*
|
|
37848
|
+
* // Do the magic
|
|
37849
|
+
* const res =
|
|
37850
|
+
* await discoveryengine.projects.locations.dataStores.addPatientFilter({
|
|
37851
|
+
* // 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.
|
|
37852
|
+
* dataStore:
|
|
37853
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
37854
|
+
*
|
|
37855
|
+
* // Request body metadata
|
|
37856
|
+
* requestBody: {
|
|
37857
|
+
* // request body parameters
|
|
37858
|
+
* // {
|
|
37859
|
+
* // "dataStore": "my_dataStore",
|
|
37860
|
+
* // "filterGroups": []
|
|
37861
|
+
* // }
|
|
37862
|
+
* },
|
|
37863
|
+
* });
|
|
37864
|
+
* console.log(res.data);
|
|
37865
|
+
*
|
|
37866
|
+
* // Example response
|
|
37867
|
+
* // {
|
|
37868
|
+
* // "done": false,
|
|
37869
|
+
* // "error": {},
|
|
37870
|
+
* // "metadata": {},
|
|
37871
|
+
* // "name": "my_name",
|
|
37872
|
+
* // "response": {}
|
|
37873
|
+
* // }
|
|
37874
|
+
* }
|
|
37875
|
+
*
|
|
37876
|
+
* main().catch(e => {
|
|
37877
|
+
* console.error(e);
|
|
37878
|
+
* throw e;
|
|
37879
|
+
* });
|
|
37880
|
+
*
|
|
37881
|
+
* ```
|
|
37882
|
+
*
|
|
37883
|
+
* @param params - Parameters for request
|
|
37884
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
37885
|
+
* @param callback - Optional callback that handles the response.
|
|
37886
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
37887
|
+
*/
|
|
37888
|
+
addPatientFilter(params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
37889
|
+
addPatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
37890
|
+
addPatientFilter(params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
37891
|
+
addPatientFilter(params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37892
|
+
addPatientFilter(params: Params$Resource$Projects$Locations$Datastores$Addpatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37893
|
+
addPatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
36912
37894
|
/**
|
|
36913
37895
|
* Completes the specified user input with keyword suggestions.
|
|
36914
37896
|
* @example
|
|
@@ -37162,6 +38144,83 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37162
38144
|
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37163
38145
|
delete(params: Params$Resource$Projects$Locations$Datastores$Delete, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37164
38146
|
delete(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38147
|
+
/**
|
|
38148
|
+
* 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.
|
|
38149
|
+
* @example
|
|
38150
|
+
* ```js
|
|
38151
|
+
* // Before running the sample:
|
|
38152
|
+
* // - Enable the API at:
|
|
38153
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38154
|
+
* // - Login into gcloud by running:
|
|
38155
|
+
* // ```sh
|
|
38156
|
+
* // $ gcloud auth application-default login
|
|
38157
|
+
* // ```
|
|
38158
|
+
* // - Install the npm module by running:
|
|
38159
|
+
* // ```sh
|
|
38160
|
+
* // $ npm install googleapis
|
|
38161
|
+
* // ```
|
|
38162
|
+
*
|
|
38163
|
+
* const {google} = require('googleapis');
|
|
38164
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
38165
|
+
*
|
|
38166
|
+
* async function main() {
|
|
38167
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38168
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38169
|
+
* scopes: [
|
|
38170
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38171
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38172
|
+
* ],
|
|
38173
|
+
* });
|
|
38174
|
+
*
|
|
38175
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38176
|
+
* const authClient = await auth.getClient();
|
|
38177
|
+
* google.options({auth: authClient});
|
|
38178
|
+
*
|
|
38179
|
+
* // Do the magic
|
|
38180
|
+
* const res =
|
|
38181
|
+
* await discoveryengine.projects.locations.dataStores.deletePatientFilter({
|
|
38182
|
+
* // 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.
|
|
38183
|
+
* dataStore:
|
|
38184
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
38185
|
+
*
|
|
38186
|
+
* // Request body metadata
|
|
38187
|
+
* requestBody: {
|
|
38188
|
+
* // request body parameters
|
|
38189
|
+
* // {
|
|
38190
|
+
* // "dataStore": "my_dataStore"
|
|
38191
|
+
* // }
|
|
38192
|
+
* },
|
|
38193
|
+
* });
|
|
38194
|
+
* console.log(res.data);
|
|
38195
|
+
*
|
|
38196
|
+
* // Example response
|
|
38197
|
+
* // {
|
|
38198
|
+
* // "done": false,
|
|
38199
|
+
* // "error": {},
|
|
38200
|
+
* // "metadata": {},
|
|
38201
|
+
* // "name": "my_name",
|
|
38202
|
+
* // "response": {}
|
|
38203
|
+
* // }
|
|
38204
|
+
* }
|
|
38205
|
+
*
|
|
38206
|
+
* main().catch(e => {
|
|
38207
|
+
* console.error(e);
|
|
38208
|
+
* throw e;
|
|
38209
|
+
* });
|
|
38210
|
+
*
|
|
38211
|
+
* ```
|
|
38212
|
+
*
|
|
38213
|
+
* @param params - Parameters for request
|
|
38214
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38215
|
+
* @param callback - Optional callback that handles the response.
|
|
38216
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38217
|
+
*/
|
|
38218
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38219
|
+
deletePatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
38220
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38221
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38222
|
+
deletePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Deletepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38223
|
+
deletePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37165
38224
|
/**
|
|
37166
38225
|
* Gets a DataStore.
|
|
37167
38226
|
* @example
|
|
@@ -37571,6 +38630,162 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37571
38630
|
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
37572
38631
|
patch(params: Params$Resource$Projects$Locations$Datastores$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
37573
38632
|
patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDataStore>): void;
|
|
38633
|
+
/**
|
|
38634
|
+
* 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.
|
|
38635
|
+
* @example
|
|
38636
|
+
* ```js
|
|
38637
|
+
* // Before running the sample:
|
|
38638
|
+
* // - Enable the API at:
|
|
38639
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38640
|
+
* // - Login into gcloud by running:
|
|
38641
|
+
* // ```sh
|
|
38642
|
+
* // $ gcloud auth application-default login
|
|
38643
|
+
* // ```
|
|
38644
|
+
* // - Install the npm module by running:
|
|
38645
|
+
* // ```sh
|
|
38646
|
+
* // $ npm install googleapis
|
|
38647
|
+
* // ```
|
|
38648
|
+
*
|
|
38649
|
+
* const {google} = require('googleapis');
|
|
38650
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
38651
|
+
*
|
|
38652
|
+
* async function main() {
|
|
38653
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38654
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38655
|
+
* scopes: [
|
|
38656
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38657
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38658
|
+
* ],
|
|
38659
|
+
* });
|
|
38660
|
+
*
|
|
38661
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38662
|
+
* const authClient = await auth.getClient();
|
|
38663
|
+
* google.options({auth: authClient});
|
|
38664
|
+
*
|
|
38665
|
+
* // Do the magic
|
|
38666
|
+
* const res =
|
|
38667
|
+
* await discoveryengine.projects.locations.dataStores.removePatientFilter({
|
|
38668
|
+
* // 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
|
|
38669
|
+
* dataStore:
|
|
38670
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
38671
|
+
*
|
|
38672
|
+
* // Request body metadata
|
|
38673
|
+
* requestBody: {
|
|
38674
|
+
* // request body parameters
|
|
38675
|
+
* // {
|
|
38676
|
+
* // "dataStore": "my_dataStore",
|
|
38677
|
+
* // "filterGroups": []
|
|
38678
|
+
* // }
|
|
38679
|
+
* },
|
|
38680
|
+
* });
|
|
38681
|
+
* console.log(res.data);
|
|
38682
|
+
*
|
|
38683
|
+
* // Example response
|
|
38684
|
+
* // {
|
|
38685
|
+
* // "done": false,
|
|
38686
|
+
* // "error": {},
|
|
38687
|
+
* // "metadata": {},
|
|
38688
|
+
* // "name": "my_name",
|
|
38689
|
+
* // "response": {}
|
|
38690
|
+
* // }
|
|
38691
|
+
* }
|
|
38692
|
+
*
|
|
38693
|
+
* main().catch(e => {
|
|
38694
|
+
* console.error(e);
|
|
38695
|
+
* throw e;
|
|
38696
|
+
* });
|
|
38697
|
+
*
|
|
38698
|
+
* ```
|
|
38699
|
+
*
|
|
38700
|
+
* @param params - Parameters for request
|
|
38701
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38702
|
+
* @param callback - Optional callback that handles the response.
|
|
38703
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38704
|
+
*/
|
|
38705
|
+
removePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38706
|
+
removePatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
38707
|
+
removePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38708
|
+
removePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38709
|
+
removePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Removepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38710
|
+
removePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38711
|
+
/**
|
|
38712
|
+
* 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.
|
|
38713
|
+
* @example
|
|
38714
|
+
* ```js
|
|
38715
|
+
* // Before running the sample:
|
|
38716
|
+
* // - Enable the API at:
|
|
38717
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38718
|
+
* // - Login into gcloud by running:
|
|
38719
|
+
* // ```sh
|
|
38720
|
+
* // $ gcloud auth application-default login
|
|
38721
|
+
* // ```
|
|
38722
|
+
* // - Install the npm module by running:
|
|
38723
|
+
* // ```sh
|
|
38724
|
+
* // $ npm install googleapis
|
|
38725
|
+
* // ```
|
|
38726
|
+
*
|
|
38727
|
+
* const {google} = require('googleapis');
|
|
38728
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
38729
|
+
*
|
|
38730
|
+
* async function main() {
|
|
38731
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38732
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38733
|
+
* scopes: [
|
|
38734
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38735
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38736
|
+
* ],
|
|
38737
|
+
* });
|
|
38738
|
+
*
|
|
38739
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38740
|
+
* const authClient = await auth.getClient();
|
|
38741
|
+
* google.options({auth: authClient});
|
|
38742
|
+
*
|
|
38743
|
+
* // Do the magic
|
|
38744
|
+
* const res =
|
|
38745
|
+
* await discoveryengine.projects.locations.dataStores.replacePatientFilter({
|
|
38746
|
+
* // 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.
|
|
38747
|
+
* dataStore:
|
|
38748
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
38749
|
+
*
|
|
38750
|
+
* // Request body metadata
|
|
38751
|
+
* requestBody: {
|
|
38752
|
+
* // request body parameters
|
|
38753
|
+
* // {
|
|
38754
|
+
* // "dataStore": "my_dataStore",
|
|
38755
|
+
* // "filterGroups": []
|
|
38756
|
+
* // }
|
|
38757
|
+
* },
|
|
38758
|
+
* });
|
|
38759
|
+
* console.log(res.data);
|
|
38760
|
+
*
|
|
38761
|
+
* // Example response
|
|
38762
|
+
* // {
|
|
38763
|
+
* // "done": false,
|
|
38764
|
+
* // "error": {},
|
|
38765
|
+
* // "metadata": {},
|
|
38766
|
+
* // "name": "my_name",
|
|
38767
|
+
* // "response": {}
|
|
38768
|
+
* // }
|
|
38769
|
+
* }
|
|
38770
|
+
*
|
|
38771
|
+
* main().catch(e => {
|
|
38772
|
+
* console.error(e);
|
|
38773
|
+
* throw e;
|
|
38774
|
+
* });
|
|
38775
|
+
*
|
|
38776
|
+
* ```
|
|
38777
|
+
*
|
|
38778
|
+
* @param params - Parameters for request
|
|
38779
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38780
|
+
* @param callback - Optional callback that handles the response.
|
|
38781
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38782
|
+
*/
|
|
38783
|
+
replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38784
|
+
replacePatientFilter(params?: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
38785
|
+
replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
38786
|
+
replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38787
|
+
replacePatientFilter(params: Params$Resource$Projects$Locations$Datastores$Replacepatientfilter, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
38788
|
+
replacePatientFilter(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
37574
38789
|
/**
|
|
37575
38790
|
* 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.
|
|
37576
38791
|
* @example
|
|
@@ -37654,6 +38869,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37654
38869
|
updateDocumentProcessingConfig(params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
|
|
37655
38870
|
updateDocumentProcessingConfig(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>): void;
|
|
37656
38871
|
}
|
|
38872
|
+
export interface Params$Resource$Projects$Locations$Datastores$Addpatientfilter extends StandardParameters {
|
|
38873
|
+
/**
|
|
38874
|
+
* 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.
|
|
38875
|
+
*/
|
|
38876
|
+
dataStore?: string;
|
|
38877
|
+
/**
|
|
38878
|
+
* Request body metadata
|
|
38879
|
+
*/
|
|
38880
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest;
|
|
38881
|
+
}
|
|
37657
38882
|
export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters {
|
|
37658
38883
|
/**
|
|
37659
38884
|
* 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`.
|
|
@@ -37712,6 +38937,16 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37712
38937
|
*/
|
|
37713
38938
|
name?: string;
|
|
37714
38939
|
}
|
|
38940
|
+
export interface Params$Resource$Projects$Locations$Datastores$Deletepatientfilter extends StandardParameters {
|
|
38941
|
+
/**
|
|
38942
|
+
* 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.
|
|
38943
|
+
*/
|
|
38944
|
+
dataStore?: string;
|
|
38945
|
+
/**
|
|
38946
|
+
* Request body metadata
|
|
38947
|
+
*/
|
|
38948
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest;
|
|
38949
|
+
}
|
|
37715
38950
|
export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters {
|
|
37716
38951
|
/**
|
|
37717
38952
|
* 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.
|
|
@@ -37762,6 +38997,26 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37762
38997
|
*/
|
|
37763
38998
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore;
|
|
37764
38999
|
}
|
|
39000
|
+
export interface Params$Resource$Projects$Locations$Datastores$Removepatientfilter extends StandardParameters {
|
|
39001
|
+
/**
|
|
39002
|
+
* 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
|
|
39003
|
+
*/
|
|
39004
|
+
dataStore?: string;
|
|
39005
|
+
/**
|
|
39006
|
+
* Request body metadata
|
|
39007
|
+
*/
|
|
39008
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest;
|
|
39009
|
+
}
|
|
39010
|
+
export interface Params$Resource$Projects$Locations$Datastores$Replacepatientfilter extends StandardParameters {
|
|
39011
|
+
/**
|
|
39012
|
+
* 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.
|
|
39013
|
+
*/
|
|
39014
|
+
dataStore?: string;
|
|
39015
|
+
/**
|
|
39016
|
+
* Request body metadata
|
|
39017
|
+
*/
|
|
39018
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest;
|
|
39019
|
+
}
|
|
37765
39020
|
export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters {
|
|
37766
39021
|
/**
|
|
37767
39022
|
* The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`.
|
|
@@ -37888,7 +39143,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37888
39143
|
* const res = await discoveryengine.projects.locations.dataStores.branches.get({
|
|
37889
39144
|
* // 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.
|
|
37890
39145
|
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/branches/my-branche',
|
|
37891
|
-
* // The view to apply to the returned Branch. Defaults to
|
|
39146
|
+
* // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
|
|
37892
39147
|
* view: 'placeholder-value',
|
|
37893
39148
|
* });
|
|
37894
39149
|
* console.log(res.data);
|
|
@@ -37959,7 +39214,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
37959
39214
|
* // Required. The parent data store resource name.
|
|
37960
39215
|
* parent:
|
|
37961
39216
|
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
37962
|
-
* // The view to apply to the returned Branch. Defaults to
|
|
39217
|
+
* // The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
|
|
37963
39218
|
* view: 'placeholder-value',
|
|
37964
39219
|
* },
|
|
37965
39220
|
* );
|
|
@@ -38010,7 +39265,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38010
39265
|
*/
|
|
38011
39266
|
name?: string;
|
|
38012
39267
|
/**
|
|
38013
|
-
* The view to apply to the returned Branch. Defaults to
|
|
39268
|
+
* The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
|
|
38014
39269
|
*/
|
|
38015
39270
|
view?: string;
|
|
38016
39271
|
}
|
|
@@ -38020,7 +39275,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
38020
39275
|
*/
|
|
38021
39276
|
parent?: string;
|
|
38022
39277
|
/**
|
|
38023
|
-
* The view to apply to the returned Branch. Defaults to
|
|
39278
|
+
* The view to apply to the returned Branch. Defaults to BranchView.BRANCH_VIEW_BASIC if unspecified.
|
|
38024
39279
|
*/
|
|
38025
39280
|
view?: string;
|
|
38026
39281
|
}
|
|
@@ -44623,6 +45878,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
44623
45878
|
* // "llmEnabled": false,
|
|
44624
45879
|
* // "minimumDataTermAccepted": false,
|
|
44625
45880
|
* // "name": "my_name",
|
|
45881
|
+
* // "nodes": [],
|
|
44626
45882
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
44627
45883
|
* // "solutionType": "my_solutionType",
|
|
44628
45884
|
* // "uiBranding": {},
|
|
@@ -44725,6 +45981,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
44725
45981
|
* // "llmEnabled": false,
|
|
44726
45982
|
* // "minimumDataTermAccepted": false,
|
|
44727
45983
|
* // "name": "my_name",
|
|
45984
|
+
* // "nodes": [],
|
|
44728
45985
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
44729
45986
|
* // "solutionType": "my_solutionType",
|
|
44730
45987
|
* // "uiBranding": {},
|
|
@@ -44768,6 +46025,7 @@ export declare namespace discoveryengine_v1alpha {
|
|
|
44768
46025
|
* // "llmEnabled": false,
|
|
44769
46026
|
* // "minimumDataTermAccepted": false,
|
|
44770
46027
|
* // "name": "my_name",
|
|
46028
|
+
* // "nodes": [],
|
|
44771
46029
|
* // "resultDisplayType": "my_resultDisplayType",
|
|
44772
46030
|
* // "solutionType": "my_solutionType",
|
|
44773
46031
|
* // "uiBranding": {},
|