@maxim_mazurok/gapi.client.discoveryengine-v1alpha 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 +190 -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=v1alpha
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;
@@ -246,9 +254,17 @@ declare namespace gapi.client {
246
254
  jsonActionParams?: string;
247
255
  /** 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. */
248
256
  serviceName?: string;
257
+ /** Optional. Mapping from operation name to the list of scopes. Only be populated if there are user specified scopes. */
258
+ userDefinedScopesMapping?: {
259
+ [P in string]: GoogleCloudDiscoveryengineV1alphaActionConfigScopeList;
260
+ };
249
261
  /** Optional. Whether to use static secrets for the connector. If true, the secrets provided in the action_params will be ignored. */
250
262
  useStaticSecrets?: boolean;
251
263
  }
264
+ interface GoogleCloudDiscoveryengineV1alphaActionConfigScopeList {
265
+ /** Optional. The list of scopes. */
266
+ scopes?: string[];
267
+ }
252
268
  interface GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest {
253
269
  /** 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. */
254
270
  dataStore?: string;
@@ -794,6 +810,8 @@ declare namespace gapi.client {
794
810
  interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
795
811
  /** Chunk information. */
796
812
  chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
813
+ /** Output only. The search queries that produced this reference. */
814
+ queries?: string[];
797
815
  /** Structured document information. */
798
816
  structuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
799
817
  /** Unstructured document information. */
@@ -1878,10 +1896,12 @@ declare namespace gapi.client {
1878
1896
  createTime?: string;
1879
1897
  /** Optional. Specifies the data protection policy for the connector. */
1880
1898
  dataProtectionPolicy?: GoogleCloudDiscoveryengineV1alphaDataProtectionPolicy;
1881
- /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
1899
+ /** 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` */
1882
1900
  dataSource?: string;
1883
1901
  /** Optional. Any target destinations used to connect to third-party services. */
1884
1902
  destinationConfigs?: GoogleCloudDiscoveryengineV1alphaDestinationConfig[];
1903
+ /** 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. */
1904
+ egressFqdns?: string[];
1885
1905
  /** Optional. Any params and credentials used specifically for EUA connectors. */
1886
1906
  endUserConfig?: GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig;
1887
1907
  /** List of entities from the connected data source to ingest. */
@@ -1934,6 +1954,8 @@ declare namespace gapi.client {
1934
1954
  syncMode?: string;
1935
1955
  /** Output only. Timestamp the DataConnector was last updated. */
1936
1956
  updateTime?: string;
1957
+ /** Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose. */
1958
+ vpcscEnabled?: boolean;
1937
1959
  }
1938
1960
  interface GoogleCloudDiscoveryengineV1alphaDataConnectorEndUserConfig {
1939
1961
  /** Optional. Any additional parameters needed for EUA. */
@@ -2014,6 +2036,8 @@ declare namespace gapi.client {
2014
2036
  displayName?: string;
2015
2037
  /** Configuration for Document understanding and enrichment. */
2016
2038
  documentProcessingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig;
2039
+ /** Optional. If set, this DataStore is a federated search DataStore. */
2040
+ federatedSearchConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig;
2017
2041
  /** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
2018
2042
  healthcareFhirConfig?: GoogleCloudDiscoveryengineV1alphaHealthcareFhirConfig;
2019
2043
  /** 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}`. */
@@ -2055,6 +2079,50 @@ declare namespace gapi.client {
2055
2079
  /** Last updated timestamp for websites. */
2056
2080
  websiteDataUpdateTime?: string;
2057
2081
  }
2082
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfig {
2083
+ /** AlloyDB config. If set, this DataStore is connected to AlloyDB. */
2084
+ alloyDbConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig;
2085
+ /** NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. */
2086
+ notebooklmConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig;
2087
+ /** Third Party OAuth config. If set, this DataStore is connected to a third party application. */
2088
+ thirdPartyOauthConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig;
2089
+ }
2090
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfig {
2091
+ /** Optional. Configuration for Magic. */
2092
+ alloydbAiNlConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig;
2093
+ /** Required. Configuration for connecting to AlloyDB. */
2094
+ alloydbConnectionConfig?: GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig;
2095
+ /** Optional. Fields to be returned in the search results. If empty, all fields will be returned. */
2096
+ returnedFields?: string[];
2097
+ }
2098
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig {
2099
+ /** 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. */
2100
+ nlConfigId?: string;
2101
+ }
2102
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig {
2103
+ /** Optional. Auth mode. */
2104
+ authMode?: string;
2105
+ /** Required. The AlloyDB database to connect to. */
2106
+ database?: string;
2107
+ /** Optional. If true, enable PSVS for AlloyDB. */
2108
+ enablePsvs?: boolean;
2109
+ /** Required. The AlloyDB instance to connect to. */
2110
+ instance?: string;
2111
+ /** 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. */
2112
+ password?: string;
2113
+ /** 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. */
2114
+ user?: string;
2115
+ }
2116
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigNotebooklmConfig {
2117
+ /** Required. Search config name. Format: projects/*‍/locations/global/notebookLmSearchConfigs/* */
2118
+ searchConfig?: string;
2119
+ }
2120
+ interface GoogleCloudDiscoveryengineV1alphaDataStoreFederatedSearchConfigThirdPartyOauthConfig {
2121
+ /** Optional. The type of the application. E.g., "jira", "box", etc. */
2122
+ appName?: string;
2123
+ /** 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". */
2124
+ instanceName?: string;
2125
+ }
2058
2126
  interface GoogleCloudDiscoveryengineV1alphaDataStoreServingConfigDataStore {
2059
2127
  /** Optional. If set true, the DataStore will not be available for serving search requests. */
2060
2128
  disabledForServing?: boolean;
@@ -2345,6 +2413,8 @@ declare namespace gapi.client {
2345
2413
  industryVertical?: string;
2346
2414
  /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
2347
2415
  knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig;
2416
+ /** Optional. The visibility of marketplace agents in the agent gallery. */
2417
+ marketplaceAgentVisibility?: string;
2348
2418
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
2349
2419
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
2350
2420
  /** 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. */
@@ -2353,6 +2423,8 @@ declare namespace gapi.client {
2353
2423
  name?: string;
2354
2424
  /** Optional. Observability config for the engine. */
2355
2425
  observabilityConfig?: GoogleCloudDiscoveryengineV1alphaObservabilityConfig;
2426
+ /** Optional. The email of the procurement contact. */
2427
+ procurementContactEmail?: string;
2356
2428
  /** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
2357
2429
  recommendationMetadata?: GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
2358
2430
  /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
@@ -3198,7 +3270,7 @@ declare namespace gapi.client {
3198
3270
  servingConfigs?: GoogleCloudDiscoveryengineV1alphaServingConfig[];
3199
3271
  }
3200
3272
  interface GoogleCloudDiscoveryengineV1alphaListSessionsRequest {
3201
- /** 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"` */
3273
+ /** 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"` */
3202
3274
  filter?: string;
3203
3275
  /** 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. */
3204
3276
  orderBy?: string;
@@ -4001,7 +4073,7 @@ declare namespace gapi.client {
4001
4073
  searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec;
4002
4074
  /** 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. */
4003
4075
  servingConfig?: string;
4004
- /** 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. */
4076
+ /** 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. */
4005
4077
  session?: string;
4006
4078
  /** Session specification. Can be used only when `session` is set. */
4007
4079
  sessionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec;
@@ -4907,6 +4979,8 @@ declare namespace gapi.client {
4907
4979
  documents?: GoogleCloudDiscoveryengineV1alphaDocumentInfo[];
4908
4980
  /** 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. */
4909
4981
  engine?: string;
4982
+ /** 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. */
4983
+ entity?: string;
4910
4984
  /** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
4911
4985
  eventTime?: string;
4912
4986
  /** 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. */
@@ -4941,7 +5015,7 @@ declare namespace gapi.client {
4941
5015
  timeZone?: string;
4942
5016
  /** 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. */
4943
5017
  userAgent?: string;
4944
- /** 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. */
5018
+ /** 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. */
4945
5019
  userId?: string;
4946
5020
  }
4947
5021
  interface GoogleCloudDiscoveryengineV1alphaUserLicense {
@@ -5590,6 +5664,8 @@ declare namespace gapi.client {
5590
5664
  displayName?: string;
5591
5665
  /** Configuration for Document understanding and enrichment. */
5592
5666
  documentProcessingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig;
5667
+ /** Optional. If set, this DataStore is a federated search DataStore. */
5668
+ federatedSearchConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig;
5593
5669
  /** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
5594
5670
  healthcareFhirConfig?: GoogleCloudDiscoveryengineV1betaHealthcareFhirConfig;
5595
5671
  /** 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}`. */
@@ -5629,6 +5705,50 @@ declare namespace gapi.client {
5629
5705
  /** Last updated timestamp for websites. */
5630
5706
  websiteDataUpdateTime?: string;
5631
5707
  }
5708
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfig {
5709
+ /** AlloyDB config. If set, this DataStore is connected to AlloyDB. */
5710
+ alloyDbConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig;
5711
+ /** NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. */
5712
+ notebooklmConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig;
5713
+ /** Third Party OAuth config. If set, this DataStore is connected to a third party application. */
5714
+ thirdPartyOauthConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig;
5715
+ }
5716
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfig {
5717
+ /** Optional. Configuration for Magic. */
5718
+ alloydbAiNlConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig;
5719
+ /** Required. Configuration for connecting to AlloyDB. */
5720
+ alloydbConnectionConfig?: GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig;
5721
+ /** Optional. Fields to be returned in the search results. If empty, all fields will be returned. */
5722
+ returnedFields?: string[];
5723
+ }
5724
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig {
5725
+ /** 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. */
5726
+ nlConfigId?: string;
5727
+ }
5728
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig {
5729
+ /** Optional. Auth mode. */
5730
+ authMode?: string;
5731
+ /** Required. The AlloyDB database to connect to. */
5732
+ database?: string;
5733
+ /** Optional. If true, enable PSVS for AlloyDB. */
5734
+ enablePsvs?: boolean;
5735
+ /** Required. The AlloyDB instance to connect to. */
5736
+ instance?: string;
5737
+ /** 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. */
5738
+ password?: string;
5739
+ /** 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. */
5740
+ user?: string;
5741
+ }
5742
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigNotebooklmConfig {
5743
+ /** Required. Search config name. Format: projects/*‍/locations/global/notebookLmSearchConfigs/* */
5744
+ searchConfig?: string;
5745
+ }
5746
+ interface GoogleCloudDiscoveryengineV1betaDataStoreFederatedSearchConfigThirdPartyOauthConfig {
5747
+ /** Optional. The type of the application. E.g., "jira", "box", etc. */
5748
+ appName?: string;
5749
+ /** 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". */
5750
+ instanceName?: string;
5751
+ }
5632
5752
  interface GoogleCloudDiscoveryengineV1betaDataStoreServingConfigDataStore {
5633
5753
  /** Optional. If set true, the DataStore will not be available for serving search requests. */
5634
5754
  disabledForServing?: boolean;
@@ -5777,6 +5897,8 @@ declare namespace gapi.client {
5777
5897
  industryVertical?: string;
5778
5898
  /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
5779
5899
  knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig;
5900
+ /** Optional. The visibility of marketplace agents in the agent gallery. */
5901
+ marketplaceAgentVisibility?: string;
5780
5902
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
5781
5903
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig;
5782
5904
  /** 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. */
@@ -5785,6 +5907,8 @@ declare namespace gapi.client {
5785
5907
  name?: string;
5786
5908
  /** Optional. Observability config for the engine. */
5787
5909
  observabilityConfig?: GoogleCloudDiscoveryengineV1betaObservabilityConfig;
5910
+ /** Optional. The email of the procurement contact. */
5911
+ procurementContactEmail?: string;
5788
5912
  /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
5789
5913
  searchEngineConfig?: GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig;
5790
5914
  /** Required. The solutions of the engine. */
@@ -6326,7 +6450,7 @@ declare namespace gapi.client {
6326
6450
  searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec;
6327
6451
  /** 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. */
6328
6452
  servingConfig?: string;
6329
- /** 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. */
6453
+ /** 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. */
6330
6454
  session?: string;
6331
6455
  /** Session specification. Can be used only when `session` is set. */
6332
6456
  sessionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec;
@@ -6663,7 +6787,7 @@ declare namespace gapi.client {
6663
6787
  timeZone?: string;
6664
6788
  /** 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. */
6665
6789
  userAgent?: string;
6666
- /** 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. */
6790
+ /** 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. */
6667
6791
  userId?: string;
6668
6792
  }
6669
6793
  interface GoogleCloudDiscoveryengineV1betaUserLicense {
@@ -6875,10 +6999,12 @@ declare namespace gapi.client {
6875
6999
  createEuaSaas?: boolean;
6876
7000
  /** Output only. Timestamp the DataConnector was created at. */
6877
7001
  createTime?: string;
6878
- /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
7002
+ /** 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` */
6879
7003
  dataSource?: string;
6880
7004
  /** Optional. Any target destinations used to connect to third-party services. */
6881
7005
  destinationConfigs?: GoogleCloudDiscoveryengineV1DestinationConfig[];
7006
+ /** 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. */
7007
+ egressFqdns?: string[];
6882
7008
  /** Optional. Any params and credentials used specifically for EUA connectors. */
6883
7009
  endUserConfig?: GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig;
6884
7010
  /** List of entities from the connected data source to ingest. */
@@ -6931,6 +7057,8 @@ declare namespace gapi.client {
6931
7057
  syncMode?: string;
6932
7058
  /** Output only. Timestamp the DataConnector was last updated. */
6933
7059
  updateTime?: string;
7060
+ /** Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose. */
7061
+ vpcscEnabled?: boolean;
6934
7062
  }
6935
7063
  interface GoogleCloudDiscoveryengineV1DataConnectorEndUserConfig {
6936
7064
  /** Optional. Any additional parameters needed for EUA. */
@@ -7003,6 +7131,8 @@ declare namespace gapi.client {
7003
7131
  displayName?: string;
7004
7132
  /** Configuration for Document understanding and enrichment. */
7005
7133
  documentProcessingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfig;
7134
+ /** Optional. If set, this DataStore is a federated search DataStore. */
7135
+ federatedSearchConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig;
7006
7136
  /** Optional. Configuration for `HEALTHCARE_FHIR` vertical. */
7007
7137
  healthcareFhirConfig?: GoogleCloudDiscoveryengineV1HealthcareFhirConfig;
7008
7138
  /** 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}`. */
@@ -7040,6 +7170,50 @@ declare namespace gapi.client {
7040
7170
  /** Last updated timestamp for websites. */
7041
7171
  websiteDataUpdateTime?: string;
7042
7172
  }
7173
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfig {
7174
+ /** AlloyDB config. If set, this DataStore is connected to AlloyDB. */
7175
+ alloyDbConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig;
7176
+ /** NotebookLM config. If set, this DataStore is connected to NotebookLM Enterprise. */
7177
+ notebooklmConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig;
7178
+ /** Third Party OAuth config. If set, this DataStore is connected to a third party application. */
7179
+ thirdPartyOauthConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig;
7180
+ }
7181
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfig {
7182
+ /** Optional. Configuration for Magic. */
7183
+ alloydbAiNlConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig;
7184
+ /** Required. Configuration for connecting to AlloyDB. */
7185
+ alloydbConnectionConfig?: GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig;
7186
+ /** Optional. Fields to be returned in the search results. If empty, all fields will be returned. */
7187
+ returnedFields?: string[];
7188
+ }
7189
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbAiNaturalLanguageConfig {
7190
+ /** 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. */
7191
+ nlConfigId?: string;
7192
+ }
7193
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigAlloyDbConfigAlloyDbConnectionConfig {
7194
+ /** Optional. Auth mode. */
7195
+ authMode?: string;
7196
+ /** Required. The AlloyDB database to connect to. */
7197
+ database?: string;
7198
+ /** Optional. If true, enable PSVS for AlloyDB. */
7199
+ enablePsvs?: boolean;
7200
+ /** Required. The AlloyDB instance to connect to. */
7201
+ instance?: string;
7202
+ /** 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. */
7203
+ password?: string;
7204
+ /** 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. */
7205
+ user?: string;
7206
+ }
7207
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigNotebooklmConfig {
7208
+ /** Required. Search config name. Format: projects/*‍/locations/global/notebookLmSearchConfigs/* */
7209
+ searchConfig?: string;
7210
+ }
7211
+ interface GoogleCloudDiscoveryengineV1DataStoreFederatedSearchConfigThirdPartyOauthConfig {
7212
+ /** Optional. The type of the application. E.g., "jira", "box", etc. */
7213
+ appName?: string;
7214
+ /** 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". */
7215
+ instanceName?: string;
7216
+ }
7043
7217
  interface GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore {
7044
7218
  /** Optional. If set true, the DataStore will not be available for serving search requests. */
7045
7219
  disabledForServing?: boolean;
@@ -7206,6 +7380,8 @@ declare namespace gapi.client {
7206
7380
  industryVertical?: string;
7207
7381
  /** Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
7208
7382
  knowledgeGraphConfig?: GoogleCloudDiscoveryengineV1EngineKnowledgeGraphConfig;
7383
+ /** Optional. The visibility of marketplace agents in the agent gallery. */
7384
+ marketplaceAgentVisibility?: string;
7209
7385
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
7210
7386
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig;
7211
7387
  /** 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. */
@@ -7214,6 +7390,8 @@ declare namespace gapi.client {
7214
7390
  name?: string;
7215
7391
  /** Optional. Observability config for the engine. */
7216
7392
  observabilityConfig?: GoogleCloudDiscoveryengineV1ObservabilityConfig;
7393
+ /** Optional. The email of the procurement contact. */
7394
+ procurementContactEmail?: string;
7217
7395
  /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
7218
7396
  searchEngineConfig?: GoogleCloudDiscoveryengineV1EngineSearchEngineConfig;
7219
7397
  /** Required. The solutions of the engine. */
@@ -11440,7 +11618,7 @@ declare namespace gapi.client {
11440
11618
  callback?: string;
11441
11619
  /** Selector specifying which fields to include in a partial response. */
11442
11620
  fields?: string;
11443
- /** 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"` */
11621
+ /** 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"` */
11444
11622
  filter?: string;
11445
11623
  /** 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. */
11446
11624
  key?: string;
@@ -15849,7 +16027,7 @@ declare namespace gapi.client {
15849
16027
  callback?: string;
15850
16028
  /** Selector specifying which fields to include in a partial response. */
15851
16029
  fields?: string;
15852
- /** 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"` */
16030
+ /** 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"` */
15853
16031
  filter?: string;
15854
16032
  /** 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. */
15855
16033
  key?: string;
@@ -19123,7 +19301,7 @@ declare namespace gapi.client {
19123
19301
  callback?: string;
19124
19302
  /** Selector specifying which fields to include in a partial response. */
19125
19303
  fields?: string;
19126
- /** 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"` */
19304
+ /** 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"` */
19127
19305
  filter?: string;
19128
19306
  /** 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. */
19129
19307
  key?: string;
@@ -21426,7 +21604,7 @@ declare namespace gapi.client {
21426
21604
  operations: OperationsResource;
21427
21605
  }
21428
21606
  interface LicenseConfigsResource {
21429
- /** Creates a LicenseConfig */
21607
+ /** Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses. */
21430
21608
  create(request: {
21431
21609
  /** V1 error format. */
21432
21610
  '$.xgafv'?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.1.20260215",
3
+ "version": "0.1.20260301",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",