@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.1.20251209 → 0.1.20251217
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 +217 -3
- 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: 20251217
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -1902,9 +1902,11 @@ declare namespace gapi.client {
|
|
|
1902
1902
|
rankingExpressionBackend?: string;
|
|
1903
1903
|
/** The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */
|
|
1904
1904
|
regionCode?: string;
|
|
1905
|
+
/** Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. */
|
|
1906
|
+
relevanceFilterSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec;
|
|
1905
1907
|
/** Optional. The specification for returning the relevance score. */
|
|
1906
1908
|
relevanceScoreSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec;
|
|
1907
|
-
/** The relevance threshold of the search results.
|
|
1909
|
+
/** The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */
|
|
1908
1910
|
relevanceThreshold?: string;
|
|
1909
1911
|
/** Whether to turn on safe search. This is only supported for website search. */
|
|
1910
1912
|
safeSearch?: boolean;
|
|
@@ -2113,6 +2115,18 @@ declare namespace gapi.client {
|
|
|
2113
2115
|
/** Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */
|
|
2114
2116
|
pinUnexpandedResults?: boolean;
|
|
2115
2117
|
}
|
|
2118
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec {
|
|
2119
|
+
/** Optional. Relevance filtering threshold specification for keyword search. */
|
|
2120
|
+
keywordSearchThreshold?: GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
2121
|
+
/** Optional. Relevance filtering threshold specification for semantic search. */
|
|
2122
|
+
semanticSearchThreshold?: GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
2123
|
+
}
|
|
2124
|
+
interface GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
2125
|
+
/** Pre-defined relevance threshold for the sub-search. */
|
|
2126
|
+
relevanceThreshold?: string;
|
|
2127
|
+
/** Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]. */
|
|
2128
|
+
semanticRelevanceThreshold?: number;
|
|
2129
|
+
}
|
|
2116
2130
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec {
|
|
2117
2131
|
/** Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. */
|
|
2118
2132
|
returnRelevanceScore?: boolean;
|
|
@@ -5030,9 +5044,11 @@ declare namespace gapi.client {
|
|
|
5030
5044
|
rankingExpressionBackend?: string;
|
|
5031
5045
|
/** The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */
|
|
5032
5046
|
regionCode?: string;
|
|
5047
|
+
/** Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search. */
|
|
5048
|
+
relevanceFilterSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec;
|
|
5033
5049
|
/** Optional. The specification for returning the relevance score. */
|
|
5034
5050
|
relevanceScoreSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec;
|
|
5035
|
-
/** The relevance threshold of the search results.
|
|
5051
|
+
/** The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search. */
|
|
5036
5052
|
relevanceThreshold?: string;
|
|
5037
5053
|
/** Whether to turn on safe search. This is only supported for website search. */
|
|
5038
5054
|
safeSearch?: boolean;
|
|
@@ -5239,6 +5255,18 @@ declare namespace gapi.client {
|
|
|
5239
5255
|
/** Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */
|
|
5240
5256
|
pinUnexpandedResults?: boolean;
|
|
5241
5257
|
}
|
|
5258
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec {
|
|
5259
|
+
/** Optional. Relevance filtering threshold specification for keyword search. */
|
|
5260
|
+
keywordSearchThreshold?: GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
5261
|
+
/** Optional. Relevance filtering threshold specification for semantic search. */
|
|
5262
|
+
semanticSearchThreshold?: GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
5263
|
+
}
|
|
5264
|
+
interface GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
5265
|
+
/** Pre-defined relevance threshold for the sub-search. */
|
|
5266
|
+
relevanceThreshold?: string;
|
|
5267
|
+
/** Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0]. */
|
|
5268
|
+
semanticRelevanceThreshold?: number;
|
|
5269
|
+
}
|
|
5242
5270
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec {
|
|
5243
5271
|
/** Optional. Whether to return the relevance score for search results. The higher the score, the more relevant the document is to the query. */
|
|
5244
5272
|
returnRelevanceScore?: boolean;
|
|
@@ -8977,6 +9005,68 @@ declare namespace gapi.client {
|
|
|
8977
9005
|
},
|
|
8978
9006
|
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
|
|
8979
9007
|
): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
9008
|
+
/** Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned. */
|
|
9009
|
+
create(request: {
|
|
9010
|
+
/** V1 error format. */
|
|
9011
|
+
'$.xgafv'?: string;
|
|
9012
|
+
/** OAuth access token. */
|
|
9013
|
+
access_token?: string;
|
|
9014
|
+
/** Data format for response. */
|
|
9015
|
+
alt?: string;
|
|
9016
|
+
/** JSONP */
|
|
9017
|
+
callback?: string;
|
|
9018
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9019
|
+
fields?: string;
|
|
9020
|
+
/** 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. */
|
|
9021
|
+
key?: string;
|
|
9022
|
+
/** OAuth 2.0 token for the current user. */
|
|
9023
|
+
oauth_token?: string;
|
|
9024
|
+
/** Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
9025
|
+
parent: string;
|
|
9026
|
+
/** Returns response with indentations and line breaks. */
|
|
9027
|
+
prettyPrint?: boolean;
|
|
9028
|
+
/** 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. */
|
|
9029
|
+
quotaUser?: string;
|
|
9030
|
+
/** Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. */
|
|
9031
|
+
servingConfigId?: string;
|
|
9032
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9033
|
+
upload_protocol?: string;
|
|
9034
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9035
|
+
uploadType?: string;
|
|
9036
|
+
/** Request body */
|
|
9037
|
+
resource: GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
9038
|
+
}): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
9039
|
+
create(
|
|
9040
|
+
request: {
|
|
9041
|
+
/** V1 error format. */
|
|
9042
|
+
'$.xgafv'?: string;
|
|
9043
|
+
/** OAuth access token. */
|
|
9044
|
+
access_token?: string;
|
|
9045
|
+
/** Data format for response. */
|
|
9046
|
+
alt?: string;
|
|
9047
|
+
/** JSONP */
|
|
9048
|
+
callback?: string;
|
|
9049
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
9050
|
+
fields?: string;
|
|
9051
|
+
/** 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. */
|
|
9052
|
+
key?: string;
|
|
9053
|
+
/** OAuth 2.0 token for the current user. */
|
|
9054
|
+
oauth_token?: string;
|
|
9055
|
+
/** Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
9056
|
+
parent: string;
|
|
9057
|
+
/** Returns response with indentations and line breaks. */
|
|
9058
|
+
prettyPrint?: boolean;
|
|
9059
|
+
/** 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. */
|
|
9060
|
+
quotaUser?: string;
|
|
9061
|
+
/** Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. */
|
|
9062
|
+
servingConfigId?: string;
|
|
9063
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
9064
|
+
upload_protocol?: string;
|
|
9065
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
9066
|
+
uploadType?: string;
|
|
9067
|
+
},
|
|
9068
|
+
body: GoogleCloudDiscoveryengineV1betaServingConfig,
|
|
9069
|
+
): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
8980
9070
|
/** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
8981
9071
|
delete(request?: {
|
|
8982
9072
|
/** V1 error format. */
|
|
@@ -12093,6 +12183,68 @@ declare namespace gapi.client {
|
|
|
12093
12183
|
},
|
|
12094
12184
|
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
|
|
12095
12185
|
): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
12186
|
+
/** Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned. */
|
|
12187
|
+
create(request: {
|
|
12188
|
+
/** V1 error format. */
|
|
12189
|
+
'$.xgafv'?: string;
|
|
12190
|
+
/** OAuth access token. */
|
|
12191
|
+
access_token?: string;
|
|
12192
|
+
/** Data format for response. */
|
|
12193
|
+
alt?: string;
|
|
12194
|
+
/** JSONP */
|
|
12195
|
+
callback?: string;
|
|
12196
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12197
|
+
fields?: string;
|
|
12198
|
+
/** 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. */
|
|
12199
|
+
key?: string;
|
|
12200
|
+
/** OAuth 2.0 token for the current user. */
|
|
12201
|
+
oauth_token?: string;
|
|
12202
|
+
/** Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
12203
|
+
parent: string;
|
|
12204
|
+
/** Returns response with indentations and line breaks. */
|
|
12205
|
+
prettyPrint?: boolean;
|
|
12206
|
+
/** 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. */
|
|
12207
|
+
quotaUser?: string;
|
|
12208
|
+
/** Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. */
|
|
12209
|
+
servingConfigId?: string;
|
|
12210
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12211
|
+
upload_protocol?: string;
|
|
12212
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12213
|
+
uploadType?: string;
|
|
12214
|
+
/** Request body */
|
|
12215
|
+
resource: GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
12216
|
+
}): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
12217
|
+
create(
|
|
12218
|
+
request: {
|
|
12219
|
+
/** V1 error format. */
|
|
12220
|
+
'$.xgafv'?: string;
|
|
12221
|
+
/** OAuth access token. */
|
|
12222
|
+
access_token?: string;
|
|
12223
|
+
/** Data format for response. */
|
|
12224
|
+
alt?: string;
|
|
12225
|
+
/** JSONP */
|
|
12226
|
+
callback?: string;
|
|
12227
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12228
|
+
fields?: string;
|
|
12229
|
+
/** 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. */
|
|
12230
|
+
key?: string;
|
|
12231
|
+
/** OAuth 2.0 token for the current user. */
|
|
12232
|
+
oauth_token?: string;
|
|
12233
|
+
/** Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
12234
|
+
parent: string;
|
|
12235
|
+
/** Returns response with indentations and line breaks. */
|
|
12236
|
+
prettyPrint?: boolean;
|
|
12237
|
+
/** 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. */
|
|
12238
|
+
quotaUser?: string;
|
|
12239
|
+
/** Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. */
|
|
12240
|
+
servingConfigId?: string;
|
|
12241
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12242
|
+
upload_protocol?: string;
|
|
12243
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12244
|
+
uploadType?: string;
|
|
12245
|
+
},
|
|
12246
|
+
body: GoogleCloudDiscoveryengineV1betaServingConfig,
|
|
12247
|
+
): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
12096
12248
|
/** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
12097
12249
|
delete(request?: {
|
|
12098
12250
|
/** V1 error format. */
|
|
@@ -14729,6 +14881,68 @@ declare namespace gapi.client {
|
|
|
14729
14881
|
},
|
|
14730
14882
|
body: GoogleCloudDiscoveryengineV1betaAnswerQueryRequest,
|
|
14731
14883
|
): Request<GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>;
|
|
14884
|
+
/** Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned. */
|
|
14885
|
+
create(request: {
|
|
14886
|
+
/** V1 error format. */
|
|
14887
|
+
'$.xgafv'?: string;
|
|
14888
|
+
/** OAuth access token. */
|
|
14889
|
+
access_token?: string;
|
|
14890
|
+
/** Data format for response. */
|
|
14891
|
+
alt?: string;
|
|
14892
|
+
/** JSONP */
|
|
14893
|
+
callback?: string;
|
|
14894
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
14895
|
+
fields?: string;
|
|
14896
|
+
/** 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. */
|
|
14897
|
+
key?: string;
|
|
14898
|
+
/** OAuth 2.0 token for the current user. */
|
|
14899
|
+
oauth_token?: string;
|
|
14900
|
+
/** Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
14901
|
+
parent: string;
|
|
14902
|
+
/** Returns response with indentations and line breaks. */
|
|
14903
|
+
prettyPrint?: boolean;
|
|
14904
|
+
/** 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. */
|
|
14905
|
+
quotaUser?: string;
|
|
14906
|
+
/** Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. */
|
|
14907
|
+
servingConfigId?: string;
|
|
14908
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14909
|
+
upload_protocol?: string;
|
|
14910
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
14911
|
+
uploadType?: string;
|
|
14912
|
+
/** Request body */
|
|
14913
|
+
resource: GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
14914
|
+
}): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
14915
|
+
create(
|
|
14916
|
+
request: {
|
|
14917
|
+
/** V1 error format. */
|
|
14918
|
+
'$.xgafv'?: string;
|
|
14919
|
+
/** OAuth access token. */
|
|
14920
|
+
access_token?: string;
|
|
14921
|
+
/** Data format for response. */
|
|
14922
|
+
alt?: string;
|
|
14923
|
+
/** JSONP */
|
|
14924
|
+
callback?: string;
|
|
14925
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
14926
|
+
fields?: string;
|
|
14927
|
+
/** 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. */
|
|
14928
|
+
key?: string;
|
|
14929
|
+
/** OAuth 2.0 token for the current user. */
|
|
14930
|
+
oauth_token?: string;
|
|
14931
|
+
/** Required. Full resource name of parent. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` */
|
|
14932
|
+
parent: string;
|
|
14933
|
+
/** Returns response with indentations and line breaks. */
|
|
14934
|
+
prettyPrint?: boolean;
|
|
14935
|
+
/** 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. */
|
|
14936
|
+
quotaUser?: string;
|
|
14937
|
+
/** Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. */
|
|
14938
|
+
servingConfigId?: string;
|
|
14939
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
14940
|
+
upload_protocol?: string;
|
|
14941
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
14942
|
+
uploadType?: string;
|
|
14943
|
+
},
|
|
14944
|
+
body: GoogleCloudDiscoveryengineV1betaServingConfig,
|
|
14945
|
+
): Request<GoogleCloudDiscoveryengineV1betaServingConfig>;
|
|
14732
14946
|
/** Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. */
|
|
14733
14947
|
delete(request?: {
|
|
14734
14948
|
/** V1 error format. */
|