@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20250430 → 0.0.20250508

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 +183 -6
  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=v1
12
- // Revision: 20250430
12
+ // Revision: 20250508
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -436,6 +436,22 @@ declare namespace gapi.client {
436
436
  /** TargetSites created. */
437
437
  targetSites?: GoogleCloudDiscoveryengineV1alphaTargetSite[];
438
438
  }
439
+ interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata {
440
+ /** Operation create time. */
441
+ createTime?: string;
442
+ /** Count of user licenses that failed to be updated. */
443
+ failureCount?: string;
444
+ /** Count of user licenses successfully updated. */
445
+ successCount?: string;
446
+ /** Operation last update time. If the operation is done, this is also the finish time. */
447
+ updateTime?: string;
448
+ }
449
+ interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse {
450
+ /** A sample of errors encountered while processing the request. */
451
+ errorSamples?: GoogleRpcStatus[];
452
+ /** UserLicenses successfully updated. */
453
+ userLicenses?: GoogleCloudDiscoveryengineV1alphaUserLicense[];
454
+ }
439
455
  interface GoogleCloudDiscoveryengineV1alphaCmekConfig {
440
456
  /** Output only. The default CmekConfig for the Customer. */
441
457
  isDefault?: boolean;
@@ -551,7 +567,7 @@ declare namespace gapi.client {
551
567
  filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
552
568
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
553
569
  name?: string;
554
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
570
+ /** Promote certain links based on predefined trigger queries. */
555
571
  promoteAction?: GoogleCloudDiscoveryengineV1alphaControlPromoteAction;
556
572
  /** Defines a redirect-type control. */
557
573
  redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
@@ -664,8 +680,10 @@ declare namespace gapi.client {
664
680
  blockingReasons?: string[];
665
681
  /** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
666
682
  connectorModes?: string[];
667
- /** 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. */
683
+ /** 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. */
668
684
  connectorType?: string;
685
+ /** Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. */
686
+ createEuaSaas?: boolean;
669
687
  /** Output only. Timestamp the DataConnector was created at. */
670
688
  createTime?: string;
671
689
  /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
@@ -1687,6 +1705,8 @@ declare namespace gapi.client {
1687
1705
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
1688
1706
  /** 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) */
1689
1707
  boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
1708
+ /** 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). */
1709
+ customSearchOperators?: string;
1690
1710
  /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
1691
1711
  dataStore?: string;
1692
1712
  /** 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) */
@@ -1925,6 +1945,24 @@ declare namespace gapi.client {
1925
1945
  /** 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. */
1926
1946
  userId?: string;
1927
1947
  }
1948
+ interface GoogleCloudDiscoveryengineV1alphaUserLicense {
1949
+ /** Output only. User created timestamp. */
1950
+ createTime?: string;
1951
+ /** Output only. User last logged in time. If the user has not logged in yet, this field will be empty. */
1952
+ lastLoginTime?: string;
1953
+ /** 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; */
1954
+ licenseAssignmentState?: string;
1955
+ /** Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. */
1956
+ licenseConfig?: string;
1957
+ /** Output only. User update timestamp. */
1958
+ updateTime?: string;
1959
+ /** 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. */
1960
+ user?: string;
1961
+ /** 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. */
1962
+ userPrincipal?: string;
1963
+ /** Optional. The user profile. We user user full name(First name + Last name) as user profile. */
1964
+ userProfile?: string;
1965
+ }
1928
1966
  interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
1929
1967
  /** Obfuscated Dasher customer ID. */
1930
1968
  dasherCustomerId?: string;
@@ -2367,6 +2405,20 @@ declare namespace gapi.client {
2367
2405
  /** If match by URI, the URI of the Document. */
2368
2406
  uri?: string;
2369
2407
  }
2408
+ interface GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest {
2409
+ /** 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. */
2410
+ deleteUnassignedUserLicenses?: boolean;
2411
+ /** Cloud Storage location for the input content. */
2412
+ gcsSource?: GoogleCloudDiscoveryengineV1GcsSource;
2413
+ /** The inline source for the input content for document embeddings. */
2414
+ inlineSource?: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource;
2415
+ }
2416
+ interface GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequestInlineSource {
2417
+ /** Optional. The list of fields to update. */
2418
+ updateMask?: string;
2419
+ /** Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal. */
2420
+ userLicenses?: GoogleCloudDiscoveryengineV1UserLicense[];
2421
+ }
2370
2422
  interface GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {}
2371
2423
  interface GoogleCloudDiscoveryengineV1betaAdvancedSiteSearchConfig {
2372
2424
  /** If set true, automatic refresh is disabled for the DataStore. */
@@ -2435,7 +2487,7 @@ declare namespace gapi.client {
2435
2487
  filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
2436
2488
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
2437
2489
  name?: string;
2438
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
2490
+ /** Promote certain links based on predefined trigger queries. */
2439
2491
  promoteAction?: GoogleCloudDiscoveryengineV1betaControlPromoteAction;
2440
2492
  /** Defines a redirect-type control. */
2441
2493
  redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
@@ -3256,6 +3308,8 @@ declare namespace gapi.client {
3256
3308
  interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
3257
3309
  /** 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) */
3258
3310
  boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
3311
+ /** 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). */
3312
+ customSearchOperators?: string;
3259
3313
  /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
3260
3314
  dataStore?: string;
3261
3315
  /** 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) */
@@ -3537,7 +3591,7 @@ declare namespace gapi.client {
3537
3591
  endPos?: number;
3538
3592
  /** 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. */
3539
3593
  groundingCheckRequired?: boolean;
3540
- /** 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. */
3594
+ /** 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. */
3541
3595
  score?: number;
3542
3596
  /** 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). */
3543
3597
  startPos?: number;
@@ -3689,7 +3743,7 @@ declare namespace gapi.client {
3689
3743
  filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
3690
3744
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
3691
3745
  name?: string;
3692
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
3746
+ /** Promote certain links based on predefined trigger queries. */
3693
3747
  promoteAction?: GoogleCloudDiscoveryengineV1ControlPromoteAction;
3694
3748
  /** Defines a redirect-type control. */
3695
3749
  redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
@@ -4521,6 +4575,12 @@ declare namespace gapi.client {
4521
4575
  /** The total number of items matching the request. This will always be populated in the response. */
4522
4576
  totalSize?: number;
4523
4577
  }
4578
+ interface GoogleCloudDiscoveryengineV1ListUserLicensesResponse {
4579
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
4580
+ nextPageToken?: string;
4581
+ /** All the customer's UserLicenses. */
4582
+ userLicenses?: GoogleCloudDiscoveryengineV1UserLicense[];
4583
+ }
4524
4584
  interface GoogleCloudDiscoveryengineV1MediaInfo {
4525
4585
  /** 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. */
4526
4586
  mediaProgressDuration?: string;
@@ -4945,6 +5005,8 @@ declare namespace gapi.client {
4945
5005
  interface GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec {
4946
5006
  /** 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) */
4947
5007
  boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
5008
+ /** 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). */
5009
+ customSearchOperators?: string;
4948
5010
  /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
4949
5011
  dataStore?: string;
4950
5012
  /** 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) */
@@ -5410,6 +5472,24 @@ declare namespace gapi.client {
5410
5472
  /** 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. */
5411
5473
  userId?: string;
5412
5474
  }
5475
+ interface GoogleCloudDiscoveryengineV1UserLicense {
5476
+ /** Output only. User created timestamp. */
5477
+ createTime?: string;
5478
+ /** Output only. User last logged in time. If the user has not logged in yet, this field will be empty. */
5479
+ lastLoginTime?: string;
5480
+ /** 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; */
5481
+ licenseAssignmentState?: string;
5482
+ /** Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. */
5483
+ licenseConfig?: string;
5484
+ /** Output only. User update timestamp. */
5485
+ updateTime?: string;
5486
+ /** 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. */
5487
+ user?: string;
5488
+ /** 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. */
5489
+ userPrincipal?: string;
5490
+ /** Optional. The user profile. We user user full name(First name + Last name) as user profile. */
5491
+ userProfile?: string;
5492
+ }
5413
5493
  interface GoogleCloudDiscoveryengineV1WorkspaceConfig {
5414
5494
  /** Obfuscated Dasher customer ID. */
5415
5495
  dasherCustomerId?: string;
@@ -14741,6 +14821,102 @@ declare namespace gapi.client {
14741
14821
  body: GoogleCloudDiscoveryengineV1UserEvent,
14742
14822
  ): Request<GoogleCloudDiscoveryengineV1UserEvent>;
14743
14823
  }
14824
+ interface UserLicensesResource {
14825
+ /** Lists the User Licenses. */
14826
+ list(request?: {
14827
+ /** V1 error format. */
14828
+ '$.xgafv'?: string;
14829
+ /** OAuth access token. */
14830
+ access_token?: string;
14831
+ /** Data format for response. */
14832
+ alt?: string;
14833
+ /** JSONP */
14834
+ callback?: string;
14835
+ /** Selector specifying which fields to include in a partial response. */
14836
+ fields?: string;
14837
+ /** 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. */
14838
+ filter?: string;
14839
+ /** 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. */
14840
+ key?: string;
14841
+ /** OAuth 2.0 token for the current user. */
14842
+ oauth_token?: string;
14843
+ /** 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. */
14844
+ pageSize?: number;
14845
+ /** 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. */
14846
+ pageToken?: string;
14847
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
14848
+ parent: string;
14849
+ /** Returns response with indentations and line breaks. */
14850
+ prettyPrint?: boolean;
14851
+ /** 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. */
14852
+ quotaUser?: string;
14853
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
14854
+ upload_protocol?: string;
14855
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14856
+ uploadType?: string;
14857
+ }): Request<GoogleCloudDiscoveryengineV1ListUserLicensesResponse>;
14858
+ }
14859
+ interface UserStoresResource {
14860
+ /** Updates the User License. This method is used for batch assign/unassign licenses to users. */
14861
+ batchUpdateUserLicenses(request: {
14862
+ /** V1 error format. */
14863
+ '$.xgafv'?: string;
14864
+ /** OAuth access token. */
14865
+ access_token?: string;
14866
+ /** Data format for response. */
14867
+ alt?: string;
14868
+ /** JSONP */
14869
+ callback?: string;
14870
+ /** Selector specifying which fields to include in a partial response. */
14871
+ fields?: string;
14872
+ /** 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. */
14873
+ key?: string;
14874
+ /** OAuth 2.0 token for the current user. */
14875
+ oauth_token?: string;
14876
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
14877
+ parent: string;
14878
+ /** Returns response with indentations and line breaks. */
14879
+ prettyPrint?: boolean;
14880
+ /** 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. */
14881
+ quotaUser?: string;
14882
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
14883
+ upload_protocol?: string;
14884
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14885
+ uploadType?: string;
14886
+ /** Request body */
14887
+ resource: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest;
14888
+ }): Request<GoogleLongrunningOperation>;
14889
+ batchUpdateUserLicenses(
14890
+ request: {
14891
+ /** V1 error format. */
14892
+ '$.xgafv'?: string;
14893
+ /** OAuth access token. */
14894
+ access_token?: string;
14895
+ /** Data format for response. */
14896
+ alt?: string;
14897
+ /** JSONP */
14898
+ callback?: string;
14899
+ /** Selector specifying which fields to include in a partial response. */
14900
+ fields?: string;
14901
+ /** 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. */
14902
+ key?: string;
14903
+ /** OAuth 2.0 token for the current user. */
14904
+ oauth_token?: string;
14905
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
14906
+ parent: string;
14907
+ /** Returns response with indentations and line breaks. */
14908
+ prettyPrint?: boolean;
14909
+ /** 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. */
14910
+ quotaUser?: string;
14911
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
14912
+ upload_protocol?: string;
14913
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14914
+ uploadType?: string;
14915
+ },
14916
+ body: GoogleCloudDiscoveryengineV1BatchUpdateUserLicensesRequest,
14917
+ ): Request<GoogleLongrunningOperation>;
14918
+ userLicenses: UserLicensesResource;
14919
+ }
14744
14920
  interface LocationsResource {
14745
14921
  /** Gets the CmekConfig. */
14746
14922
  getCmekConfig(request?: {
@@ -14840,6 +15016,7 @@ declare namespace gapi.client {
14840
15016
  podcasts: PodcastsResource;
14841
15017
  rankingConfigs: RankingConfigsResource;
14842
15018
  userEvents: UserEventsResource;
15019
+ userStores: UserStoresResource;
14843
15020
  }
14844
15021
  interface OperationsResource {
14845
15022
  /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1",
3
- "version": "0.0.20250430",
3
+ "version": "0.0.20250508",
4
4
  "description": "TypeScript typings for Discovery Engine API v1",
5
5
  "repository": {
6
6
  "type": "git",