@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.1.20251221 → 0.1.20260112

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.
Files changed (2) hide show
  1. package/index.d.ts +115 -1
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20251221
12
+ // Revision: 20260112
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -230,6 +230,12 @@ declare namespace gapi.client {
230
230
  /** Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. */
231
231
  useStaticSecrets?: boolean;
232
232
  }
233
+ interface GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
234
+ /** 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. */
235
+ dataStore?: string;
236
+ /** 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. */
237
+ filterGroups?: string[];
238
+ }
233
239
  interface GoogleCloudDiscoveryengineV1alphaAdvancedSiteSearchConfig {
234
240
  /** If set true, automatic refresh is disabled for the DataStore. */
235
241
  disableAutomaticRefresh?: boolean;
@@ -1095,6 +1101,10 @@ declare namespace gapi.client {
1095
1101
  /** Operation last update time. If the operation is done, this is also the finish time. */
1096
1102
  updateTime?: string;
1097
1103
  }
1104
+ interface GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest {
1105
+ /** 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. */
1106
+ dataStore?: string;
1107
+ }
1098
1108
  interface GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata {
1099
1109
  /** Operation create time. */
1100
1110
  createTime?: string;
@@ -1233,6 +1243,8 @@ declare namespace gapi.client {
1233
1243
  features?: {[P in string]: string};
1234
1244
  /** 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. */
1235
1245
  industryVertical?: string;
1246
+ /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
1247
+ knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
1236
1248
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
1237
1249
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
1238
1250
  /** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
@@ -1276,6 +1288,28 @@ declare namespace gapi.client {
1276
1288
  /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
1277
1289
  companyName?: string;
1278
1290
  }
1291
+ interface GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig {
1292
+ /** Specify entity types to support. */
1293
+ cloudKnowledgeGraphTypes?: string[];
1294
+ /** Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. */
1295
+ enableCloudKnowledgeGraph?: boolean;
1296
+ /** Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. */
1297
+ enablePrivateKnowledgeGraph?: boolean;
1298
+ /** Optional. Feature config for the Knowledge Graph. */
1299
+ featureConfig?: GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig;
1300
+ /** Specify entity types to support. */
1301
+ privateKnowledgeGraphTypes?: string[];
1302
+ }
1303
+ interface GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfigFeatureConfig {
1304
+ /** Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. */
1305
+ disablePrivateKgAutoComplete?: boolean;
1306
+ /** Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. */
1307
+ disablePrivateKgEnrichment?: boolean;
1308
+ /** Whether to disable the private KG for query UI chips. Defaults to false if not specified. */
1309
+ disablePrivateKgQueryUiChips?: boolean;
1310
+ /** Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. */
1311
+ disablePrivateKgQueryUnderstanding?: boolean;
1312
+ }
1279
1313
  interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
1280
1314
  /** Optional. Additional engine features config. */
1281
1315
  engineFeaturesConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigEngineFeaturesConfig;
@@ -1415,6 +1449,8 @@ declare namespace gapi.client {
1415
1449
  enableConfigurableSchema?: boolean;
1416
1450
  /** 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. */
1417
1451
  enableStaticIndexingForBatchIngestion?: boolean;
1452
+ /** 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. */
1453
+ initialFilterGroups?: string[];
1418
1454
  }
1419
1455
  interface GoogleCloudDiscoveryengineV1alphaIdentityMappingEntryOperationMetadata {
1420
1456
  /** The number of IdentityMappingEntries that failed to be processed. */
@@ -1616,6 +1652,16 @@ declare namespace gapi.client {
1616
1652
  /** Vertex AI's organic crawl rate time series, which is the crawl rate of Google-CloudVertexBot when dedicate crawl is not set. Please refer to https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot for more details about Google-CloudVertexBot. */
1617
1653
  vertexAiOrganicCrawlRate?: GoogleCloudDiscoveryengineV1alphaCrawlRateTimeSeries;
1618
1654
  }
1655
+ interface GoogleCloudDiscoveryengineV1alphaPatientFilterOperationMetadata {
1656
+ /** Operation create time. */
1657
+ createTime?: string;
1658
+ /** The number of patient IDs added to the patient filter. */
1659
+ filtersAddedCount?: string;
1660
+ /** The number of patient IDs removed from the patient filter. */
1661
+ filtersRemovedCount?: string;
1662
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1663
+ updateTime?: string;
1664
+ }
1619
1665
  interface GoogleCloudDiscoveryengineV1alphaProject {
1620
1666
  /** Output only. The current status of the project's configurable billing. */
1621
1667
  configurableBillingStatus?: GoogleCloudDiscoveryengineV1alphaProjectConfigurableBillingStatus;
@@ -1809,6 +1855,18 @@ declare namespace gapi.client {
1809
1855
  /** Output only. The state of the response. */
1810
1856
  state?: string;
1811
1857
  }
1858
+ interface GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest {
1859
+ /** 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 */
1860
+ dataStore?: string;
1861
+ /** 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. */
1862
+ filterGroups?: string[];
1863
+ }
1864
+ interface GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest {
1865
+ /** 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. */
1866
+ dataStore?: string;
1867
+ /** 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. */
1868
+ filterGroups?: string[];
1869
+ }
1812
1870
  interface GoogleCloudDiscoveryengineV1alphaSafetyRating {
1813
1871
  /** Output only. Indicates whether the content was filtered out because of this rating. */
1814
1872
  blocked?: boolean;
@@ -2373,6 +2431,8 @@ declare namespace gapi.client {
2373
2431
  interface GoogleCloudDiscoveryengineV1Assistant {
2374
2432
  /** Optional. Customer policy for the assistant. */
2375
2433
  customerPolicy?: GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
2434
+ /** 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. */
2435
+ defaultWebGroundingToggleOff?: boolean;
2376
2436
  /** Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. */
2377
2437
  description?: string;
2378
2438
  /** Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. */
@@ -3055,6 +3115,8 @@ declare namespace gapi.client {
3055
3115
  interface GoogleCloudDiscoveryengineV1betaAssistant {
3056
3116
  /** Optional. Customer policy for the assistant. */
3057
3117
  customerPolicy?: GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy;
3118
+ /** 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. */
3119
+ defaultWebGroundingToggleOff?: boolean;
3058
3120
  /** Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. */
3059
3121
  description?: string;
3060
3122
  /** Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. */
@@ -4002,6 +4064,8 @@ declare namespace gapi.client {
4002
4064
  features?: {[P in string]: string};
4003
4065
  /** 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. */
4004
4066
  industryVertical?: string;
4067
+ /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
4068
+ knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
4005
4069
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
4006
4070
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
4007
4071
  /** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
@@ -4041,6 +4105,28 @@ declare namespace gapi.client {
4041
4105
  /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
4042
4106
  companyName?: string;
4043
4107
  }
4108
+ interface GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig {
4109
+ /** Specify entity types to support. */
4110
+ cloudKnowledgeGraphTypes?: string[];
4111
+ /** Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. */
4112
+ enableCloudKnowledgeGraph?: boolean;
4113
+ /** Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. */
4114
+ enablePrivateKnowledgeGraph?: boolean;
4115
+ /** Optional. Feature config for the Knowledge Graph. */
4116
+ featureConfig?: GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig;
4117
+ /** Specify entity types to support. */
4118
+ privateKnowledgeGraphTypes?: string[];
4119
+ }
4120
+ interface GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfigFeatureConfig {
4121
+ /** Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. */
4122
+ disablePrivateKgAutoComplete?: boolean;
4123
+ /** Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. */
4124
+ disablePrivateKgEnrichment?: boolean;
4125
+ /** Whether to disable the private KG for query UI chips. Defaults to false if not specified. */
4126
+ disablePrivateKgQueryUiChips?: boolean;
4127
+ /** Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. */
4128
+ disablePrivateKgQueryUnderstanding?: boolean;
4129
+ }
4044
4130
  interface GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig {
4045
4131
  /** Optional. Additional engine features config. */
4046
4132
  engineFeaturesConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfigEngineFeaturesConfig;
@@ -4178,6 +4264,8 @@ declare namespace gapi.client {
4178
4264
  enableConfigurableSchema?: boolean;
4179
4265
  /** 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. */
4180
4266
  enableStaticIndexingForBatchIngestion?: boolean;
4267
+ /** 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. */
4268
+ initialFilterGroups?: string[];
4181
4269
  }
4182
4270
  interface GoogleCloudDiscoveryengineV1betaIdentityMappingEntry {
4183
4271
  /** Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters. */
@@ -6459,6 +6547,8 @@ declare namespace gapi.client {
6459
6547
  features?: {[P in string]: string};
6460
6548
  /** 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. */
6461
6549
  industryVertical?: string;
6550
+ /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
6551
+ knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
6462
6552
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
6463
6553
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
6464
6554
  /** Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. */
@@ -6498,6 +6588,28 @@ declare namespace gapi.client {
6498
6588
  /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
6499
6589
  companyName?: string;
6500
6590
  }
6591
+ interface GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig {
6592
+ /** Specify entity types to support. */
6593
+ cloudKnowledgeGraphTypes?: string[];
6594
+ /** Whether to enable the Cloud Knowledge Graph for the engine. Defaults to false if not specified. */
6595
+ enableCloudKnowledgeGraph?: boolean;
6596
+ /** Whether to enable the Private Knowledge Graph for the engine. Defaults to false if not specified. */
6597
+ enablePrivateKnowledgeGraph?: boolean;
6598
+ /** Optional. Feature config for the Knowledge Graph. */
6599
+ featureConfig?: GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig;
6600
+ /** Specify entity types to support. */
6601
+ privateKnowledgeGraphTypes?: string[];
6602
+ }
6603
+ interface GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfigFeatureConfig {
6604
+ /** Whether to disable the private KG auto complete for the engine. Defaults to false if not specified. */
6605
+ disablePrivateKgAutoComplete?: boolean;
6606
+ /** Whether to disable the private KG enrichment for the engine. Defaults to false if not specified. */
6607
+ disablePrivateKgEnrichment?: boolean;
6608
+ /** Whether to disable the private KG for query UI chips. Defaults to false if not specified. */
6609
+ disablePrivateKgQueryUiChips?: boolean;
6610
+ /** Whether to disable the private KG query understanding for the engine. Defaults to false if not specified. */
6611
+ disablePrivateKgQueryUnderstanding?: boolean;
6612
+ }
6501
6613
  interface GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig {
6502
6614
  /** Optional. Additional engine features config. */
6503
6615
  engineFeaturesConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig;
@@ -6543,6 +6655,8 @@ declare namespace gapi.client {
6543
6655
  enableConfigurableSchema?: boolean;
6544
6656
  /** 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. */
6545
6657
  enableStaticIndexingForBatchIngestion?: boolean;
6658
+ /** 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. */
6659
+ initialFilterGroups?: string[];
6546
6660
  }
6547
6661
  interface GoogleCloudDiscoveryengineV1IdentityMappingEntryOperationMetadata {
6548
6662
  /** The number of IdentityMappingEntries that failed to be processed. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.1.20251221",
3
+ "version": "0.1.20260112",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",