@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20250430 → 0.0.20250509

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 +167 -13
  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: 20250430
12
+ // Revision: 20250509
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -996,6 +996,36 @@ declare namespace gapi.client {
996
996
  /** If match by URI, the URI of the Document. */
997
997
  uri?: string;
998
998
  }
999
+ interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata {
1000
+ /** Operation create time. */
1001
+ createTime?: string;
1002
+ /** Count of user licenses that failed to be updated. */
1003
+ failureCount?: string;
1004
+ /** Count of user licenses successfully updated. */
1005
+ successCount?: string;
1006
+ /** Operation last update time. If the operation is done, this is also the finish time. */
1007
+ updateTime?: string;
1008
+ }
1009
+ interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest {
1010
+ /** Optional. If true, if user licenses removed associated license config, the user license will be deleted. By default which is false, the user license will be updated to unassigned state. */
1011
+ deleteUnassignedUserLicenses?: boolean;
1012
+ /** Cloud Storage location for the input content. */
1013
+ gcsSource?: GoogleCloudDiscoveryengineV1alphaGcsSource;
1014
+ /** The inline source for the input content for document embeddings. */
1015
+ inlineSource?: GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource;
1016
+ }
1017
+ interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource {
1018
+ /** Optional. The list of fields to update. */
1019
+ updateMask?: string;
1020
+ /** Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal. */
1021
+ userLicenses?: GoogleCloudDiscoveryengineV1alphaUserLicense[];
1022
+ }
1023
+ interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse {
1024
+ /** A sample of errors encountered while processing the request. */
1025
+ errorSamples?: GoogleRpcStatus[];
1026
+ /** UserLicenses successfully updated. */
1027
+ userLicenses?: GoogleCloudDiscoveryengineV1alphaUserLicense[];
1028
+ }
999
1029
  interface GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest {}
