@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.1.20260215 → 0.1.20260301

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 +192 -12
  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: 20260215
12
+ // Revision: 20260301
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -191,9 +191,17 @@ declare namespace gapi.client {
191
191
  jsonActionParams?: string;
192
192
  /** Optional. The Service Directory resource name (projects/*‍/locations/*‍/namespaces/*‍/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. */
193
193
  serviceName?: string;
194
+ /** Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. */
195
+ userDefinedScopesMapping?: {
196
+ [P in string]: GoogleCloudDiscoveryengineV1ActionConfigScopeList;
197
+ };
194
198
  /** Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. */
195
199
  useStaticSecrets?: boolean;
196
200
  }
201
+ interface GoogleCloudDiscoveryengineV1ActionConfigScopeList {
202
+ /** Optional. The list of scopes. */
203
+ scopes?: string[];
204
+ }
197
205
  interface GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {
198
206
  /** If set true, automatic refresh is disabled for the DataStore. */
199
207
  disableAutomaticRefresh?: boolean;
@@ -227,9 +235,17 @@ declare namespace gapi.client {
227
235
  jsonActionParams?: string;
228
236
  /** Optional. The Service Directory resource name (projects/*‍/locations/*‍/namespaces/*‍/services/*) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled. */
229
237
  serviceName?: string;
238
+ /** Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. */
239
+ userDefinedScopesMapping?: {
240
+ [P in string]: GoogleCloudDiscoveryengineV1alphaActionConfigScopeList;
241
+ };
230
242
  /** Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. */
231
243
  useStaticSecrets?: boolean;
232
244
  }
245
+ interface GoogleCloudDiscoveryengineV1alphaActionConfigScopeList {
246
+ /** Optional. The list of scopes. */
247
+ scopes?: string[];
248
+ }
233
249
  interface GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
234
250
  /** 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
251
  dataStore?: string;
@@ -355,6 +371,8 @@ declare namespace gapi.client {
355
371
  interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
356
372
  /** Chunk information. */
357
373
  chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
374
+ /** Output only. The search queries that produced this reference. */
375
+ queries?: string[];
358
376
  /** Structured document information. */
359
377
  structuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
360
378
  /** Unstructured document information. */
@@ -886,10 +904,12 @@ declare namespace gapi.client {
886
904
  createTime?: string;
887
905
  /** Optional. Specifies the data protection policy for the connector. */
888
906
  dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
889
- /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
907
+ /** Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` */
890
908
  dataSource?: string;
891
909
  /** Optional. Any target destinations used to connect to third-party services. */
892
910
  destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
911
+ /** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. Note: This field is derived from both the DataConnector.params, and connector source spec. It should only be used for CAIS and Org Policy evaluation purposes. */
912
+ egressFqdns?: string[];
893
913
  /** Optional. Any params and credentials used specifically for EUA connectors. */
894
914
  endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
895
915
  /** List of entities from the connected data source to ingest. */
@@ -942,6 +962,8 @@ declare namespace gapi.client {
942
962
  syncMode?: string;
943
963
  /** Output only. Timestamp the DataConnector was last updated. */
944
964
  updateTime?: string;
965
+ /** Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose. */
966
+ vpcscEnabled?: boolean;
945
967
  }
946
968
  interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
947
969
  /** Optional. Any additional parameters needed for EUA. */
@@ -1022,6 +1044,8 @@ declare namespace gapi.client {
1022
1044
  displayName?: string;
1023
1045
  /** Configuration for Document understanding and enrichment. */
1024
1046
  documentProcessingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
1047
+ /** Optional. If set, this DataStore is a federated search DataStore. */
1048
+ federatedSearchConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig;
1025
1049
  /** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
1026
1050
  healthcareFhirConfig?: GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
1027
1051
  /** Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. */
@@ -1063,6 +1087,50 @@ declare namespace gapi.client {
1063
1087
  /** Last updated timestamp for websites. */
1064
1088
  websiteDataUpdateTime?: string;
1065
1089
  }
1090
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig {
1091
+ /** AlloyDB config. If set, this DataStore is connected to AlloyDB. */
1092
+ alloyDbConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig;
1093
+ /** NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. */
1094
+ notebooklmConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig;
1095
+ /** Third Party OAuth config. If set, this DataStore is connected to a third party application. */
1096
+ thirdPartyOauthConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig;
1097
+ }
1098
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig {
1099
+ /** Optional. Configuration for Magic. */
1100
+ alloydbAiNlConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig;
1101
+ /** Required. Configuration for connecting to AlloyDB. */
1102
+ alloydbConnectionConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig;
1103
+ /** Optional. Fields to be returned in the search results. If empty, all fields will be returned. */
1104
+ returnedFields?: string[];
1105
+ }
1106
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig {
1107
+ /** Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. */
1108
+ nlConfigId?: string;
1109
+ }
1110
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig {
1111
+ /** Optional. Auth mode. */
1112
+ authMode?: string;
1113
+ /** Required. The AlloyDB database to connect to. */
1114
+ database?: string;
1115
+ /** Optional. If true, enable PSVS for AlloyDB. */
1116
+ enablePsvs?: boolean;
1117
+ /** Required. The AlloyDB instance to connect to. */
1118
+ instance?: string;
1119
+ /** Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. */
1120
+ password?: string;
1121
+ /** Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. */
1122
+ user?: string;
1123
+ }
1124
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig {
1125
+ /** Required. Search config name. Format: projects/*‍/locations/global/notebookLmSearchConfigs/* */
1126
+ searchConfig?: string;
1127
+ }
1128
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig {
1129
+ /** Optional. The type of the application. E.g., "jira", "box", etc. */
1130
+ appName?: string;
1131
+ /** Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". */
1132
+ instanceName?: string;
1133
+ }
1066
1134
  interface GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore {
1067
1135
  /** Optional. If set true, the DataStore will not be available for serving search requests. */
1068
1136
  disabledForServing?: boolean;
@@ -1259,6 +1327,8 @@ declare namespace gapi.client {
1259
1327
  industryVertical?: string;
1260
1328
  /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
1261
1329
  knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
1330
+ /** Optional. The visibility of marketplace agents in the agent gallery. */
1331
+ marketplaceAgentVisibility?: string;
1262
1332
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
1263
1333
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
1264
1334
  /** 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. */
@@ -1267,6 +1337,8 @@ declare namespace gapi.client {
1267
1337
  name?: string;
1268
1338
  /** Optional. Observability config for the engine. */
1269
1339
  observabilityConfig?: GoogleCloudDiscoveryengineV1alphaObservabilityConfig;
1340
+ /** Optional. The email of the procurement contact. */
1341
+ procurementContactEmail?: string;
1270
1342
  /** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
1271
1343
  recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
1272
1344
  /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
@@ -1635,7 +1707,7 @@ declare namespace gapi.client {
1635
1707
  subscriptionTier?: string;
1636
1708
  }
1637
1709
  interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
1638
- /** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` */
1710
+ /** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
1639
1711
  filter?: string;
1640
1712
  /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. */
1641
1713
  orderBy?: string;
@@ -2080,7 +2152,7 @@ declare namespace gapi.client {
2080
2152
  searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec;
2081
2153
  /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
2082
2154
  servingConfig?: string;
2083
- /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
2155
+ /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. */
2084
2156
  session?: string;
2085
2157
  /** Session specification. Can be used only when `session` is set. */
2086
2158
  sessionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec;
@@ -2485,7 +2557,7 @@ declare namespace gapi.client {
2485
2557
  timeZone?: string;
2486
2558
  /** User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. */
2487
2559
  userAgent?: string;
2488
- /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2560
+ /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. */
2489
2561
  userId?: string;
2490
2562
  }
2491
2563
  interface GoogleCloudDiscoveryengineV1alphaUserLicense {
@@ -3069,6 +3141,8 @@ declare namespace gapi.client {
3069
3141
  interface GoogleCloudDiscoveryengineV1betaAnswerReference {
3070
3142
  /** Chunk information. */
3071
3143
  chunkInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo;
3144
+ /** Output only. The search queries that produced this reference. */
3145
+ queries?: string[];
3072
3146
  /** Structured document information. */
3073
3147
  structuredDocumentInfo?: GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo;
3074
3148
  /** Unstructured document information. */
@@ -3913,6 +3987,8 @@ declare namespace gapi.client {
3913
3987
  displayName?: string;
3914
3988
  /** Configuration for Document understanding and enrichment. */
3915
3989
  documentProcessingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
3990
+ /** Optional. If set, this DataStore is a federated search DataStore. */
3991
+ federatedSearchConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig;
3916
3992
  /** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
3917
3993
  healthcareFhirConfig?: GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig;
3918
3994
  /** Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. */
@@ -3952,6 +4028,50 @@ declare namespace gapi.client {
3952
4028
  /** Last updated timestamp for websites. */
3953
4029
  websiteDataUpdateTime?: string;
3954
4030
  }
4031
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig {
4032
+ /** AlloyDB config. If set, this DataStore is connected to AlloyDB. */
4033
+ alloyDbConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig;
4034
+ /** NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. */
4035
+ notebooklmConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig;
4036
+ /** Third Party OAuth config. If set, this DataStore is connected to a third party application. */
4037
+ thirdPartyOauthConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig;
4038
+ }
4039
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig {
4040
+ /** Optional. Configuration for Magic. */
4041
+ alloydbAiNlConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig;
4042
+ /** Required. Configuration for connecting to AlloyDB. */
4043
+ alloydbConnectionConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig;
4044
+ /** Optional. Fields to be returned in the search results. If empty, all fields will be returned. */
4045
+ returnedFields?: string[];
4046
+ }
4047
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig {
4048
+ /** Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. */
4049
+ nlConfigId?: string;
4050
+ }
4051
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig {
4052
+ /** Optional. Auth mode. */
4053
+ authMode?: string;
4054
+ /** Required. The AlloyDB database to connect to. */
4055
+ database?: string;
4056
+ /** Optional. If true, enable PSVS for AlloyDB. */
4057
+ enablePsvs?: boolean;
4058
+ /** Required. The AlloyDB instance to connect to. */
4059
+ instance?: string;
4060
+ /** Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. */
4061
+ password?: string;
4062
+ /** Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. */
4063
+ user?: string;
4064
+ }
4065
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig {
4066
+ /** Required. Search config name. Format: projects/*‍/locations/global/notebookLmSearchConfigs/* */
4067
+ searchConfig?: string;
4068
+ }
4069
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig {
4070
+ /** Optional. The type of the application. E.g., "jira", "box", etc. */
4071
+ appName?: string;
4072
+ /** Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". */
4073
+ instanceName?: string;
4074
+ }
3955
4075
  interface GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore {
3956
4076
  /** Optional. If set true, the DataStore will not be available for serving search requests. */
3957
4077
  disabledForServing?: boolean;
@@ -4176,6 +4296,8 @@ declare namespace gapi.client {
4176
4296
  industryVertical?: string;
4177
4297
  /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
4178
4298
  knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
4299
+ /** Optional. The visibility of marketplace agents in the agent gallery. */
4300
+ marketplaceAgentVisibility?: string;
4179
4301
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
4180
4302
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
4181
4303
  /** 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. */
@@ -4184,6 +4306,8 @@ declare namespace gapi.client {
4184
4306
  name?: string;
4185
4307
  /** Optional. Observability config for the engine. */
4186
4308
  observabilityConfig?: GoogleCloudDiscoveryengineV1betaObservabilityConfig;
4309
+ /** Optional. The email of the procurement contact. */
4310
+ procurementContactEmail?: string;
4187
4311
  /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
4188
4312
  searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
4189
4313
  /** Required. The solutions of the engine. */
@@ -5288,7 +5412,7 @@ declare namespace gapi.client {
5288
5412
  searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec;
5289
5413
  /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
5290
5414
  servingConfig?: string;
5291
- /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
5415
+ /** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. */
5292
5416
  session?: string;
5293
5417
  /** Session specification. Can be used only when `session` is set. */
5294
5418
  sessionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec;
@@ -6118,6 +6242,8 @@ declare namespace gapi.client {
6118
6242
  documents?: GoogleCloudDiscoveryengineV1betaDocumentInfo[];
6119
6243
  /** The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search. */
6120
6244
  engine?: string;
6245
+ /** Optional. Represents the entity for customers that may run multiple different entities, domains, sites or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that you set `entity` to get better per-entity search, completion, and prediction results. */
6246
+ entity?: string;
6121
6247
  /** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
6122
6248
  eventTime?: string;
6123
6249
  /** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. */
@@ -6152,7 +6278,7 @@ declare namespace gapi.client {
6152
6278
  timeZone?: string;
6153
6279
  /** User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set. */
6154
6280
  userAgent?: string;
6155
- /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
6281
+ /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded. */
6156
6282
  userId?: string;
6157
6283
  }
6158
6284
  interface GoogleCloudDiscoveryengineV1betaUserLicense {
@@ -6364,10 +6490,12 @@ declare namespace gapi.client {
6364
6490
  createEuaSaas?: boolean;
6365
6491
  /** Output only. Timestamp the DataConnector was created at. */
6366
6492
  createTime?: string;
6367
- /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
6493
+ /** Required. The identifier for the data source. This is a partial list of supported connectors. Please refer to the [documentation](https://docs.cloud.google.com/gemini/enterprise/docs/connectors/introduction-to-connectors-and-data-stores) for the full list of connectors. Supported first-party connectors include: * `gcs` * `bigquery` * `gcp_fhir` * `google_mail` * `google_drive` * `google_calendar` * `google_chat` Supported third-party connectors include: Generally available (GA) connectors: * `onedrive` * `outlook` * `confluence` * `jira` * `servicenow` * `sharepoint` Preview connectors: * `asana` * `azure_active_directory` * `box` * `canva` * `confluence_server` * `custom_connector` * `docusign` * `dropbox` * `dynamics365` * `github` * `gitlab` * `hubspot` * `jira_server` * `linear` * `native_cloud_identity` * `notion` * `okta` * `pagerduty` * `peoplesoft` * `salesforce` * `shopify` * `slack` * `snowflake` * `teams` * `trello` * `workday` * `zendesk` */
6368
6494
  dataSource?: string;
6369
6495
  /** Optional. Any target destinations used to connect to third-party services. */
6370
6496
  destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
6497
+ /** Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. Note: This field is derived from both the DataConnector.params, and connector source spec. It should only be used for CAIS and Org Policy evaluation purposes. */
6498
+ egressFqdns?: string[];
6371
6499
  /** Optional. Any params and credentials used specifically for EUA connectors. */
6372
6500
  endUserConfig?: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
6373
6501
  /** List of entities from the connected data source to ingest. */
@@ -6420,6 +6548,8 @@ declare namespace gapi.client {
6420
6548
  syncMode?: string;
6421
6549
  /** Output only. Timestamp the DataConnector was last updated. */
6422
6550
  updateTime?: string;
6551
+ /** Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose. */
6552
+ vpcscEnabled?: boolean;
6423
6553
  }
6424
6554
  interface GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
6425
6555
  /** Optional. Any additional parameters needed for EUA. */
@@ -6492,6 +6622,8 @@ declare namespace gapi.client {
6492
6622
  displayName?: string;
6493
6623
  /** Configuration for Document understanding and enrichment. */
6494
6624
  documentProcessingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
6625
+ /** Optional. If set, this DataStore is a federated search DataStore. */
6626
+ federatedSearchConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig;
6495
6627
  /** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
6496
6628
  healthcareFhirConfig?: GoogleCloudDiscoveryengineV1HealthcareFhirConfig;
6497
6629
  /** Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. */
@@ -6529,6 +6661,50 @@ declare namespace gapi.client {
6529
6661
  /** Last updated timestamp for websites. */
6530
6662
  websiteDataUpdateTime?: string;
6531
6663
  }
6664
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig {
6665
+ /** AlloyDB config. If set, this DataStore is connected to AlloyDB. */
6666
+ alloyDbConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig;
6667
+ /** NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. */
6668
+ notebooklmConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig;
6669
+ /** Third Party OAuth config. If set, this DataStore is connected to a third party application. */
6670
+ thirdPartyOauthConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig;
6671
+ }
6672
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig {
6673
+ /** Optional. Configuration for Magic. */
6674
+ alloydbAiNlConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig;
6675
+ /** Required. Configuration for connecting to AlloyDB. */
6676
+ alloydbConnectionConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig;
6677
+ /** Optional. Fields to be returned in the search results. If empty, all fields will be returned. */
6678
+ returnedFields?: string[];
6679
+ }
6680
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig {
6681
+ /** Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. */
6682
+ nlConfigId?: string;
6683
+ }
6684
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig {
6685
+ /** Optional. Auth mode. */
6686
+ authMode?: string;
6687
+ /** Required. The AlloyDB database to connect to. */
6688
+ database?: string;
6689
+ /** Optional. If true, enable PSVS for AlloyDB. */
6690
+ enablePsvs?: boolean;
6691
+ /** Required. The AlloyDB instance to connect to. */
6692
+ instance?: string;
6693
+ /** Required. Database password. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the password will be inferred on the AlloyDB side, based on the authenticated user. */
6694
+ password?: string;
6695
+ /** Required. Database user. If auth_mode = END_USER_ACCOUNT, it can be unset. In that case, the user will be inferred on the AlloyDB side, based on the authenticated user. */
6696
+ user?: string;
6697
+ }
6698
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig {
6699
+ /** Required. Search config name. Format: projects/*‍/locations/global/notebookLmSearchConfigs/* */
6700
+ searchConfig?: string;
6701
+ }
6702
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig {
6703
+ /** Optional. The type of the application. E.g., "jira", "box", etc. */
6704
+ appName?: string;
6705
+ /** Optional. The instance name identifying the 3P app, e.g., "vaissptbots-my". This is different from the instance_uri which is the full URL of the 3P app e.g., "https://vaissptbots-my.sharepoint.com". */
6706
+ instanceName?: string;
6707
+ }
6532
6708
  interface GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore {
6533
6709
  /** Optional. If set true, the DataStore will not be available for serving search requests. */
6534
6710
  disabledForServing?: boolean;
@@ -6695,6 +6871,8 @@ declare namespace gapi.client {
6695
6871
  industryVertical?: string;
6696
6872
  /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
6697
6873
  knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
6874
+ /** Optional. The visibility of marketplace agents in the agent gallery. */
6875
+ marketplaceAgentVisibility?: string;
6698
6876
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
6699
6877
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
6700
6878
  /** 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. */
@@ -6703,6 +6881,8 @@ declare namespace gapi.client {
6703
6881
  name?: string;
6704
6882
  /** Optional. Observability config for the engine. */
6705
6883
  observabilityConfig?: GoogleCloudDiscoveryengineV1ObservabilityConfig;
6884
+ /** Optional. The email of the procurement contact. */
6885
+ procurementContactEmail?: string;
6706
6886
  /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
6707
6887
  searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
6708
6888
  /** Required. The solutions of the engine. */
@@ -9923,7 +10103,7 @@ declare namespace gapi.client {
9923
10103
  callback?: string;
9924
10104
  /** Selector specifying which fields to include in a partial response. */
9925
10105
  fields?: string;
9926
- /** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` */
10106
+ /** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
9927
10107
  filter?: string;
9928
10108
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
9929
10109
  key?: string;
@@ -13101,7 +13281,7 @@ declare namespace gapi.client {
13101
13281
  callback?: string;
13102
13282
  /** Selector specifying which fields to include in a partial response. */
13103
13283
  fields?: string;
13104
- /** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` */
13284
+ /** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
13105
13285
  filter?: string;
13106
13286
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
13107
13287
  key?: string;
@@ -15858,7 +16038,7 @@ declare namespace gapi.client {
15858
16038
  callback?: string;
15859
16039
  /** Selector specifying which fields to include in a partial response. */
15860
16040
  fields?: string;
15861
- /** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` */
16041
+ /** A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` */
15862
16042
  filter?: string;
15863
16043
  /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
15864
16044
  key?: string;
@@ -17744,7 +17924,7 @@ declare namespace gapi.client {
17744
17924
  operations: OperationsResource;
17745
17925
  }
17746
17926
  interface LicenseConfigsResource {
17747
- /** Creates a LicenseConfig */
17927
+ /** Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses. */
17748
17928
  create(request: {
17749
17929
  /** V1 error format. */
17750
17930
  '$.xgafv'?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.1.20260215",
3
+ "version": "0.1.20260301",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",