@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.1.20251203 → 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.
- package/index.d.ts +91 -4
- 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:
|
|
12
|
+
// Revision: 20251209
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1882,7 +1882,7 @@ declare namespace gapi.client {
|
|
|
1882
1882
|
oneBoxPageSize?: number;
|
|
1883
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. */
|
|
1884
1884
|
orderBy?: string;
|
|
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. 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` */
|
|
1886
1886
|
pageCategories?: string[];
|
|
1887
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. */
|
|
1888
1888
|
pageSize?: number;
|
|
@@ -5010,7 +5010,7 @@ declare namespace gapi.client {
|
|
|
5010
5010
|
oneBoxPageSize?: number;
|
|
5011
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. */
|
|
5012
5012
|
orderBy?: string;
|
|
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. 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` */
|
|
5014
5014
|
pageCategories?: string[];
|
|
5015
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. */
|
|
5016
5016
|
pageSize?: number;
|
|
@@ -5862,7 +5862,7 @@ declare namespace gapi.client {
|
|
|
5862
5862
|
eventTime?: string;
|
|
5863
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. */
|
|
5864
5864
|
eventType?: string;
|
|
5865
|
-
/** 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. */
|
|
5866
5866
|
filter?: string;
|
|
5867
5867
|
/** Media-specific info. */
|
|
5868
5868
|
mediaInfo?: GoogleCloudDiscoveryengineV1betaMediaInfo;
|
|
@@ -6244,6 +6244,8 @@ declare namespace gapi.client {
|
|
|
6244
6244
|
kmsKeyName?: string;
|
|
6245
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. */
|
|
6246
6246
|
name?: string;
|
|
6247
|
+
/** Optional. Configuration for Natural Language Query Understanding. */
|
|
6248
|
+
naturalLanguageQueryUnderstandingConfig?: GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig;
|
|
6247
6249
|
/** Optional. Stores serving config at DataStore level. */
|
|
6248
6250
|
servingConfigDataStore?: GoogleCloudDiscoveryengineV1DataStoreServingConfigDataStore;
|
|
6249
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. */
|
|
@@ -6636,6 +6638,10 @@ declare namespace gapi.client {
|
|
|
6636
6638
|
/** Required. Subscription tier information for the license config. */
|
|
6637
6639
|
subscriptionTier?: string;
|
|
6638
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
|
+
}
|
|
6639
6645
|
interface GoogleCloudDiscoveryengineV1Project {
|
|
6640
6646
|
/** Output only. The current status of the project's configurable billing. */
|
|
6641
6647
|
configurableBillingStatus?: GoogleCloudDiscoveryengineV1ProjectConfigurableBillingStatus;
|
|
@@ -8971,6 +8977,33 @@ declare namespace gapi.client {
|
|
|
8971
8977
|
},
|
|
8972
8978
|
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
|
|
8973
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<{}>;
|
|
8974
9007
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
8975
9008
|
get(request?: {
|
|
8976
9009
|
/** V1 error format. */
|
|
@@ -12060,6 +12093,33 @@ declare namespace gapi.client {
|
|
|
12060
12093
|
},
|
|
12061
12094
|
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
|
|
12062
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<{}>;
|
|
12063
12123
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
12064
12124
|
get(request?: {
|
|
12065
12125
|
/** V1 error format. */
|
|
@@ -14669,6 +14729,33 @@ declare namespace gapi.client {
|
|
|
14669
14729
|
},
|
|
14670
14730
|
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
|
|
14671
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<{}>;
|
|
14672
14759
|
/** Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. */
|
|
14673
14760
|
get(request?: {
|
|
14674
14761
|
/** V1 error format. */
|