@google-cloud/discoveryengine 1.3.1 → 1.4.1
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +14 -0
- package/README.md +64 -0
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
- package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
- package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
- package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
- package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
- package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
- package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config.proto +49 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/acl_config_service.proto +79 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +72 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/chunk_service.proto +137 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +77 -4
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +44 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +6 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +44 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +80 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +83 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +127 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +6 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +13 -8
- package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +3 -2
- package/build/protos/google/cloud/discoveryengine/v1alpha/estimate_billing_service.proto +130 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +66 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +3 -1
- package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +74 -13
- package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +24 -20
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config.proto +271 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +147 -0
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +9 -3
- package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +7 -4
- package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +4 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
- package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +45 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +120 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +10 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +94 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +41 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +169 -15
- package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +151 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +265 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +148 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
- package/build/protos/protos.d.ts +48530 -23682
- package/build/protos/protos.js +122429 -63306
- package/build/protos/protos.json +13438 -7286
- package/build/src/index.d.ts +10 -1
- package/build/src/index.js +10 -1
- package/build/src/v1/completion_service_client.d.ts +489 -7
- package/build/src/v1/completion_service_client.js +715 -11
- package/build/src/v1/completion_service_client_config.json +10 -0
- package/build/src/v1/conversational_search_service_client.d.ts +341 -3
- package/build/src/v1/conversational_search_service_client.js +466 -9
- package/build/src/v1/data_store_service_client.d.ts +1286 -0
- package/build/src/v1/data_store_service_client.js +1768 -0
- package/build/src/v1/data_store_service_client_config.json +46 -0
- package/build/src/v1/document_service_client.d.ts +347 -2
- package/build/src/v1/document_service_client.js +506 -9
- package/build/src/v1/engine_service_client.d.ts +1211 -0
- package/build/src/v1/engine_service_client.js +1731 -0
- package/build/src/v1/engine_service_client_config.json +46 -0
- package/build/src/v1/index.d.ts +3 -0
- package/build/src/v1/index.js +7 -1
- package/build/src/v1/schema_service_client.d.ts +272 -2
- package/build/src/v1/schema_service_client.js +402 -9
- package/build/src/v1/search_service_client.d.ts +515 -11
- package/build/src/v1/search_service_client.js +648 -15
- package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
- package/build/src/v1/site_search_engine_service_client.js +2075 -0
- package/build/src/v1/site_search_engine_service_client_config.json +74 -0
- package/build/src/v1/user_event_service_client.d.ts +272 -2
- package/build/src/v1/user_event_service_client.js +402 -9
- package/build/src/v1alpha/acl_config_service_client.d.ts +1233 -0
- package/build/src/v1alpha/acl_config_service_client.js +1765 -0
- package/build/src/v1alpha/acl_config_service_client_config.json +34 -0
- package/build/src/v1alpha/chunk_service_client.d.ts +1350 -0
- package/build/src/v1alpha/chunk_service_client.js +1886 -0
- package/build/src/v1alpha/chunk_service_client_config.json +34 -0
- package/build/src/v1alpha/completion_service_client.d.ts +599 -5
- package/build/src/v1alpha/completion_service_client.js +868 -12
- package/build/src/v1alpha/completion_service_client_config.json +10 -0
- package/build/src/v1alpha/conversational_search_service_client.d.ts +244 -3
- package/build/src/v1alpha/conversational_search_service_client.js +353 -10
- package/build/src/v1alpha/data_store_service_client.d.ts +462 -5
- package/build/src/v1alpha/data_store_service_client.js +599 -12
- package/build/src/v1alpha/data_store_service_client_config.json +8 -0
- package/build/src/v1alpha/document_service_client.d.ts +393 -2
- package/build/src/v1alpha/document_service_client.js +551 -10
- package/build/src/v1alpha/engine_service_client.d.ts +386 -4
- package/build/src/v1alpha/engine_service_client.js +551 -10
- package/build/src/v1alpha/estimate_billing_service_client.d.ts +1367 -0
- package/build/src/v1alpha/estimate_billing_service_client.js +2028 -0
- package/build/src/v1alpha/estimate_billing_service_client_config.json +30 -0
- package/build/src/v1alpha/index.d.ts +4 -0
- package/build/src/v1alpha/index.js +10 -2
- package/build/src/v1alpha/recommendation_service_client.d.ts +242 -3
- package/build/src/v1alpha/recommendation_service_client.js +353 -10
- package/build/src/v1alpha/schema_service_client.d.ts +383 -2
- package/build/src/v1alpha/schema_service_client.js +551 -10
- package/build/src/v1alpha/search_service_client.d.ts +269 -17
- package/build/src/v1alpha/search_service_client.js +373 -20
- package/build/src/v1alpha/search_tuning_service_client.d.ts +384 -3
- package/build/src/v1alpha/search_tuning_service_client.js +551 -10
- package/build/src/v1alpha/serving_config_service_client.d.ts +1369 -0
- package/build/src/v1alpha/serving_config_service_client.js +1935 -0
- package/build/src/v1alpha/serving_config_service_client_config.json +38 -0
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +383 -2
- package/build/src/v1alpha/site_search_engine_service_client.js +551 -10
- package/build/src/v1alpha/user_event_service_client.d.ts +383 -2
- package/build/src/v1alpha/user_event_service_client.js +551 -10
- package/build/src/v1beta/completion_service_client.d.ts +708 -7
- package/build/src/v1beta/completion_service_client.js +1015 -11
- package/build/src/v1beta/completion_service_client_config.json +10 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +420 -3
- package/build/src/v1beta/conversational_search_service_client.js +570 -9
- package/build/src/v1beta/data_store_service_client.d.ts +1508 -0
- package/build/src/v1beta/data_store_service_client.js +2070 -0
- package/build/src/v1beta/data_store_service_client_config.json +46 -0
- package/build/src/v1beta/document_service_client.d.ts +566 -2
- package/build/src/v1beta/document_service_client.js +810 -11
- package/build/src/v1beta/engine_service_client.d.ts +1432 -0
- package/build/src/v1beta/engine_service_client.js +2032 -0
- package/build/src/v1beta/engine_service_client_config.json +46 -0
- package/build/src/v1beta/index.d.ts +5 -0
- package/build/src/v1beta/index.js +11 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +495 -5
- package/build/src/v1beta/recommendation_service_client.js +674 -9
- package/build/src/v1beta/schema_service_client.d.ts +491 -2
- package/build/src/v1beta/schema_service_client.js +706 -11
- package/build/src/v1beta/search_service_client.d.ts +620 -29
- package/build/src/v1beta/search_service_client.js +772 -27
- package/build/src/v1beta/search_tuning_service_client.d.ts +1196 -0
- package/build/src/v1beta/search_tuning_service_client.js +1781 -0
- package/build/src/v1beta/search_tuning_service_client_config.json +30 -0
- package/build/src/v1beta/serving_config_service_client.d.ts +1217 -0
- package/build/src/v1beta/serving_config_service_client.js +1724 -0
- package/build/src/v1beta/serving_config_service_client_config.json +38 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +1787 -0
- package/build/src/v1beta/site_search_engine_service_client.js +2375 -0
- package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
- package/build/src/v1beta/user_event_service_client.d.ts +491 -2
- package/build/src/v1beta/user_event_service_client.js +706 -11
- package/package.json +3 -3
@@ -16,6 +16,8 @@ export declare class SearchServiceClient {
|
|
16
16
|
private _gaxGrpc;
|
17
17
|
private _protos;
|
18
18
|
private _defaults;
|
19
|
+
private _universeDomain;
|
20
|
+
private _servicePath;
|
19
21
|
auth: gax.GoogleAuth;
|
20
22
|
descriptors: Descriptors;
|
21
23
|
warn: (code: string, message: string, warnType?: string) => void;
|
@@ -85,15 +87,22 @@ export declare class SearchServiceClient {
|
|
85
87
|
}>;
|
86
88
|
/**
|
87
89
|
* The DNS address for this API service.
|
90
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
88
91
|
* @returns {string} The DNS address for this service.
|
89
92
|
*/
|
90
93
|
static get servicePath(): string;
|
91
94
|
/**
|
92
|
-
* The DNS address for this API service - same as servicePath
|
93
|
-
*
|
95
|
+
* The DNS address for this API service - same as servicePath.
|
96
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
94
97
|
* @returns {string} The DNS address for this service.
|
95
98
|
*/
|
96
99
|
static get apiEndpoint(): string;
|
100
|
+
/**
|
101
|
+
* The DNS address for this API service.
|
102
|
+
* @returns {string} The DNS address for this service.
|
103
|
+
*/
|
104
|
+
get apiEndpoint(): string;
|
105
|
+
get universeDomain(): string;
|
97
106
|
/**
|
98
107
|
* The port for this API service.
|
99
108
|
* @returns {number} The default port for this service.
|
@@ -114,6 +123,8 @@ export declare class SearchServiceClient {
|
|
114
123
|
* The request object that will be sent.
|
115
124
|
* @param {string} request.servingConfig
|
116
125
|
* Required. The resource name of the Search serving config, such as
|
126
|
+
* `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
|
127
|
+
* or
|
117
128
|
* `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
|
118
129
|
* This field is used to identify the serving configuration name, set
|
119
130
|
* of models used to make the search.
|
@@ -151,17 +162,43 @@ export declare class SearchServiceClient {
|
|
151
162
|
* is unset.
|
152
163
|
*
|
153
164
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
165
|
+
* @param {number[]} request.dataStoreSpecs
|
166
|
+
* A list of data store specs to apply on a search call.
|
154
167
|
* @param {string} request.filter
|
155
168
|
* The filter syntax consists of an expression language for constructing a
|
156
169
|
* predicate from one or more fields of the documents being filtered. Filter
|
157
170
|
* expression is case-sensitive.
|
158
171
|
*
|
159
172
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
173
|
+
*
|
174
|
+
* Filtering in Vertex AI Search is done by mapping the LHS filter key to a
|
175
|
+
* key property defined in the Vertex AI Search backend -- this mapping is
|
176
|
+
* defined by the customer in their schema. For example a media customer might
|
177
|
+
* have a field 'name' in their schema. In this case the filter would look
|
178
|
+
* like this: filter --> name:'ANY("king kong")'
|
179
|
+
*
|
180
|
+
* For more information about filtering including syntax and filter
|
181
|
+
* operators, see
|
182
|
+
* [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
183
|
+
* @param {string} request.canonicalFilter
|
184
|
+
* The default filter that is applied when a user performs a search without
|
185
|
+
* checking any filters on the search page.
|
186
|
+
*
|
187
|
+
* The filter applied to every search request when quality improvement such as
|
188
|
+
* query expansion is needed. In the case a query does not have a sufficient
|
189
|
+
* amount of results this filter will be used to determine whether or not to
|
190
|
+
* enable the query expansion flow. The original filter will still be used for
|
191
|
+
* the query expanded search.
|
192
|
+
* This field is strongly recommended to achieve high search quality.
|
193
|
+
*
|
194
|
+
* For more information about filter syntax, see
|
195
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.filter|SearchRequest.filter}.
|
160
196
|
* @param {string} request.orderBy
|
161
197
|
* The order in which documents are returned. Documents can be ordered by
|
162
198
|
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
163
199
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
164
|
-
* case-sensitive.
|
200
|
+
* case-sensitive. For more information on ordering, see
|
201
|
+
* [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
|
165
202
|
*
|
166
203
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
167
204
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
@@ -176,6 +213,8 @@ export declare class SearchServiceClient {
|
|
176
213
|
* error is returned.
|
177
214
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
|
178
215
|
* Boost specification to boost certain documents.
|
216
|
+
* For more information on boosting, see
|
217
|
+
* [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
179
218
|
* @param {number[]} request.params
|
180
219
|
* Additional search parameters.
|
181
220
|
*
|
@@ -183,9 +222,17 @@ export declare class SearchServiceClient {
|
|
183
222
|
*
|
184
223
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
185
224
|
* are restricted or boosted based on the location provided.
|
225
|
+
* Example:
|
226
|
+
* user_country_code: "au"
|
227
|
+
*
|
228
|
+
* For available codes see [Country
|
229
|
+
* Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
|
230
|
+
*
|
186
231
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
187
|
-
*
|
188
|
-
*
|
232
|
+
* depending on the value. The only valid non-default value is 1,
|
233
|
+
* which enables image searching.
|
234
|
+
* Example:
|
235
|
+
* search_type: 1
|
189
236
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
190
237
|
* The query expansion specification that specifies the conditions under which
|
191
238
|
* query expansion occurs.
|
@@ -212,15 +259,17 @@ export declare class SearchServiceClient {
|
|
212
259
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec} request.embeddingSpec
|
213
260
|
* Uses the provided embedding to do additional semantic document retrieval.
|
214
261
|
* The retrieval is based on the dot product of
|
215
|
-
* {@link protos
|
216
|
-
* embedding that is provided in
|
217
|
-
* {@link protos
|
262
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
|
263
|
+
* and the document embedding that is provided in
|
264
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
|
218
265
|
*
|
219
|
-
* If
|
220
|
-
*
|
266
|
+
* If
|
267
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
|
268
|
+
* is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
|
221
269
|
* @param {string} request.rankingExpression
|
222
270
|
* The ranking expression controls the customized ranking on retrieval
|
223
|
-
* documents. This overrides
|
271
|
+
* documents. This overrides
|
272
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
224
273
|
* The ranking expression is a single function or multiple functions that are
|
225
274
|
* joint by "+".
|
226
275
|
* * ranking_expression = function, { " + ", function };
|
@@ -284,6 +333,8 @@ export declare class SearchServiceClient {
|
|
284
333
|
* The request object that will be sent.
|
285
334
|
* @param {string} request.servingConfig
|
286
335
|
* Required. The resource name of the Search serving config, such as
|
336
|
+
* `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
|
337
|
+
* or
|
287
338
|
* `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
|
288
339
|
* This field is used to identify the serving configuration name, set
|
289
340
|
* of models used to make the search.
|
@@ -321,17 +372,43 @@ export declare class SearchServiceClient {
|
|
321
372
|
* is unset.
|
322
373
|
*
|
323
374
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
375
|
+
* @param {number[]} request.dataStoreSpecs
|
376
|
+
* A list of data store specs to apply on a search call.
|
324
377
|
* @param {string} request.filter
|
325
378
|
* The filter syntax consists of an expression language for constructing a
|
326
379
|
* predicate from one or more fields of the documents being filtered. Filter
|
327
380
|
* expression is case-sensitive.
|
328
381
|
*
|
329
382
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
383
|
+
*
|
384
|
+
* Filtering in Vertex AI Search is done by mapping the LHS filter key to a
|
385
|
+
* key property defined in the Vertex AI Search backend -- this mapping is
|
386
|
+
* defined by the customer in their schema. For example a media customer might
|
387
|
+
* have a field 'name' in their schema. In this case the filter would look
|
388
|
+
* like this: filter --> name:'ANY("king kong")'
|
389
|
+
*
|
390
|
+
* For more information about filtering including syntax and filter
|
391
|
+
* operators, see
|
392
|
+
* [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
393
|
+
* @param {string} request.canonicalFilter
|
394
|
+
* The default filter that is applied when a user performs a search without
|
395
|
+
* checking any filters on the search page.
|
396
|
+
*
|
397
|
+
* The filter applied to every search request when quality improvement such as
|
398
|
+
* query expansion is needed. In the case a query does not have a sufficient
|
399
|
+
* amount of results this filter will be used to determine whether or not to
|
400
|
+
* enable the query expansion flow. The original filter will still be used for
|
401
|
+
* the query expanded search.
|
402
|
+
* This field is strongly recommended to achieve high search quality.
|
403
|
+
*
|
404
|
+
* For more information about filter syntax, see
|
405
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.filter|SearchRequest.filter}.
|
330
406
|
* @param {string} request.orderBy
|
331
407
|
* The order in which documents are returned. Documents can be ordered by
|
332
408
|
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
333
409
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
334
|
-
* case-sensitive.
|
410
|
+
* case-sensitive. For more information on ordering, see
|
411
|
+
* [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
|
335
412
|
*
|
336
413
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
337
414
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
@@ -346,6 +423,8 @@ export declare class SearchServiceClient {
|
|
346
423
|
* error is returned.
|
347
424
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
|
348
425
|
* Boost specification to boost certain documents.
|
426
|
+
* For more information on boosting, see
|
427
|
+
* [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
349
428
|
* @param {number[]} request.params
|
350
429
|
* Additional search parameters.
|
351
430
|
*
|
@@ -353,9 +432,17 @@ export declare class SearchServiceClient {
|
|
353
432
|
*
|
354
433
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
355
434
|
* are restricted or boosted based on the location provided.
|
435
|
+
* Example:
|
436
|
+
* user_country_code: "au"
|
437
|
+
*
|
438
|
+
* For available codes see [Country
|
439
|
+
* Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
|
440
|
+
*
|
356
441
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
357
|
-
*
|
358
|
-
*
|
442
|
+
* depending on the value. The only valid non-default value is 1,
|
443
|
+
* which enables image searching.
|
444
|
+
* Example:
|
445
|
+
* search_type: 1
|
359
446
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
360
447
|
* The query expansion specification that specifies the conditions under which
|
361
448
|
* query expansion occurs.
|
@@ -382,15 +469,17 @@ export declare class SearchServiceClient {
|
|
382
469
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec} request.embeddingSpec
|
383
470
|
* Uses the provided embedding to do additional semantic document retrieval.
|
384
471
|
* The retrieval is based on the dot product of
|
385
|
-
* {@link protos
|
386
|
-
* embedding that is provided in
|
387
|
-
* {@link protos
|
472
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
|
473
|
+
* and the document embedding that is provided in
|
474
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
|
388
475
|
*
|
389
|
-
* If
|
390
|
-
*
|
476
|
+
* If
|
477
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
|
478
|
+
* is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
|
391
479
|
* @param {string} request.rankingExpression
|
392
480
|
* The ranking expression controls the customized ranking on retrieval
|
393
|
-
* documents. This overrides
|
481
|
+
* documents. This overrides
|
482
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
394
483
|
* The ranking expression is a single function or multiple functions that are
|
395
484
|
* joint by "+".
|
396
485
|
* * ranking_expression = function, { " + ", function };
|
@@ -449,6 +538,8 @@ export declare class SearchServiceClient {
|
|
449
538
|
* The request object that will be sent.
|
450
539
|
* @param {string} request.servingConfig
|
451
540
|
* Required. The resource name of the Search serving config, such as
|
541
|
+
* `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
|
542
|
+
* or
|
452
543
|
* `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
|
453
544
|
* This field is used to identify the serving configuration name, set
|
454
545
|
* of models used to make the search.
|
@@ -486,17 +577,43 @@ export declare class SearchServiceClient {
|
|
486
577
|
* is unset.
|
487
578
|
*
|
488
579
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
580
|
+
* @param {number[]} request.dataStoreSpecs
|
581
|
+
* A list of data store specs to apply on a search call.
|
489
582
|
* @param {string} request.filter
|
490
583
|
* The filter syntax consists of an expression language for constructing a
|
491
584
|
* predicate from one or more fields of the documents being filtered. Filter
|
492
585
|
* expression is case-sensitive.
|
493
586
|
*
|
494
587
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
588
|
+
*
|
589
|
+
* Filtering in Vertex AI Search is done by mapping the LHS filter key to a
|
590
|
+
* key property defined in the Vertex AI Search backend -- this mapping is
|
591
|
+
* defined by the customer in their schema. For example a media customer might
|
592
|
+
* have a field 'name' in their schema. In this case the filter would look
|
593
|
+
* like this: filter --> name:'ANY("king kong")'
|
594
|
+
*
|
595
|
+
* For more information about filtering including syntax and filter
|
596
|
+
* operators, see
|
597
|
+
* [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
598
|
+
* @param {string} request.canonicalFilter
|
599
|
+
* The default filter that is applied when a user performs a search without
|
600
|
+
* checking any filters on the search page.
|
601
|
+
*
|
602
|
+
* The filter applied to every search request when quality improvement such as
|
603
|
+
* query expansion is needed. In the case a query does not have a sufficient
|
604
|
+
* amount of results this filter will be used to determine whether or not to
|
605
|
+
* enable the query expansion flow. The original filter will still be used for
|
606
|
+
* the query expanded search.
|
607
|
+
* This field is strongly recommended to achieve high search quality.
|
608
|
+
*
|
609
|
+
* For more information about filter syntax, see
|
610
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.filter|SearchRequest.filter}.
|
495
611
|
* @param {string} request.orderBy
|
496
612
|
* The order in which documents are returned. Documents can be ordered by
|
497
613
|
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
498
614
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
499
|
-
* case-sensitive.
|
615
|
+
* case-sensitive. For more information on ordering, see
|
616
|
+
* [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
|
500
617
|
*
|
501
618
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
502
619
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
@@ -511,6 +628,8 @@ export declare class SearchServiceClient {
|
|
511
628
|
* error is returned.
|
512
629
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
|
513
630
|
* Boost specification to boost certain documents.
|
631
|
+
* For more information on boosting, see
|
632
|
+
* [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
514
633
|
* @param {number[]} request.params
|
515
634
|
* Additional search parameters.
|
516
635
|
*
|
@@ -518,9 +637,17 @@ export declare class SearchServiceClient {
|
|
518
637
|
*
|
519
638
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
520
639
|
* are restricted or boosted based on the location provided.
|
640
|
+
* Example:
|
641
|
+
* user_country_code: "au"
|
642
|
+
*
|
643
|
+
* For available codes see [Country
|
644
|
+
* Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
|
645
|
+
*
|
521
646
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
522
|
-
*
|
523
|
-
*
|
647
|
+
* depending on the value. The only valid non-default value is 1,
|
648
|
+
* which enables image searching.
|
649
|
+
* Example:
|
650
|
+
* search_type: 1
|
524
651
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
525
652
|
* The query expansion specification that specifies the conditions under which
|
526
653
|
* query expansion occurs.
|
@@ -547,15 +674,17 @@ export declare class SearchServiceClient {
|
|
547
674
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec} request.embeddingSpec
|
548
675
|
* Uses the provided embedding to do additional semantic document retrieval.
|
549
676
|
* The retrieval is based on the dot product of
|
550
|
-
* {@link protos
|
551
|
-
* embedding that is provided in
|
552
|
-
* {@link protos
|
677
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
|
678
|
+
* and the document embedding that is provided in
|
679
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
|
553
680
|
*
|
554
|
-
* If
|
555
|
-
*
|
681
|
+
* If
|
682
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
|
683
|
+
* is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
|
556
684
|
* @param {string} request.rankingExpression
|
557
685
|
* The ranking expression controls the customized ranking on retrieval
|
558
|
-
* documents. This overrides
|
686
|
+
* documents. This overrides
|
687
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
559
688
|
* The ranking expression is a single function or multiple functions that are
|
560
689
|
* joint by "+".
|
561
690
|
* * ranking_expression = function, { " + ", function };
|
@@ -658,6 +787,90 @@ export declare class SearchServiceClient {
|
|
658
787
|
* ```
|
659
788
|
*/
|
660
789
|
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
790
|
+
/**
|
791
|
+
* Return a fully-qualified engine resource name string.
|
792
|
+
*
|
793
|
+
* @param {string} project
|
794
|
+
* @param {string} location
|
795
|
+
* @param {string} collection
|
796
|
+
* @param {string} engine
|
797
|
+
* @returns {string} Resource name string.
|
798
|
+
*/
|
799
|
+
enginePath(project: string, location: string, collection: string, engine: string): string;
|
800
|
+
/**
|
801
|
+
* Parse the project from Engine resource.
|
802
|
+
*
|
803
|
+
* @param {string} engineName
|
804
|
+
* A fully-qualified path representing Engine resource.
|
805
|
+
* @returns {string} A string representing the project.
|
806
|
+
*/
|
807
|
+
matchProjectFromEngineName(engineName: string): string | number;
|
808
|
+
/**
|
809
|
+
* Parse the location from Engine resource.
|
810
|
+
*
|
811
|
+
* @param {string} engineName
|
812
|
+
* A fully-qualified path representing Engine resource.
|
813
|
+
* @returns {string} A string representing the location.
|
814
|
+
*/
|
815
|
+
matchLocationFromEngineName(engineName: string): string | number;
|
816
|
+
/**
|
817
|
+
* Parse the collection from Engine resource.
|
818
|
+
*
|
819
|
+
* @param {string} engineName
|
820
|
+
* A fully-qualified path representing Engine resource.
|
821
|
+
* @returns {string} A string representing the collection.
|
822
|
+
*/
|
823
|
+
matchCollectionFromEngineName(engineName: string): string | number;
|
824
|
+
/**
|
825
|
+
* Parse the engine from Engine resource.
|
826
|
+
*
|
827
|
+
* @param {string} engineName
|
828
|
+
* A fully-qualified path representing Engine resource.
|
829
|
+
* @returns {string} A string representing the engine.
|
830
|
+
*/
|
831
|
+
matchEngineFromEngineName(engineName: string): string | number;
|
832
|
+
/**
|
833
|
+
* Return a fully-qualified projectLocationCollectionDataStore resource name string.
|
834
|
+
*
|
835
|
+
* @param {string} project
|
836
|
+
* @param {string} location
|
837
|
+
* @param {string} collection
|
838
|
+
* @param {string} data_store
|
839
|
+
* @returns {string} Resource name string.
|
840
|
+
*/
|
841
|
+
projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
|
842
|
+
/**
|
843
|
+
* Parse the project from ProjectLocationCollectionDataStore resource.
|
844
|
+
*
|
845
|
+
* @param {string} projectLocationCollectionDataStoreName
|
846
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
847
|
+
* @returns {string} A string representing the project.
|
848
|
+
*/
|
849
|
+
matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
850
|
+
/**
|
851
|
+
* Parse the location from ProjectLocationCollectionDataStore resource.
|
852
|
+
*
|
853
|
+
* @param {string} projectLocationCollectionDataStoreName
|
854
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
855
|
+
* @returns {string} A string representing the location.
|
856
|
+
*/
|
857
|
+
matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
858
|
+
/**
|
859
|
+
* Parse the collection from ProjectLocationCollectionDataStore resource.
|
860
|
+
*
|
861
|
+
* @param {string} projectLocationCollectionDataStoreName
|
862
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
863
|
+
* @returns {string} A string representing the collection.
|
864
|
+
*/
|
865
|
+
matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
866
|
+
/**
|
867
|
+
* Parse the data_store from ProjectLocationCollectionDataStore resource.
|
868
|
+
*
|
869
|
+
* @param {string} projectLocationCollectionDataStoreName
|
870
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
871
|
+
* @returns {string} A string representing the data_store.
|
872
|
+
*/
|
873
|
+
matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
|
661
874
|
/**
|
662
875
|
* Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
|
663
876
|
*
|
@@ -820,6 +1033,48 @@ export declare class SearchServiceClient {
|
|
820
1033
|
* @returns {string} A string representing the conversation.
|
821
1034
|
*/
|
822
1035
|
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
1036
|
+
/**
|
1037
|
+
* Return a fully-qualified projectLocationCollectionDataStoreDocumentProcessingConfig resource name string.
|
1038
|
+
*
|
1039
|
+
* @param {string} project
|
1040
|
+
* @param {string} location
|
1041
|
+
* @param {string} collection
|
1042
|
+
* @param {string} data_store
|
1043
|
+
* @returns {string} Resource name string.
|
1044
|
+
*/
|
1045
|
+
projectLocationCollectionDataStoreDocumentProcessingConfigPath(project: string, location: string, collection: string, dataStore: string): string;
|
1046
|
+
/**
|
1047
|
+
* Parse the project from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
|
1048
|
+
*
|
1049
|
+
* @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
|
1050
|
+
* A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
|
1051
|
+
* @returns {string} A string representing the project.
|
1052
|
+
*/
|
1053
|
+
matchProjectFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;
|
1054
|
+
/**
|
1055
|
+
* Parse the location from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
|
1056
|
+
*
|
1057
|
+
* @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
|
1058
|
+
* A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
|
1059
|
+
* @returns {string} A string representing the location.
|
1060
|
+
*/
|
1061
|
+
matchLocationFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;
|
1062
|
+
/**
|
1063
|
+
* Parse the collection from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
|
1064
|
+
*
|
1065
|
+
* @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
|
1066
|
+
* A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
|
1067
|
+
* @returns {string} A string representing the collection.
|
1068
|
+
*/
|
1069
|
+
matchCollectionFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;
|
1070
|
+
/**
|
1071
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreDocumentProcessingConfig resource.
|
1072
|
+
*
|
1073
|
+
* @param {string} projectLocationCollectionDataStoreDocumentProcessingConfigName
|
1074
|
+
* A fully-qualified path representing project_location_collection_data_store_documentProcessingConfig resource.
|
1075
|
+
* @returns {string} A string representing the data_store.
|
1076
|
+
*/
|
1077
|
+
matchDataStoreFromProjectLocationCollectionDataStoreDocumentProcessingConfigName(projectLocationCollectionDataStoreDocumentProcessingConfigName: string): string | number;
|
823
1078
|
/**
|
824
1079
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
825
1080
|
*
|
@@ -922,6 +1177,234 @@ export declare class SearchServiceClient {
|
|
922
1177
|
* @returns {string} A string representing the serving_config.
|
923
1178
|
*/
|
924
1179
|
matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
|
1180
|
+
/**
|
1181
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
|
1182
|
+
*
|
1183
|
+
* @param {string} project
|
1184
|
+
* @param {string} location
|
1185
|
+
* @param {string} collection
|
1186
|
+
* @param {string} data_store
|
1187
|
+
* @returns {string} Resource name string.
|
1188
|
+
*/
|
1189
|
+
projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
|
1190
|
+
/**
|
1191
|
+
* Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
|
1192
|
+
*
|
1193
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
|
1194
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
|
1195
|
+
* @returns {string} A string representing the project.
|
1196
|
+
*/
|
1197
|
+
matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
|
1198
|
+
/**
|
1199
|
+
* Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
|
1200
|
+
*
|
1201
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
|
1202
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
|
1203
|
+
* @returns {string} A string representing the location.
|
1204
|
+
*/
|
1205
|
+
matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
|
1206
|
+
/**
|
1207
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
|
1208
|
+
*
|
1209
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
|
1210
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
|
1211
|
+
* @returns {string} A string representing the collection.
|
1212
|
+
*/
|
1213
|
+
matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
|
1214
|
+
/**
|
1215
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
|
1216
|
+
*
|
1217
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
|
1218
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
|
1219
|
+
* @returns {string} A string representing the data_store.
|
1220
|
+
*/
|
1221
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
|
1222
|
+
/**
|
1223
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
|
1224
|
+
*
|
1225
|
+
* @param {string} project
|
1226
|
+
* @param {string} location
|
1227
|
+
* @param {string} collection
|
1228
|
+
* @param {string} data_store
|
1229
|
+
* @param {string} target_site
|
1230
|
+
* @returns {string} Resource name string.
|
1231
|
+
*/
|
1232
|
+
projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
|
1233
|
+
/**
|
1234
|
+
* Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1235
|
+
*
|
1236
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1237
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1238
|
+
* @returns {string} A string representing the project.
|
1239
|
+
*/
|
1240
|
+
matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1241
|
+
/**
|
1242
|
+
* Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1243
|
+
*
|
1244
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1245
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1246
|
+
* @returns {string} A string representing the location.
|
1247
|
+
*/
|
1248
|
+
matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1249
|
+
/**
|
1250
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1251
|
+
*
|
1252
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1253
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1254
|
+
* @returns {string} A string representing the collection.
|
1255
|
+
*/
|
1256
|
+
matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1257
|
+
/**
|
1258
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1259
|
+
*
|
1260
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1261
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1262
|
+
* @returns {string} A string representing the data_store.
|
1263
|
+
*/
|
1264
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1265
|
+
/**
|
1266
|
+
* Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1267
|
+
*
|
1268
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1269
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1270
|
+
* @returns {string} A string representing the target_site.
|
1271
|
+
*/
|
1272
|
+
matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1273
|
+
/**
|
1274
|
+
* Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
|
1275
|
+
*
|
1276
|
+
* @param {string} project
|
1277
|
+
* @param {string} location
|
1278
|
+
* @param {string} collection
|
1279
|
+
* @param {string} engine
|
1280
|
+
* @param {string} conversation
|
1281
|
+
* @returns {string} Resource name string.
|
1282
|
+
*/
|
1283
|
+
projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
|
1284
|
+
/**
|
1285
|
+
* Parse the project from ProjectLocationCollectionEngineConversation resource.
|
1286
|
+
*
|
1287
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1288
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1289
|
+
* @returns {string} A string representing the project.
|
1290
|
+
*/
|
1291
|
+
matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
|
1292
|
+
/**
|
1293
|
+
* Parse the location from ProjectLocationCollectionEngineConversation resource.
|
1294
|
+
*
|
1295
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1296
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1297
|
+
* @returns {string} A string representing the location.
|
1298
|
+
*/
|
1299
|
+
matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
|
1300
|
+
/**
|
1301
|
+
* Parse the collection from ProjectLocationCollectionEngineConversation resource.
|
1302
|
+
*
|
1303
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1304
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1305
|
+
* @returns {string} A string representing the collection.
|
1306
|
+
*/
|
1307
|
+
matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
|
1308
|
+
/**
|
1309
|
+
* Parse the engine from ProjectLocationCollectionEngineConversation resource.
|
1310
|
+
*
|
1311
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1312
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1313
|
+
* @returns {string} A string representing the engine.
|
1314
|
+
*/
|
1315
|
+
matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
|
1316
|
+
/**
|
1317
|
+
* Parse the conversation from ProjectLocationCollectionEngineConversation resource.
|
1318
|
+
*
|
1319
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1320
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1321
|
+
* @returns {string} A string representing the conversation.
|
1322
|
+
*/
|
1323
|
+
matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
|
1324
|
+
/**
|
1325
|
+
* Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
|
1326
|
+
*
|
1327
|
+
* @param {string} project
|
1328
|
+
* @param {string} location
|
1329
|
+
* @param {string} collection
|
1330
|
+
* @param {string} engine
|
1331
|
+
* @param {string} serving_config
|
1332
|
+
* @returns {string} Resource name string.
|
1333
|
+
*/
|
1334
|
+
projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
|
1335
|
+
/**
|
1336
|
+
* Parse the project from ProjectLocationCollectionEngineServingConfig resource.
|
1337
|
+
*
|
1338
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1339
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1340
|
+
* @returns {string} A string representing the project.
|
1341
|
+
*/
|
1342
|
+
matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
1343
|
+
/**
|
1344
|
+
* Parse the location from ProjectLocationCollectionEngineServingConfig resource.
|
1345
|
+
*
|
1346
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1347
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1348
|
+
* @returns {string} A string representing the location.
|
1349
|
+
*/
|
1350
|
+
matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
1351
|
+
/**
|
1352
|
+
* Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
|
1353
|
+
*
|
1354
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1355
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1356
|
+
* @returns {string} A string representing the collection.
|
1357
|
+
*/
|
1358
|
+
matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
1359
|
+
/**
|
1360
|
+
* Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
|
1361
|
+
*
|
1362
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1363
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1364
|
+
* @returns {string} A string representing the engine.
|
1365
|
+
*/
|
1366
|
+
matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
1367
|
+
/**
|
1368
|
+
* Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
|
1369
|
+
*
|
1370
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1371
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1372
|
+
* @returns {string} A string representing the serving_config.
|
1373
|
+
*/
|
1374
|
+
matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
|
1375
|
+
/**
|
1376
|
+
* Return a fully-qualified projectLocationDataStore resource name string.
|
1377
|
+
*
|
1378
|
+
* @param {string} project
|
1379
|
+
* @param {string} location
|
1380
|
+
* @param {string} data_store
|
1381
|
+
* @returns {string} Resource name string.
|
1382
|
+
*/
|
1383
|
+
projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
|
1384
|
+
/**
|
1385
|
+
* Parse the project from ProjectLocationDataStore resource.
|
1386
|
+
*
|
1387
|
+
* @param {string} projectLocationDataStoreName
|
1388
|
+
* A fully-qualified path representing project_location_data_store resource.
|
1389
|
+
* @returns {string} A string representing the project.
|
1390
|
+
*/
|
1391
|
+
matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
1392
|
+
/**
|
1393
|
+
* Parse the location from ProjectLocationDataStore resource.
|
1394
|
+
*
|
1395
|
+
* @param {string} projectLocationDataStoreName
|
1396
|
+
* A fully-qualified path representing project_location_data_store resource.
|
1397
|
+
* @returns {string} A string representing the location.
|
1398
|
+
*/
|
1399
|
+
matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
1400
|
+
/**
|
1401
|
+
* Parse the data_store from ProjectLocationDataStore resource.
|
1402
|
+
*
|
1403
|
+
* @param {string} projectLocationDataStoreName
|
1404
|
+
* A fully-qualified path representing project_location_data_store resource.
|
1405
|
+
* @returns {string} A string representing the data_store.
|
1406
|
+
*/
|
1407
|
+
matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
|
925
1408
|
/**
|
926
1409
|
* Return a fully-qualified projectLocationDataStoreBranch resource name string.
|
927
1410
|
*
|
@@ -1057,6 +1540,39 @@ export declare class SearchServiceClient {
|
|
1057
1540
|
* @returns {string} A string representing the conversation.
|
1058
1541
|
*/
|
1059
1542
|
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
1543
|
+
/**
|
1544
|
+
* Return a fully-qualified projectLocationDataStoreDocumentProcessingConfig resource name string.
|
1545
|
+
*
|
1546
|
+
* @param {string} project
|
1547
|
+
* @param {string} location
|
1548
|
+
* @param {string} data_store
|
1549
|
+
* @returns {string} Resource name string.
|
1550
|
+
*/
|
1551
|
+
projectLocationDataStoreDocumentProcessingConfigPath(project: string, location: string, dataStore: string): string;
|
1552
|
+
/**
|
1553
|
+
* Parse the project from ProjectLocationDataStoreDocumentProcessingConfig resource.
|
1554
|
+
*
|
1555
|
+
* @param {string} projectLocationDataStoreDocumentProcessingConfigName
|
1556
|
+
* A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
|
1557
|
+
* @returns {string} A string representing the project.
|
1558
|
+
*/
|
1559
|
+
matchProjectFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;
|
1560
|
+
/**
|
1561
|
+
* Parse the location from ProjectLocationDataStoreDocumentProcessingConfig resource.
|
1562
|
+
*
|
1563
|
+
* @param {string} projectLocationDataStoreDocumentProcessingConfigName
|
1564
|
+
* A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
|
1565
|
+
* @returns {string} A string representing the location.
|
1566
|
+
*/
|
1567
|
+
matchLocationFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;
|
1568
|
+
/**
|
1569
|
+
* Parse the data_store from ProjectLocationDataStoreDocumentProcessingConfig resource.
|
1570
|
+
*
|
1571
|
+
* @param {string} projectLocationDataStoreDocumentProcessingConfigName
|
1572
|
+
* A fully-qualified path representing project_location_data_store_documentProcessingConfig resource.
|
1573
|
+
* @returns {string} A string representing the data_store.
|
1574
|
+
*/
|
1575
|
+
matchDataStoreFromProjectLocationDataStoreDocumentProcessingConfigName(projectLocationDataStoreDocumentProcessingConfigName: string): string | number;
|
1060
1576
|
/**
|
1061
1577
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
1062
1578
|
*
|
@@ -1141,6 +1657,81 @@ export declare class SearchServiceClient {
|
|
1141
1657
|
* @returns {string} A string representing the serving_config.
|
1142
1658
|
*/
|
1143
1659
|
matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
|
1660
|
+
/**
|
1661
|
+
* Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
|
1662
|
+
*
|
1663
|
+
* @param {string} project
|
1664
|
+
* @param {string} location
|
1665
|
+
* @param {string} data_store
|
1666
|
+
* @returns {string} Resource name string.
|
1667
|
+
*/
|
1668
|
+
projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
|
1669
|
+
/**
|
1670
|
+
* Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
|
1671
|
+
*
|
1672
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineName
|
1673
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
|
1674
|
+
* @returns {string} A string representing the project.
|
1675
|
+
*/
|
1676
|
+
matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
|
1677
|
+
/**
|
1678
|
+
* Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
|
1679
|
+
*
|
1680
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineName
|
1681
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
|
1682
|
+
* @returns {string} A string representing the location.
|
1683
|
+
*/
|
1684
|
+
matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
|
1685
|
+
/**
|
1686
|
+
* Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
|
1687
|
+
*
|
1688
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineName
|
1689
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
|
1690
|
+
* @returns {string} A string representing the data_store.
|
1691
|
+
*/
|
1692
|
+
matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
|
1693
|
+
/**
|
1694
|
+
* Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
|
1695
|
+
*
|
1696
|
+
* @param {string} project
|
1697
|
+
* @param {string} location
|
1698
|
+
* @param {string} data_store
|
1699
|
+
* @param {string} target_site
|
1700
|
+
* @returns {string} Resource name string.
|
1701
|
+
*/
|
1702
|
+
projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
|
1703
|
+
/**
|
1704
|
+
* Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1705
|
+
*
|
1706
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1707
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1708
|
+
* @returns {string} A string representing the project.
|
1709
|
+
*/
|
1710
|
+
matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1711
|
+
/**
|
1712
|
+
* Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1713
|
+
*
|
1714
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1715
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1716
|
+
* @returns {string} A string representing the location.
|
1717
|
+
*/
|
1718
|
+
matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1719
|
+
/**
|
1720
|
+
* Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1721
|
+
*
|
1722
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1723
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1724
|
+
* @returns {string} A string representing the data_store.
|
1725
|
+
*/
|
1726
|
+
matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1727
|
+
/**
|
1728
|
+
* Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1729
|
+
*
|
1730
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1731
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1732
|
+
* @returns {string} A string representing the target_site.
|
1733
|
+
*/
|
1734
|
+
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
|
1144
1735
|
/**
|
1145
1736
|
* Terminate the gRPC channel and close the client.
|
1146
1737
|
*
|