@maxim_mazurok/gapi.client.discoveryengine-v1beta 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 +181 -12
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20250430
12
+ // Revision: 20250508
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -422,6 +422,22 @@ declare namespace gapi.client {
422
422
  /** TargetSites created. */
423
423
  targetSites?: GoogleCloudDiscoveryengineV1alphaTargetSite[];
424
424
  }
425
+ interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesMetadata {
426
+ /** Operation create time. */
427
+ createTime?: string;
428
+ /** Count of user licenses that failed to be updated. */
429
+ failureCount?: string;
430
+ /** Count of user licenses successfully updated. */
431
+ successCount?: string;
432
+ /** Operation last update time. If the operation is done, this is also the finish time. */
433
+ updateTime?: string;
434
+ }
435
+ interface GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesResponse {
436
+ /** A sample of errors encountered while processing the request. */
437
+ errorSamples?: GoogleRpcStatus[];
438
+ /** UserLicenses successfully updated. */
439
+ userLicenses?: GoogleCloudDiscoveryengineV1alphaUserLicense[];
440
+ }
425
441
  interface GoogleCloudDiscoveryengineV1alphaCmekConfig {
426
442
  /** Output only. The default CmekConfig for the Customer. */
427
443
  isDefault?: boolean;
@@ -537,7 +553,7 @@ declare namespace gapi.client {
537
553
  filterAction?: GoogleCloudDiscoveryengineV1alphaControlFilterAction;
538
554
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
539
555
  name?: string;
540
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
556
+ /** Promote certain links based on predefined trigger queries. */
541
557
  promoteAction?: GoogleCloudDiscoveryengineV1alphaControlPromoteAction;
542
558
  /** Defines a redirect-type control. */
543
559
  redirectAction?: GoogleCloudDiscoveryengineV1alphaControlRedirectAction;
@@ -650,8 +666,10 @@ declare namespace gapi.client {
650
666
  blockingReasons?: string[];
651
667
  /** Optional. The modes enabled for this connector. Default state is CONNECTOR_MODE_UNSPECIFIED. */
652
668
  connectorModes?: string[];
653
- /** 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. */
669
+ /** 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. */
654
670
  connectorType?: string;
671
+ /** Optional. Whether the END USER AUTHENTICATION connector is created in SaaS. */
672
+ createEuaSaas?: boolean;
655
673
  /** Output only. Timestamp the DataConnector was created at. */
656
674
  createTime?: string;
657
675
  /** Required. The name of the data source. Supported values: `salesforce`, `jira`, `confluence`, `bigquery`. */
@@ -1673,6 +1691,8 @@ declare namespace gapi.client {
1673
1691
  interface GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec {
1674
1692
  /** 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) */
1675
1693
  boostSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec;
1694
+ /** 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). */
1695
+ customSearchOperators?: string;
1676
1696
  /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
1677
1697
  dataStore?: string;
1678
1698
  /** 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) */
@@ -1911,6 +1931,24 @@ declare namespace gapi.client {
1911
1931
  /** 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. */
1912
1932
  userId?: string;
1913
1933
  }
1934
+ interface GoogleCloudDiscoveryengineV1alphaUserLicense {
1935
+ /** Output only. User created timestamp. */
1936
+ createTime?: string;
1937
+ /** Output only. User last logged in time. If the user has not logged in yet, this field will be empty. */
1938
+ lastLoginTime?: string;
1939
+ /** 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; */
1940
+ licenseAssignmentState?: string;
1941
+ /** Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. */
1942
+ licenseConfig?: string;
1943
+ /** Output only. User update timestamp. */
1944
+ updateTime?: string;
1945
+ /** 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. */
1946
+ user?: string;
1947
+ /** 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. */
1948
+ userPrincipal?: string;
1949
+ /** Optional. The user profile. We user user full name(First name + Last name) as user profile. */
1950
+ userProfile?: string;
1951
+ }
1914
1952
  interface GoogleCloudDiscoveryengineV1alphaWorkspaceConfig {
1915
1953
  /** Obfuscated Dasher customer ID. */
1916
1954
  dasherCustomerId?: string;
@@ -2529,6 +2567,20 @@ declare namespace gapi.client {
2529
2567
  /** If match by URI, the URI of the Document. */
2530
2568
  uri?: string;
2531
2569
  }
2570
+ interface GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest {
2571
+ /** 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. */
2572
+ deleteUnassignedUserLicenses?: boolean;
2573
+ /** Cloud Storage location for the input content. */
2574
+ gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
2575
+ /** The inline source for the input content for document embeddings. */
2576
+ inlineSource?: GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource;
2577
+ }
2578
+ interface GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource {
2579
+ /** Optional. The list of fields to update. */
2580
+ updateMask?: string;
2581
+ /** Required. A list of user licenses to update. Each user license must have a valid UserLicense.user_principal. */
2582
+ userLicenses?: GoogleCloudDiscoveryengineV1betaUserLicense[];
2583
+ }
2532
2584
  interface GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest {}
2533
2585
  interface GoogleCloudDiscoveryengineV1betaBigQuerySource {
2534
2586
  /** 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. */
@@ -2615,7 +2667,7 @@ declare namespace gapi.client {
2615
2667
  endPos?: number;
2616
2668
  /** 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. */
2617
2669
  groundingCheckRequired?: boolean;
2618
- /** 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. */
2670
+ /** 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. */
2619
2671
  score?: number;
2620
2672
  /** 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). */
2621
2673
  startPos?: number;
@@ -2767,7 +2819,7 @@ declare namespace gapi.client {
2767
2819
  filterAction?: GoogleCloudDiscoveryengineV1betaControlFilterAction;
2768
2820
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
2769
2821
  name?: string;
2770
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
2822
+ /** Promote certain links based on predefined trigger queries. */
2771
2823
  promoteAction?: GoogleCloudDiscoveryengineV1betaControlPromoteAction;
2772
2824
  /** Defines a redirect-type control. */
2773
2825
  redirectAction?: GoogleCloudDiscoveryengineV1betaControlRedirectAction;
@@ -3724,6 +3776,12 @@ declare namespace gapi.client {
3724
3776
  /** The total number of items matching the request. This will always be populated in the response. */
3725
3777
  totalSize?: number;
3726
3778
  }
3779
+ interface GoogleCloudDiscoveryengineV1betaListUserLicensesResponse {
3780
+ /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
3781
+ nextPageToken?: string;
3782
+ /** All the customer's UserLicenses. */
3783
+ userLicenses?: GoogleCloudDiscoveryengineV1betaUserLicense[];
3784
+ }
3727
3785
  interface GoogleCloudDiscoveryengineV1betaMediaInfo {
3728
3786
  /** 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. */
3729
3787
  mediaProgressDuration?: string;
@@ -4279,6 +4337,8 @@ declare namespace gapi.client {
4279
4337
  interface GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec {
4280
4338
  /** 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) */
4281
4339
  boostSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
4340
+ /** 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). */
4341
+ customSearchOperators?: string;
4282
4342
  /** Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. */
4283
4343
  dataStore?: string;
4284
4344
  /** 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) */
@@ -4438,15 +4498,9 @@ declare namespace gapi.client {
4438
4498
  extractedFilters?: string;
4439
4499
  /** Rewritten input query minus the extracted filters. */
4440
4500
  rewrittenQuery?: string;
4441
- /** Optional. The SQL request that was generated from the natural language query understanding phase. */
4442
- sqlRequest?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest;
4443
4501
  /** The filters that were extracted from the input query represented in a structured form. */
4444
4502
  structuredExtractedFilter?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter;
4445
4503
  }
4446
- interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoSqlRequest {
4447
- /** Optional. The SQL query in text format. */
4448
- sqlQuery?: string;
4449
- }
4450
4504
  interface GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter {
4451
4505
  /** 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. */
4452
4506
  expression?: GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression;
@@ -4913,6 +4967,24 @@ declare namespace gapi.client {
4913
4967
  /** 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. */
4914
4968
  userId?: string;
4915
4969
  }
4970
+ interface GoogleCloudDiscoveryengineV1betaUserLicense {
4971
+ /** Output only. User created timestamp. */
4972
+ createTime?: string;
4973
+ /** Output only. User last logged in time. If the user has not logged in yet, this field will be empty. */
4974
+ lastLoginTime?: string;
4975
+ /** 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; */
4976
+ licenseAssignmentState?: string;
4977
+ /** Optional. The full resource name of the Subscription(LicenseConfig) assigned to the user. */
4978
+ licenseConfig?: string;
4979
+ /** Output only. User update timestamp. */
4980
+ updateTime?: string;
4981
+ /** 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. */
4982
+ user?: string;
4983
+ /** 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. */
4984
+ userPrincipal?: string;
4985
+ /** Optional. The user profile. We user user full name(First name + Last name) as user profile. */
4986
+ userProfile?: string;
4987
+ }
4916
4988
  interface GoogleCloudDiscoveryengineV1betaWorkspaceConfig {
4917
4989
  /** Obfuscated Dasher customer ID. */
4918
4990
  dasherCustomerId?: string;
@@ -4974,7 +5046,7 @@ declare namespace gapi.client {
4974
5046
  filterAction?: GoogleCloudDiscoveryengineV1ControlFilterAction;
4975
5047
  /** Immutable. Fully qualified name `projects/*‍/locations/global/dataStore/*‍/controls/*` */
4976
5048
  name?: string;
4977
- /** Promote certain links based on predefined trigger queries. This now only supports basic site search. */
5049
+ /** Promote certain links based on predefined trigger queries. */
4978
5050
  promoteAction?: GoogleCloudDiscoveryengineV1ControlPromoteAction;
4979
5051
  /** Defines a redirect-type control. */
4980
5052
  redirectAction?: GoogleCloudDiscoveryengineV1ControlRedirectAction;
@@ -16259,6 +16331,102 @@ declare namespace gapi.client {
16259
16331
  body: GoogleCloudDiscoveryengineV1betaUserEvent,
16260
16332
  ): Request<GoogleCloudDiscoveryengineV1betaUserEvent>;
16261
16333
  }
16334
+ interface UserLicensesResource {
16335
+ /** Lists the User Licenses. */
16336
+ list(request?: {
16337
+ /** V1 error format. */
16338
+ '$.xgafv'?: string;
16339
+ /** OAuth access token. */
16340
+ access_token?: string;
16341
+ /** Data format for response. */
16342
+ alt?: string;
16343
+ /** JSONP */
16344
+ callback?: string;
16345
+ /** Selector specifying which fields to include in a partial response. */
16346
+ fields?: string;
16347
+ /** 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. */
16348
+ filter?: string;
16349
+ /** 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. */
16350
+ key?: string;
16351
+ /** OAuth 2.0 token for the current user. */
16352
+ oauth_token?: string;
16353
+ /** 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. */
16354
+ pageSize?: number;
16355
+ /** 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. */
16356
+ pageToken?: string;
16357
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
16358
+ parent: string;
16359
+ /** Returns response with indentations and line breaks. */
16360
+ prettyPrint?: boolean;
16361
+ /** 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. */
16362
+ quotaUser?: string;
16363
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
16364
+ upload_protocol?: string;
16365
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
16366
+ uploadType?: string;
16367
+ }): Request<GoogleCloudDiscoveryengineV1betaListUserLicensesResponse>;
16368
+ }
16369
+ interface UserStoresResource {
16370
+ /** Updates the User License. This method is used for batch assign/unassign licenses to users. */
16371
+ batchUpdateUserLicenses(request: {
16372
+ /** V1 error format. */
16373
+ '$.xgafv'?: string;
16374
+ /** OAuth access token. */
16375
+ access_token?: string;
16376
+ /** Data format for response. */
16377
+ alt?: string;
16378
+ /** JSONP */
16379
+ callback?: string;
16380
+ /** Selector specifying which fields to include in a partial response. */
16381
+ fields?: string;
16382
+ /** 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. */
16383
+ key?: string;
16384
+ /** OAuth 2.0 token for the current user. */
16385
+ oauth_token?: string;
16386
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
16387
+ parent: string;
16388
+ /** Returns response with indentations and line breaks. */
16389
+ prettyPrint?: boolean;
16390
+ /** 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. */
16391
+ quotaUser?: string;
16392
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
16393
+ upload_protocol?: string;
16394
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
16395
+ uploadType?: string;
16396
+ /** Request body */
16397
+ resource: GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest;
16398
+ }): Request<GoogleLongrunningOperation>;
16399
+ batchUpdateUserLicenses(
16400
+ request: {
16401
+ /** V1 error format. */
16402
+ '$.xgafv'?: string;
16403
+ /** OAuth access token. */
16404
+ access_token?: string;
16405
+ /** Data format for response. */
16406
+ alt?: string;
16407
+ /** JSONP */
16408
+ callback?: string;
16409
+ /** Selector specifying which fields to include in a partial response. */
16410
+ fields?: string;
16411
+ /** 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. */
16412
+ key?: string;
16413
+ /** OAuth 2.0 token for the current user. */
16414
+ oauth_token?: string;
16415
+ /** Required. The parent UserStore resource name, format: `projects/{project}/locations/{location}/userStores/{user_store_id}`. */
16416
+ parent: string;
16417
+ /** Returns response with indentations and line breaks. */
16418
+ prettyPrint?: boolean;
16419
+ /** 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. */
16420
+ quotaUser?: string;
16421
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
16422
+ upload_protocol?: string;
16423
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
16424
+ uploadType?: string;
16425
+ },
16426
+ body: GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequest,
16427
+ ): Request<GoogleLongrunningOperation>;
16428
+ userLicenses: UserLicensesResource;
16429
+ }
16262
16430
  interface LocationsResource {
16263
16431
  /** Gets the CmekConfig. */
16264
16432
  getCmekConfig(request?: {
@@ -16534,6 +16702,7 @@ declare namespace gapi.client {
16534
16702
  rankingConfigs: RankingConfigsResource;
16535
16703
  sampleQuerySets: SampleQuerySetsResource;
16536
16704
  userEvents: UserEventsResource;
16705
+ userStores: UserStoresResource;
16537
16706
  }
16538
16707
  interface OperationsResource {
16539
16708
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20250430",
3
+ "version": "0.0.20250508",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",