1000
1030
  interface GoogleCloudDiscoveryengineV1alphaBigQuerySource {
1001
1031
  /** The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. */
@@ -1082,7 +1112,7 @@ declare namespace gapi.client {
1082
1112
  endPos?: number;
1083
1113
  /** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices should not be returned. */
1084
1114
  groundingCheckRequired?: boolean;
1085
- /** Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when enable_claim_level_score is true. */
1115
+ /** Confidence score for the claim in the answer candidate, in the range of [0, 1]. This is set only when `CheckGroundingRequest.grounding_spec.enable_claim_level_score` is true. */
1086
1116
  score?: number;
1087
1117
  /** Position indicating the start of the claim in the answer candidate, measured in bytes. Note that this is not measured in characters and, therefore, must be rendered in the user interface keeping in mind that some characters may take more than one byte. For example, if the claim text contains non-ASCII characters, the start and end positions vary when measured in characters (programming-language-dependent) and when measured in bytes (programming-language-independent). */
1088
1118
  startPos?: number;
@@ -1328,7 +1358,7 @@ declare namespace gapi.client {
1328
1358
  filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
1329
1359
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
1330
1360
  name?: string;
1331
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
1361
+ /** Promote certain links based on predefined trigger queries. */
1332
1362
  promoteAction?: GoogleCloudDiscoveryengineV1alphaControlPromoteAction;
1333
1363
  /** Defines a redirect-type control. */
1334
1364
  redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
@@ -1519,7 +1549,7 @@ declare namespace gapi.client {
1519
1549
  actionConfig?: GoogleCloudDiscoveryengineV1alphaActionConfig;
1520
1550
  /** Optional. The connector level alert config. */
1521
1551
  alertPolicyConfigs?: GoogleCloudDiscoveryengineV1alphaAlertPolicyConfig[];
1522
- /** Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. */
1552
+ /** Optional. Indicates whether the connector is disabled for auto run. It can be used to pause periodical and real time sync. Update: with the introduction of incremental_sync_disabled, auto_run_disabled is used to pause/disable only full syncs */
1523
1553
  autoRunDisabled?: boolean;
1524
1554
  /** Optional. The configuration for establishing a BAP connection. */
1525
1555
  bapConfig?: GoogleCloudDiscoveryengineV1alphaBAPConfig;
@@ -1527,8 +1557,10 @@ declare namespace gapi.client {
1527
1557
  blockingReasons?: string[];
1528
1558
  /** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
1529
1559
  connectorModes?: string[];
1530
- /** Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is notmutable once set by system. */
1560
+ /** Output only. The type of connector. Each source can only map to one type. For example, salesforce, confluence and jira have THIRD_PARTY connector type. It is not mutable once set by system. */
1531
1561
  connectorType?: string;
1562
+ /** Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. */
1563
+ createEuaSaas?: boolean;
1532
1564
  /** Output only. Timestamp the DataConnector was created at. */
1533
1565
  createTime?: string;
1534
1566
  /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
@@ -1545,6 +1577,10 @@ declare namespace gapi.client {
1545
1577
  identityRefreshInterval?: string;
1546
1578
  /** The configuration for the identity data synchronization runs. This contains the refresh interval to sync the Access Control List information for the documents ingested by this connector. */
1547
1579
  identityScheduleConfig?: GoogleCloudDiscoveryengineV1alphaIdentityScheduleConfig;
1580
+ /** Optional. The refresh interval specifically for incremental data syncs. If unset, incremental syncs will use the default from env, set to 3hrs. The minimum is 30 minutes and maximum is 7 days. */
1581
+ incrementalRefreshInterval?: string;
1582
+ /** Optional. Indicates whether incremental syncs are paused for this connector. This is independent of auto_run_disabled. */
1583
+ incrementalSyncDisabled?: boolean;
1548
1584
  /** Input only. The KMS key to be used to protect the DataStores managed by this connector. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStores created by this connector will be protected by the KMS key. */
1549
1585
  kmsKeyName?: string;
1550
1586
  /** Output only. For periodic connectors only, the last time a data sync was completed. */
@@ -2566,6 +2602,12 @@ declare namespace gapi.client {
2566
2602
  /** The total number of items matching the request. This will always be populated in the response. */
2567
2603
  totalSize?: number;
2568
2604
  }
2605
+ interface GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse {
2606
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
2607
+ nextPageToken?: string;
2608
+ /** All the customer's UserLicenses. */
2609
+ userLicenses?: GoogleCloudDiscoveryengineV1alphaUserLicense[];
2610
+ }
2569
2611
  interface GoogleCloudDiscoveryengineV1alphaMediaInfo {
2570
2612
  /** The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. */
2571
2613
  mediaProgressDuration?: string;
@@ -3261,6 +3303,8 @@ declare namespace gapi.client {
3261
3303
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
3262
3304
  /** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
3263
3305
  boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
3306
+ /** Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). */
3307
+ customSearchOperators?: string;
3264
3308
  /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
3265
3309
  dataStore?: string;
3266
3310
  /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
@@ -3420,15 +3464,9 @@ declare namespace gapi.client {
3420
3464
  extractedFilters?: string;
3421
3465
  /** Rewritten input query minus the extracted filters. */
3422
3466
  rewrittenQuery?: string;
3423
- /** Optional. The SQL request that was generated from the natural language query understanding phase. */
3424
- sqlRequest?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest;
3425
3467
  /** The filters that were extracted from the input query represented in a structured form. */
3426
3468
  structuredExtractedFilter?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter;
3427
3469
  }
3428
- interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest {
3429
- /** Optional. The SQL query in text format. */
3430
- sqlQuery?: string;
3431
- }
3432
3470
  interface GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter {
3433
3471
  /** The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. */
3434
3472
  expression?: GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression;
@@ -3955,6 +3993,24 @@ declare namespace gapi.client {
3955
3993
  /** 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. */
3956
3994
  userId?: string;
3957
3995
  }
3996
+ interface GoogleCloudDiscoveryengineV1alphaUserLicense {
3997
+ /** Output only. User created timestamp. */
3998
+ createTime?: string;
3999
+ /** Output only. User last logged in time. If the user has not logged in yet, this field will be empty. */
4000
+ lastLoginTime?: string;
4001
+ /** Output only. License assignment state of the user. If the user is assigned with a license config, the user loggin will be assigned with the license; If the user's license assignment state is unassigned or unspecified, no license config will be associated to the user; */
4002
+ licenseAssignmentState?: string;
4003
+ /** Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. */
4004
+ licenseConfig?: string;
4005
+ /** Output only. User update timestamp. */
4006
+ updateTime?: string;
4007
+ /** Optional. The full resource name of the User, in the format of `projects/{project}/locations/{location}/userStores/{user_store}/users/{user_id}`. This field must be a UTF-8 encoded string with a length limit of 2048 characters. If the user field is empty, it's indicating the user has not logged in yet and no User entity is created. */
4008
+ user?: string;
4009
+ /** Required. Immutable. The user principal of the User, could be email address or other prinical identifier. This field is immutable. Admin assign licenses based on the user principal. */
4010
+ userPrincipal?: string;
4011
+ /** Optional. The user profile. We user user full name(First name + Last name) as user profile. */
4012
+ userProfile?: string;
4013
+ }
3958
4014
  interface GoogleCloudDiscoveryengineV1alphaWidgetConfig {
3959
4015
  /** Will be used for all widget access settings seen in cloud console integration page. Replaces top deprecated top level properties. */
3960
4016
  accessSettings?: GoogleCloudDiscoveryengineV1alphaWidgetConfigAccessSettings;
@@ -3986,6 +4042,8 @@ declare namespace gapi.client {
3986
4042
  enableAutocomplete?: boolean;
3987
4043
  /** Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). */
3988
4044
  enableConversationalSearch?: boolean;
4045
+ /** Optional. Output only. Whether to enable private knowledge graph. */
4046
+ enablePrivateKnowledgeGraph?: boolean;
3989
4047
  /** Turn on or off collecting the search result quality feedback from end users. */
3990
4048
  enableQualityFeedback?: boolean;
3991
4049
  /** Whether to show the result score. */
@@ -4282,7 +4340,7 @@ declare namespace gapi.client {
4282
4340
  filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
4283
4341
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
4284
4342
  name?: string;
4285
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
4343
+ /** Promote certain links based on predefined trigger queries. */
4286
4344
  promoteAction?: GoogleCloudDiscoveryengineV1betaControlPromoteAction;
4287
4345
  /** Defines a redirect-type control. */
4288
4346
  redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
@@ -5103,6 +5161,8 @@ declare namespace gapi.client {
5103
5161
  interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
5104
5162
  /** Optional. Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
5105
5163
  boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
5164
+ /** Optional. Custom search operators which if specified will be used to filter results from workspace data stores. For more information on custom search operators, see [SearchOperators](https://support.google.com/cloudsearch/answer/6172299). */
5165
+ customSearchOperators?: string;
5106
5166
  /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
5107
5167
  dataStore?: string;
5108
5168
  /** Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
@@ -5350,7 +5410,7 @@ declare namespace gapi.client {
5350
5410
  filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
5351
5411
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
5352
5412
  name?: string;
5353
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
5413
+ /** Promote certain links based on predefined trigger queries. */
5354
5414
  promoteAction?: GoogleCloudDiscoveryengineV1ControlPromoteAction;
5355
5415
  /** Defines a redirect-type control. */
5356
5416
  redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
@@ -17751,8 +17811,102 @@ declare namespace gapi.client {
17751
17811
  uploadType?: string;
17752
17812
  }): Request<GoogleLongrunningListOperationsResponse>;
17753
17813
  }
17814
+ interface UserLicensesResource {
17815
+ /** Lists the User Licenses. */
17816
+ list(request?: {
17817
+ /** V1 error format. */
17818
+ '$.xgafv'?: string;
17819
+ /** OAuth access token. */
17820
+ access_token?: string;
17821
+ /** Data format for response. */
17822
+ alt?: string;
17823
+ /** JSONP */
17824
+ callback?: string;
17825
+ /** Selector specifying which fields to include in a partial response. */
17826
+ fields?: string;
17827
+ /** Optional. Filter for the list request. Supported fields: * `license_assignment_state` Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. */
17828
+ filter?: string;
17829
+ /** 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. */
17830
+ key?: string;
17831
+ /** OAuth 2.0 token for the current user. */
17832
+ oauth_token?: string;
17833
+ /** Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 10. The maximum value is 50; values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT error is returned. */
17834
+ pageSize?: number;
17835
+ /** Optional. A page token, received from a previous `ListUserLicenses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLicenses` must match the call that provided the page token. */
17836
+ pageToken?: string;
17837
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
17838
+ parent: string;
17839
+ /** Returns response with indentations and line breaks. */
17840
+ prettyPrint?: boolean;
17841
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
17842
+ quotaUser?: string;
17843
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
17844
+ upload_protocol?: string;
17845
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
17846
+ uploadType?: string;
17847
+ }): Request<GoogleCloudDiscoveryengineV1alphaListUserLicensesResponse>;
17848
+ }
17754
17849
  interface UserStoresResource {
17850
+ /** Updates the User License. This method is used for batch assign/unassign licenses to users. */
17851
+ batchUpdateUserLicenses(request: {
17852
+ /** V1 error format. */
17853
+ '$.xgafv'?: string;
17854
+ /** OAuth access token. */
17855
+ access_token?: string;
17856
+ /** Data format for response. */
17857
+ alt?: string;
17858
+ /** JSONP */
17859
+ callback?: string;
17860
+ /** Selector specifying which fields to include in a partial response. */
17861
+ fields?: string;
17862
+ /** 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. */
17863
+ key?: string;
17864
+ /** OAuth 2.0 token for the current user. */
17865
+ oauth_token?: string;
17866
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
17867
+ parent: string;
17868
+ /** Returns response with indentations and line breaks. */
17869
+ prettyPrint?: boolean;
17870
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
17871
+ quotaUser?: string;
17872
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
17873
+ upload_protocol?: string;
17874
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
17875
+ uploadType?: string;
17876
+ /** Request body */
17877
+ resource: GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest;
17878
+ }): Request<GoogleLongrunningOperation>;
17879
+ batchUpdateUserLicenses(
17880
+ request: {
17881
+ /** V1 error format. */
17882
+ '$.xgafv'?: string;
17883
+ /** OAuth access token. */
17884
+ access_token?: string;
17885
+ /** Data format for response. */
17886
+ alt?: string;
17887
+ /** JSONP */
17888
+ callback?: string;
17889
+ /** Selector specifying which fields to include in a partial response. */
17890
+ fields?: string;
17891
+ /** 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. */
17892
+ key?: string;
17893
+ /** OAuth 2.0 token for the current user. */
17894
+ oauth_token?: string;
17895
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
17896
+ parent: string;
17897
+ /** Returns response with indentations and line breaks. */
17898
+ prettyPrint?: boolean;
17899
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
17900
+ quotaUser?: string;
17901
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
17902
+ upload_protocol?: string;
17903
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
17904
+ uploadType?: string;
17905
+ },
17906
+ body: GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequest,
17907
+ ): Request<GoogleLongrunningOperation>;
17755
17908
  operations: OperationsResource;
17909
+ userLicenses: UserLicensesResource;
17756
17910
  }
17757
17911
  interface LocationsResource {
17758
17912
  /** Estimates the data size to be used by a customer. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
3
- "version": "0.0.20250430",
3
+ "version": "0.0.20250509",
4
4
  "description": "TypeScript typings for Discovery Engine API v1alpha",
5
5
  "repository": {
6
6
  "type": "git",