@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.1.20251116 → 0.1.20251209

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 +101 -4
  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: 20251116
12
+ // Revision: 20251209
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -1321,6 +1321,8 @@ declare namespace gapi.client {
1321
1321
  tuningOperation?: string;
1322
1322
  }
1323
1323
  interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
1324
+ /** Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. */
1325
+ requiredSubscriptionTier?: string;
1324
1326
  /** The add-on that this search engine enables. */
1325
1327
  searchAddOns?: string[];
1326
1328
  /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
@@ -1880,7 +1882,7 @@ declare namespace gapi.client {
1880
1882
  oneBoxPageSize?: number;
1881
1883
  /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
1882
1884
  orderBy?: string;
1883
- /** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
1885
+ /** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
1884
1886
  pageCategories?: string[];
1885
1887
  /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
1886
1888
  pageSize?: number;
@@ -4058,6 +4060,8 @@ declare namespace gapi.client {
4058
4060
  contextEventType?: string;
4059
4061
  }
4060
4062
  interface GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig {
4063
+ /** Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. */
4064
+ requiredSubscriptionTier?: string;
4061
4065
  /** The add-on that this search engine enables. */
4062
4066
  searchAddOns?: string[];
4063
4067
  /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
@@ -4164,6 +4168,8 @@ declare namespace gapi.client {
4164
4168
  interface GoogleCloudDiscoveryengineV1betaIdentityMappingEntry {
4165
4169
  /** Required. Identity outside the customer identity provider. The length limit of external identity will be of 100 characters. */
4166
4170
  externalIdentity?: string;
4171
+ /** Optional. The name of the external identity. */
4172
+ externalIdentityName?: string;
4167
4173
  /** Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider, group_id is the mapped group identifier configured during the workforcepool config. */
4168
4174
  groupId?: string;
4169
4175
  /** User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider, user_id is the mapped user identifier configured during the workforcepool config. */
@@ -5004,7 +5010,7 @@ declare namespace gapi.client {
5004
5010
  oneBoxPageSize?: number;
5005
5011
  /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
5006
5012
  orderBy?: string;
5007
- /** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
5013
+ /** Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '>' character to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, `Graphics Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` */
5008
5014
  pageCategories?: string[];
5009
5015
  /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
5010
5016
  pageSize?: number;
@@ -5285,6 +5291,8 @@ declare namespace gapi.client {
5285
5291
  results?: GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[];
5286
5292
  /** Promotions for site search. */
5287
5293
  searchLinkPromotions?: GoogleCloudDiscoveryengineV1betaSearchLinkPromotion[];
5294
+ /** Output only. Indicates the semantic state of the search response. */
5295
+ semanticState?: string;
5288
5296
  /** Session information. Only set if SearchRequest.session is provided. See its description for more details. */
5289
5297
  sessionInfo?: GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo;
5290
5298
  /** Corrected query with low confidence, AKA did you mean query. Compared with corrected_query, this field is set when SpellCorrector returned a response, but FPR(full page replacement) is not triggered because the corrction is of low confidence(eg, reversed because there are matches of the original query in document corpus). */
@@ -5854,7 +5862,7 @@ declare namespace gapi.client {
5854
5862
  eventTime?: string;
5855
5863
  /** 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. */
5856
5864
  eventType?: string;
5857
- /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
5865
+ /** Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
5858
5866
  filter?: string;
5859
5867
  /** Media-specific info. */
5860
5868
  mediaInfo?: GoogleCloudDiscoveryengineV1betaMediaInfo;
@@ -6236,6 +6244,8 @@ declare namespace gapi.client {
6236
6244
  kmsKeyName?: string;
6237
6245
  /** Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
6238
6246
  name?: string;
6247
+ /** Optional. Configuration for Natural Language Query Understanding. */
6248
+ naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig;
6239
6249
  /** Optional. Stores serving config at DataStore level. */
6240
6250
  servingConfigDataStore?: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore;
6241
6251
  /** The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */
@@ -6493,6 +6503,8 @@ declare namespace gapi.client {
6493
6503
  contextEventType?: string;
6494
6504
  }
6495
6505
  interface GoogleCloudDiscoveryengineV1EngineSearchEngineConfig {
6506
+ /** Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. */
6507
+ requiredSubscriptionTier?: string;
6496
6508
  /** The add-on that this search engine enables. */
6497
6509
  searchAddOns?: string[];
6498
6510
  /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
@@ -6626,6 +6638,10 @@ declare namespace gapi.client {
6626
6638
  /** Required. Subscription tier information for the license config. */
6627
6639
  subscriptionTier?: string;
6628
6640
  }
6641
+ interface GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig {
6642
+ /** Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. */
6643
+ mode?: string;
6644
+ }
6629
6645
  interface GoogleCloudDiscoveryengineV1Project {
6630
6646
  /** Output only. The current status of the project's configurable billing. */
6631
6647
  configurableBillingStatus?: GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
@@ -8961,6 +8977,33 @@ declare namespace gapi.client {
8961
8977
  },
8962
8978
  body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
8963
8979
  ): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
8980
+ /** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
8981
+ delete(request?: {
8982
+ /** V1 error format. */
8983
+ '$.xgafv'?: string;
8984
+ /** OAuth access token. */
8985
+ access_token?: string;
8986
+ /** Data format for response. */
8987
+ alt?: string;
8988
+ /** JSONP */
8989
+ callback?: string;
8990
+ /** Selector specifying which fields to include in a partial response. */
8991
+ fields?: string;
8992
+ /** 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. */
8993
+ key?: string;
8994
+ /** Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
8995
+ name: string;
8996
+ /** OAuth 2.0 token for the current user. */
8997
+ oauth_token?: string;
8998
+ /** Returns response with indentations and line breaks. */
8999
+ prettyPrint?: boolean;
9000
+ /** 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. */
9001
+ quotaUser?: string;
9002
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9003
+ upload_protocol?: string;
9004
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9005
+ uploadType?: string;
9006
+ }): Request<{}>;
8964
9007
  /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
8965
9008
  get(request?: {
8966
9009
  /** V1 error format. */
@@ -12050,6 +12093,33 @@ declare namespace gapi.client {
12050
12093
  },
12051
12094
  body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
12052
12095
  ): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
12096
+ /** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
12097
+ delete(request?: {
12098
+ /** V1 error format. */
12099
+ '$.xgafv'?: string;
12100
+ /** OAuth access token. */
12101
+ access_token?: string;
12102
+ /** Data format for response. */
12103
+ alt?: string;
12104
+ /** JSONP */
12105
+ callback?: string;
12106
+ /** Selector specifying which fields to include in a partial response. */
12107
+ fields?: string;
12108
+ /** 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. */
12109
+ key?: string;
12110
+ /** Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
12111
+ name: string;
12112
+ /** OAuth 2.0 token for the current user. */
12113
+ oauth_token?: string;
12114
+ /** Returns response with indentations and line breaks. */
12115
+ prettyPrint?: boolean;
12116
+ /** 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. */
12117
+ quotaUser?: string;
12118
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
12119
+ upload_protocol?: string;
12120
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
12121
+ uploadType?: string;
12122
+ }): Request<{}>;
12053
12123
  /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
12054
12124
  get(request?: {
12055
12125
  /** V1 error format. */
@@ -14659,6 +14729,33 @@ declare namespace gapi.client {
14659
14729
  },
14660
14730
  body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
14661
14731
  ): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
14732
+ /** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
14733
+ delete(request?: {
14734
+ /** V1 error format. */
14735
+ '$.xgafv'?: string;
14736
+ /** OAuth access token. */
14737
+ access_token?: string;
14738
+ /** Data format for response. */
14739
+ alt?: string;
14740
+ /** JSONP */
14741
+ callback?: string;
14742
+ /** Selector specifying which fields to include in a partial response. */
14743
+ fields?: string;
14744
+ /** 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. */
14745
+ key?: string;
14746
+ /** Required. The resource name of the ServingConfig to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}` */
14747
+ name: string;
14748
+ /** OAuth 2.0 token for the current user. */
14749
+ oauth_token?: string;
14750
+ /** Returns response with indentations and line breaks. */
14751
+ prettyPrint?: boolean;
14752
+ /** 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. */
14753
+ quotaUser?: string;
14754
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
14755
+ upload_protocol?: string;
14756
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14757
+ uploadType?: string;
14758
+ }): Request<{}>;
14662
14759
  /** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
14663
14760
  get(request?: {
14664
14761
  /** V1 error format. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.1.20251116",
3
+ "version": "0.1.20251209",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "repository": {
6
6
  "type": "git",