@google-cloud/discoveryengine 1.3.1 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +7 -0
- package/README.md +51 -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/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 +40 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +98 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
- 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 +38 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +150 -11
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +264 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +147 -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 +41157 -23655
- package/build/protos/protos.js +103188 -62466
- package/build/protos/protos.json +10400 -6075
- 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/completion_service_client.d.ts +11 -2
- package/build/src/v1alpha/completion_service_client.js +37 -10
- package/build/src/v1alpha/conversational_search_service_client.d.ts +11 -2
- package/build/src/v1alpha/conversational_search_service_client.js +37 -10
- package/build/src/v1alpha/data_store_service_client.d.ts +11 -2
- package/build/src/v1alpha/data_store_service_client.js +37 -10
- package/build/src/v1alpha/document_service_client.d.ts +11 -2
- package/build/src/v1alpha/document_service_client.js +37 -10
- package/build/src/v1alpha/engine_service_client.d.ts +11 -2
- package/build/src/v1alpha/engine_service_client.js +37 -10
- package/build/src/v1alpha/index.js +1 -1
- package/build/src/v1alpha/recommendation_service_client.d.ts +11 -2
- package/build/src/v1alpha/recommendation_service_client.js +37 -10
- package/build/src/v1alpha/schema_service_client.d.ts +11 -2
- package/build/src/v1alpha/schema_service_client.js +37 -10
- package/build/src/v1alpha/search_service_client.d.ts +11 -2
- package/build/src/v1alpha/search_service_client.js +37 -10
- package/build/src/v1alpha/search_tuning_service_client.d.ts +11 -2
- package/build/src/v1alpha/search_tuning_service_client.js +37 -10
- package/build/src/v1alpha/site_search_engine_service_client.d.ts +11 -2
- package/build/src/v1alpha/site_search_engine_service_client.js +37 -10
- package/build/src/v1alpha/user_event_service_client.d.ts +11 -2
- package/build/src/v1alpha/user_event_service_client.js +37 -10
- package/build/src/v1beta/completion_service_client.d.ts +633 -7
- package/build/src/v1beta/completion_service_client.js +911 -11
- package/build/src/v1beta/completion_service_client_config.json +10 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +341 -3
- package/build/src/v1beta/conversational_search_service_client.js +466 -9
- package/build/src/v1beta/data_store_service_client.d.ts +1433 -0
- package/build/src/v1beta/data_store_service_client.js +1966 -0
- package/build/src/v1beta/data_store_service_client_config.json +46 -0
- package/build/src/v1beta/document_service_client.d.ts +491 -2
- package/build/src/v1beta/document_service_client.js +706 -11
- package/build/src/v1beta/engine_service_client.d.ts +1357 -0
- package/build/src/v1beta/engine_service_client.js +1928 -0
- package/build/src/v1beta/engine_service_client_config.json +46 -0
- package/build/src/v1beta/index.d.ts +4 -0
- package/build/src/v1beta/index.js +9 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +420 -5
- package/build/src/v1beta/recommendation_service_client.js +570 -9
- package/build/src/v1beta/schema_service_client.d.ts +416 -2
- package/build/src/v1beta/schema_service_client.js +602 -11
- package/build/src/v1beta/search_service_client.d.ts +539 -29
- package/build/src/v1beta/search_service_client.js +664 -27
- package/build/src/v1beta/serving_config_service_client.d.ts +1102 -0
- package/build/src/v1beta/serving_config_service_client.js +1563 -0
- package/build/src/v1beta/serving_config_service_client_config.json +38 -0
- package/build/src/v1beta/site_search_engine_service_client.d.ts +1712 -0
- package/build/src/v1beta/site_search_engine_service_client.js +2271 -0
- package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
- package/build/src/v1beta/user_event_service_client.d.ts +416 -2
- package/build/src/v1beta/user_event_service_client.js +602 -11
- package/package.json +2 -2
@@ -72,7 +72,7 @@ class SearchServiceClient {
|
|
72
72
|
* ```
|
73
73
|
*/
|
74
74
|
constructor(opts, gaxInstance) {
|
75
|
-
var _a, _b;
|
75
|
+
var _a, _b, _c, _d;
|
76
76
|
this._terminated = false;
|
77
77
|
this.descriptors = {
|
78
78
|
page: {},
|
@@ -82,16 +82,24 @@ class SearchServiceClient {
|
|
82
82
|
};
|
83
83
|
// Ensure that options include all the required fields.
|
84
84
|
const staticMembers = this.constructor;
|
85
|
-
|
85
|
+
if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
|
86
|
+
(opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
|
87
|
+
(opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
|
88
|
+
throw new Error('Please set either universe_domain or universeDomain, but not both.');
|
89
|
+
}
|
90
|
+
this._universeDomain =
|
91
|
+
(_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : 'googleapis.com';
|
92
|
+
this._servicePath = 'discoveryengine.' + this._universeDomain;
|
93
|
+
const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
|
86
94
|
this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
|
87
95
|
const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
|
88
|
-
const clientConfig = (
|
89
|
-
const fallback = (
|
96
|
+
const clientConfig = (_c = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _c !== void 0 ? _c : {};
|
97
|
+
const fallback = (_d = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _d !== void 0 ? _d : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
|
90
98
|
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
|
91
99
|
// Request numeric enum values if REST transport is used.
|
92
100
|
opts.numericEnums = true;
|
93
101
|
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
|
94
|
-
if (servicePath !==
|
102
|
+
if (servicePath !== this._servicePath && !('scopes' in opts)) {
|
95
103
|
opts['scopes'] = staticMembers.scopes;
|
96
104
|
}
|
97
105
|
// Load google-gax module synchronously if needed
|
@@ -109,9 +117,9 @@ class SearchServiceClient {
|
|
109
117
|
// Set useJWTAccessWithScope on the auth object.
|
110
118
|
this.auth.useJWTAccessWithScope = true;
|
111
119
|
// Set defaultServicePath on the auth object.
|
112
|
-
this.auth.defaultServicePath =
|
120
|
+
this.auth.defaultServicePath = this._servicePath;
|
113
121
|
// Set the default scopes in auth client if needed.
|
114
|
-
if (servicePath ===
|
122
|
+
if (servicePath === this._servicePath) {
|
115
123
|
this.auth.defaultScopes = staticMembers.scopes;
|
116
124
|
}
|
117
125
|
this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
|
@@ -138,16 +146,25 @@ class SearchServiceClient {
|
|
138
146
|
// identifiers to uniquely identify resources within the API.
|
139
147
|
// Create useful helper objects for these.
|
140
148
|
this.pathTemplates = {
|
149
|
+
enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
|
150
|
+
projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
|
141
151
|
projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
|
142
152
|
projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
143
153
|
projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
|
144
154
|
projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
|
145
155
|
projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
|
156
|
+
projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
|
157
|
+
projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
158
|
+
projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
|
159
|
+
projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
|
160
|
+
projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
|
146
161
|
projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
|
147
162
|
projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
148
163
|
projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
|
149
164
|
projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
|
150
165
|
projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
|
166
|
+
projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
|
167
|
+
projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
|
151
168
|
};
|
152
169
|
// Some of the methods on this service return "paged" results,
|
153
170
|
// (e.g. 50 results at a time, with tokens to get subsequent
|
@@ -208,19 +225,38 @@ class SearchServiceClient {
|
|
208
225
|
}
|
209
226
|
/**
|
210
227
|
* The DNS address for this API service.
|
228
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
211
229
|
* @returns {string} The DNS address for this service.
|
212
230
|
*/
|
213
231
|
static get servicePath() {
|
232
|
+
if (typeof process !== undefined &&
|
233
|
+
typeof process.emitWarning === 'function') {
|
234
|
+
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
|
235
|
+
}
|
214
236
|
return 'discoveryengine.googleapis.com';
|
215
237
|
}
|
216
238
|
/**
|
217
|
-
* The DNS address for this API service - same as servicePath
|
218
|
-
*
|
239
|
+
* The DNS address for this API service - same as servicePath.
|
240
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
219
241
|
* @returns {string} The DNS address for this service.
|
220
242
|
*/
|
221
243
|
static get apiEndpoint() {
|
244
|
+
if (typeof process !== undefined &&
|
245
|
+
typeof process.emitWarning === 'function') {
|
246
|
+
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
|
247
|
+
}
|
222
248
|
return 'discoveryengine.googleapis.com';
|
223
249
|
}
|
250
|
+
/**
|
251
|
+
* The DNS address for this API service.
|
252
|
+
* @returns {string} The DNS address for this service.
|
253
|
+
*/
|
254
|
+
get apiEndpoint() {
|
255
|
+
return this._servicePath;
|
256
|
+
}
|
257
|
+
get universeDomain() {
|
258
|
+
return this._universeDomain;
|
259
|
+
}
|
224
260
|
/**
|
225
261
|
* The port for this API service.
|
226
262
|
* @returns {number} The default port for this service.
|
@@ -274,6 +310,8 @@ class SearchServiceClient {
|
|
274
310
|
* The request object that will be sent.
|
275
311
|
* @param {string} request.servingConfig
|
276
312
|
* Required. The resource name of the Search serving config, such as
|
313
|
+
* `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
|
314
|
+
* or
|
277
315
|
* `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
|
278
316
|
* This field is used to identify the serving configuration name, set
|
279
317
|
* of models used to make the search.
|
@@ -317,11 +355,35 @@ class SearchServiceClient {
|
|
317
355
|
* expression is case-sensitive.
|
318
356
|
*
|
319
357
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
358
|
+
*
|
359
|
+
* Filtering in Vertex AI Search is done by mapping the LHS filter key to a
|
360
|
+
* key property defined in the Vertex AI Search backend -- this mapping is
|
361
|
+
* defined by the customer in their schema. For example a media customer might
|
362
|
+
* have a field 'name' in their schema. In this case the filter would look
|
363
|
+
* like this: filter --> name:'ANY("king kong")'
|
364
|
+
*
|
365
|
+
* For more information about filtering including syntax and filter
|
366
|
+
* operators, see
|
367
|
+
* [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
368
|
+
* @param {string} request.canonicalFilter
|
369
|
+
* The default filter that is applied when a user performs a search without
|
370
|
+
* checking any filters on the search page.
|
371
|
+
*
|
372
|
+
* The filter applied to every search request when quality improvement such as
|
373
|
+
* query expansion is needed. In the case a query does not have a sufficient
|
374
|
+
* amount of results this filter will be used to determine whether or not to
|
375
|
+
* enable the query expansion flow. The original filter will still be used for
|
376
|
+
* the query expanded search.
|
377
|
+
* This field is strongly recommended to achieve high search quality.
|
378
|
+
*
|
379
|
+
* For more information about filter syntax, see
|
380
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.filter|SearchRequest.filter}.
|
320
381
|
* @param {string} request.orderBy
|
321
382
|
* The order in which documents are returned. Documents can be ordered by
|
322
383
|
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
323
384
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
324
|
-
* case-sensitive.
|
385
|
+
* case-sensitive. For more information on ordering, see
|
386
|
+
* [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
|
325
387
|
*
|
326
388
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
327
389
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
@@ -336,6 +398,8 @@ class SearchServiceClient {
|
|
336
398
|
* error is returned.
|
337
399
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
|
338
400
|
* Boost specification to boost certain documents.
|
401
|
+
* For more information on boosting, see
|
402
|
+
* [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
339
403
|
* @param {number[]} request.params
|
340
404
|
* Additional search parameters.
|
341
405
|
*
|
@@ -343,9 +407,17 @@ class SearchServiceClient {
|
|
343
407
|
*
|
344
408
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
345
409
|
* are restricted or boosted based on the location provided.
|
410
|
+
* Example:
|
411
|
+
* user_country_code: "au"
|
412
|
+
*
|
413
|
+
* For available codes see [Country
|
414
|
+
* Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
|
415
|
+
*
|
346
416
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
347
|
-
*
|
348
|
-
*
|
417
|
+
* depending on the value. The only valid non-default value is 1,
|
418
|
+
* which enables image searching.
|
419
|
+
* Example:
|
420
|
+
* search_type: 1
|
349
421
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
350
422
|
* The query expansion specification that specifies the conditions under which
|
351
423
|
* query expansion occurs.
|
@@ -372,15 +444,17 @@ class SearchServiceClient {
|
|
372
444
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec} request.embeddingSpec
|
373
445
|
* Uses the provided embedding to do additional semantic document retrieval.
|
374
446
|
* The retrieval is based on the dot product of
|
375
|
-
* {@link protos
|
376
|
-
* embedding that is provided in
|
377
|
-
* {@link protos
|
447
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
|
448
|
+
* and the document embedding that is provided in
|
449
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
|
378
450
|
*
|
379
|
-
* If
|
380
|
-
*
|
451
|
+
* If
|
452
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
|
453
|
+
* is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
|
381
454
|
* @param {string} request.rankingExpression
|
382
455
|
* The ranking expression controls the customized ranking on retrieval
|
383
|
-
* documents. This overrides
|
456
|
+
* documents. This overrides
|
457
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
384
458
|
* The ranking expression is a single function or multiple functions that are
|
385
459
|
* joint by "+".
|
386
460
|
* * ranking_expression = function, { " + ", function };
|
@@ -453,6 +527,8 @@ class SearchServiceClient {
|
|
453
527
|
* The request object that will be sent.
|
454
528
|
* @param {string} request.servingConfig
|
455
529
|
* Required. The resource name of the Search serving config, such as
|
530
|
+
* `projects/* /locations/global/collections/default_collection/engines/* /servingConfigs/default_serving_config`,
|
531
|
+
* or
|
456
532
|
* `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
|
457
533
|
* This field is used to identify the serving configuration name, set
|
458
534
|
* of models used to make the search.
|
@@ -496,11 +572,35 @@ class SearchServiceClient {
|
|
496
572
|
* expression is case-sensitive.
|
497
573
|
*
|
498
574
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
575
|
+
*
|
576
|
+
* Filtering in Vertex AI Search is done by mapping the LHS filter key to a
|
577
|
+
* key property defined in the Vertex AI Search backend -- this mapping is
|
578
|
+
* defined by the customer in their schema. For example a media customer might
|
579
|
+
* have a field 'name' in their schema. In this case the filter would look
|
580
|
+
* like this: filter --> name:'ANY("king kong")'
|
581
|
+
*
|
582
|
+
* For more information about filtering including syntax and filter
|
583
|
+
* operators, see
|
584
|
+
* [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
585
|
+
* @param {string} request.canonicalFilter
|
586
|
+
* The default filter that is applied when a user performs a search without
|
587
|
+
* checking any filters on the search page.
|
588
|
+
*
|
589
|
+
* The filter applied to every search request when quality improvement such as
|
590
|
+
* query expansion is needed. In the case a query does not have a sufficient
|
591
|
+
* amount of results this filter will be used to determine whether or not to
|
592
|
+
* enable the query expansion flow. The original filter will still be used for
|
593
|
+
* the query expanded search.
|
594
|
+
* This field is strongly recommended to achieve high search quality.
|
595
|
+
*
|
596
|
+
* For more information about filter syntax, see
|
597
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.filter|SearchRequest.filter}.
|
499
598
|
* @param {string} request.orderBy
|
500
599
|
* The order in which documents are returned. Documents can be ordered by
|
501
600
|
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
502
601
|
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
503
|
-
* case-sensitive.
|
602
|
+
* case-sensitive. For more information on ordering, see
|
603
|
+
* [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
|
504
604
|
*
|
505
605
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
506
606
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
@@ -515,6 +615,8 @@ class SearchServiceClient {
|
|
515
615
|
* error is returned.
|
516
616
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec} request.boostSpec
|
517
617
|
* Boost specification to boost certain documents.
|
618
|
+
* For more information on boosting, see
|
619
|
+
* [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
518
620
|
* @param {number[]} request.params
|
519
621
|
* Additional search parameters.
|
520
622
|
*
|
@@ -522,9 +624,17 @@ class SearchServiceClient {
|
|
522
624
|
*
|
523
625
|
* * `user_country_code`: string. Default empty. If set to non-empty, results
|
524
626
|
* are restricted or boosted based on the location provided.
|
627
|
+
* Example:
|
628
|
+
* user_country_code: "au"
|
629
|
+
*
|
630
|
+
* For available codes see [Country
|
631
|
+
* Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
|
632
|
+
*
|
525
633
|
* * `search_type`: double. Default empty. Enables non-webpage searching
|
526
|
-
*
|
527
|
-
*
|
634
|
+
* depending on the value. The only valid non-default value is 1,
|
635
|
+
* which enables image searching.
|
636
|
+
* Example:
|
637
|
+
* search_type: 1
|
528
638
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
529
639
|
* The query expansion specification that specifies the conditions under which
|
530
640
|
* query expansion occurs.
|
@@ -551,15 +661,17 @@ class SearchServiceClient {
|
|
551
661
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec} request.embeddingSpec
|
552
662
|
* Uses the provided embedding to do additional semantic document retrieval.
|
553
663
|
* The retrieval is based on the dot product of
|
554
|
-
* {@link protos
|
555
|
-
* embedding that is provided in
|
556
|
-
* {@link protos
|
664
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.vector|SearchRequest.EmbeddingSpec.EmbeddingVector.vector}
|
665
|
+
* and the document embedding that is provided in
|
666
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}.
|
557
667
|
*
|
558
|
-
* If
|
559
|
-
*
|
668
|
+
* If
|
669
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec.EmbeddingVector.field_path|SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
|
670
|
+
* is not provided, it will use {@link protos.|ServingConfig.EmbeddingConfig.field_path}.
|
560
671
|
* @param {string} request.rankingExpression
|
561
672
|
* The ranking expression controls the customized ranking on retrieval
|
562
|
-
* documents. This overrides
|
673
|
+
* documents. This overrides
|
674
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
|
563
675
|
* The ranking expression is a single function or multiple functions that are
|
564
676
|
* joint by "+".
|
565
677
|
* * ranking_expression = function, { " + ", function };
|
@@ -683,6 +795,120 @@ class SearchServiceClient {
|
|
683
795
|
// --------------------
|
684
796
|
// -- Path templates --
|
685
797
|
// --------------------
|
798
|
+
/**
|
799
|
+
* Return a fully-qualified engine resource name string.
|
800
|
+
*
|
801
|
+
* @param {string} project
|
802
|
+
* @param {string} location
|
803
|
+
* @param {string} collection
|
804
|
+
* @param {string} engine
|
805
|
+
* @returns {string} Resource name string.
|
806
|
+
*/
|
807
|
+
enginePath(project, location, collection, engine) {
|
808
|
+
return this.pathTemplates.enginePathTemplate.render({
|
809
|
+
project: project,
|
810
|
+
location: location,
|
811
|
+
collection: collection,
|
812
|
+
engine: engine,
|
813
|
+
});
|
814
|
+
}
|
815
|
+
/**
|
816
|
+
* Parse the project from Engine resource.
|
817
|
+
*
|
818
|
+
* @param {string} engineName
|
819
|
+
* A fully-qualified path representing Engine resource.
|
820
|
+
* @returns {string} A string representing the project.
|
821
|
+
*/
|
822
|
+
matchProjectFromEngineName(engineName) {
|
823
|
+
return this.pathTemplates.enginePathTemplate.match(engineName).project;
|
824
|
+
}
|
825
|
+
/**
|
826
|
+
* Parse the location from Engine resource.
|
827
|
+
*
|
828
|
+
* @param {string} engineName
|
829
|
+
* A fully-qualified path representing Engine resource.
|
830
|
+
* @returns {string} A string representing the location.
|
831
|
+
*/
|
832
|
+
matchLocationFromEngineName(engineName) {
|
833
|
+
return this.pathTemplates.enginePathTemplate.match(engineName).location;
|
834
|
+
}
|
835
|
+
/**
|
836
|
+
* Parse the collection from Engine resource.
|
837
|
+
*
|
838
|
+
* @param {string} engineName
|
839
|
+
* A fully-qualified path representing Engine resource.
|
840
|
+
* @returns {string} A string representing the collection.
|
841
|
+
*/
|
842
|
+
matchCollectionFromEngineName(engineName) {
|
843
|
+
return this.pathTemplates.enginePathTemplate.match(engineName).collection;
|
844
|
+
}
|
845
|
+
/**
|
846
|
+
* Parse the engine from Engine resource.
|
847
|
+
*
|
848
|
+
* @param {string} engineName
|
849
|
+
* A fully-qualified path representing Engine resource.
|
850
|
+
* @returns {string} A string representing the engine.
|
851
|
+
*/
|
852
|
+
matchEngineFromEngineName(engineName) {
|
853
|
+
return this.pathTemplates.enginePathTemplate.match(engineName).engine;
|
854
|
+
}
|
855
|
+
/**
|
856
|
+
* Return a fully-qualified projectLocationCollectionDataStore resource name string.
|
857
|
+
*
|
858
|
+
* @param {string} project
|
859
|
+
* @param {string} location
|
860
|
+
* @param {string} collection
|
861
|
+
* @param {string} data_store
|
862
|
+
* @returns {string} Resource name string.
|
863
|
+
*/
|
864
|
+
projectLocationCollectionDataStorePath(project, location, collection, dataStore) {
|
865
|
+
return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.render({
|
866
|
+
project: project,
|
867
|
+
location: location,
|
868
|
+
collection: collection,
|
869
|
+
data_store: dataStore,
|
870
|
+
});
|
871
|
+
}
|
872
|
+
/**
|
873
|
+
* Parse the project from ProjectLocationCollectionDataStore resource.
|
874
|
+
*
|
875
|
+
* @param {string} projectLocationCollectionDataStoreName
|
876
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
877
|
+
* @returns {string} A string representing the project.
|
878
|
+
*/
|
879
|
+
matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
|
880
|
+
return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).project;
|
881
|
+
}
|
882
|
+
/**
|
883
|
+
* Parse the location from ProjectLocationCollectionDataStore resource.
|
884
|
+
*
|
885
|
+
* @param {string} projectLocationCollectionDataStoreName
|
886
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
887
|
+
* @returns {string} A string representing the location.
|
888
|
+
*/
|
889
|
+
matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
|
890
|
+
return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).location;
|
891
|
+
}
|
892
|
+
/**
|
893
|
+
* Parse the collection from ProjectLocationCollectionDataStore resource.
|
894
|
+
*
|
895
|
+
* @param {string} projectLocationCollectionDataStoreName
|
896
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
897
|
+
* @returns {string} A string representing the collection.
|
898
|
+
*/
|
899
|
+
matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
|
900
|
+
return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).collection;
|
901
|
+
}
|
902
|
+
/**
|
903
|
+
* Parse the data_store from ProjectLocationCollectionDataStore resource.
|
904
|
+
*
|
905
|
+
* @param {string} projectLocationCollectionDataStoreName
|
906
|
+
* A fully-qualified path representing project_location_collection_data_store resource.
|
907
|
+
* @returns {string} A string representing the data_store.
|
908
|
+
*/
|
909
|
+
matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
|
910
|
+
return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).data_store;
|
911
|
+
}
|
686
912
|
/**
|
687
913
|
* Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
|
688
914
|
*
|
@@ -1040,6 +1266,315 @@ class SearchServiceClient {
|
|
1040
1266
|
matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
|
1041
1267
|
return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
|
1042
1268
|
}
|
1269
|
+
/**
|
1270
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
|
1271
|
+
*
|
1272
|
+
* @param {string} project
|
1273
|
+
* @param {string} location
|
1274
|
+
* @param {string} collection
|
1275
|
+
* @param {string} data_store
|
1276
|
+
* @returns {string} Resource name string.
|
1277
|
+
*/
|
1278
|
+
projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore) {
|
1279
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.render({
|
1280
|
+
project: project,
|
1281
|
+
location: location,
|
1282
|
+
collection: collection,
|
1283
|
+
data_store: dataStore,
|
1284
|
+
});
|
1285
|
+
}
|
1286
|
+
/**
|
1287
|
+
* Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
|
1288
|
+
*
|
1289
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
|
1290
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
|
1291
|
+
* @returns {string} A string representing the project.
|
1292
|
+
*/
|
1293
|
+
matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
|
1294
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).project;
|
1295
|
+
}
|
1296
|
+
/**
|
1297
|
+
* Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
|
1298
|
+
*
|
1299
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
|
1300
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
|
1301
|
+
* @returns {string} A string representing the location.
|
1302
|
+
*/
|
1303
|
+
matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
|
1304
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).location;
|
1305
|
+
}
|
1306
|
+
/**
|
1307
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
|
1308
|
+
*
|
1309
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
|
1310
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
|
1311
|
+
* @returns {string} A string representing the collection.
|
1312
|
+
*/
|
1313
|
+
matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
|
1314
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).collection;
|
1315
|
+
}
|
1316
|
+
/**
|
1317
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
|
1318
|
+
*
|
1319
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
|
1320
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
|
1321
|
+
* @returns {string} A string representing the data_store.
|
1322
|
+
*/
|
1323
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
|
1324
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
|
1325
|
+
}
|
1326
|
+
/**
|
1327
|
+
* Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
|
1328
|
+
*
|
1329
|
+
* @param {string} project
|
1330
|
+
* @param {string} location
|
1331
|
+
* @param {string} collection
|
1332
|
+
* @param {string} data_store
|
1333
|
+
* @param {string} target_site
|
1334
|
+
* @returns {string} Resource name string.
|
1335
|
+
*/
|
1336
|
+
projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
|
1337
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
|
1338
|
+
project: project,
|
1339
|
+
location: location,
|
1340
|
+
collection: collection,
|
1341
|
+
data_store: dataStore,
|
1342
|
+
target_site: targetSite,
|
1343
|
+
});
|
1344
|
+
}
|
1345
|
+
/**
|
1346
|
+
* Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1347
|
+
*
|
1348
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1349
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1350
|
+
* @returns {string} A string representing the project.
|
1351
|
+
*/
|
1352
|
+
matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1353
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
|
1354
|
+
}
|
1355
|
+
/**
|
1356
|
+
* Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1357
|
+
*
|
1358
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1359
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1360
|
+
* @returns {string} A string representing the location.
|
1361
|
+
*/
|
1362
|
+
matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1363
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
|
1364
|
+
}
|
1365
|
+
/**
|
1366
|
+
* Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1367
|
+
*
|
1368
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1369
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1370
|
+
* @returns {string} A string representing the collection.
|
1371
|
+
*/
|
1372
|
+
matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1373
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
|
1374
|
+
}
|
1375
|
+
/**
|
1376
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1377
|
+
*
|
1378
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1379
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1380
|
+
* @returns {string} A string representing the data_store.
|
1381
|
+
*/
|
1382
|
+
matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1383
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
|
1384
|
+
}
|
1385
|
+
/**
|
1386
|
+
* Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
|
1387
|
+
*
|
1388
|
+
* @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
|
1389
|
+
* A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
|
1390
|
+
* @returns {string} A string representing the target_site.
|
1391
|
+
*/
|
1392
|
+
matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
|
1393
|
+
return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
|
1394
|
+
}
|
1395
|
+
/**
|
1396
|
+
* Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
|
1397
|
+
*
|
1398
|
+
* @param {string} project
|
1399
|
+
* @param {string} location
|
1400
|
+
* @param {string} collection
|
1401
|
+
* @param {string} engine
|
1402
|
+
* @param {string} conversation
|
1403
|
+
* @returns {string} Resource name string.
|
1404
|
+
*/
|
1405
|
+
projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
|
1406
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
|
1407
|
+
project: project,
|
1408
|
+
location: location,
|
1409
|
+
collection: collection,
|
1410
|
+
engine: engine,
|
1411
|
+
conversation: conversation,
|
1412
|
+
});
|
1413
|
+
}
|
1414
|
+
/**
|
1415
|
+
* Parse the project from ProjectLocationCollectionEngineConversation resource.
|
1416
|
+
*
|
1417
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1418
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1419
|
+
* @returns {string} A string representing the project.
|
1420
|
+
*/
|
1421
|
+
matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1422
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
|
1423
|
+
}
|
1424
|
+
/**
|
1425
|
+
* Parse the location from ProjectLocationCollectionEngineConversation resource.
|
1426
|
+
*
|
1427
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1428
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1429
|
+
* @returns {string} A string representing the location.
|
1430
|
+
*/
|
1431
|
+
matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1432
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
|
1433
|
+
}
|
1434
|
+
/**
|
1435
|
+
* Parse the collection from ProjectLocationCollectionEngineConversation resource.
|
1436
|
+
*
|
1437
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1438
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1439
|
+
* @returns {string} A string representing the collection.
|
1440
|
+
*/
|
1441
|
+
matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1442
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
|
1443
|
+
}
|
1444
|
+
/**
|
1445
|
+
* Parse the engine from ProjectLocationCollectionEngineConversation resource.
|
1446
|
+
*
|
1447
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1448
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1449
|
+
* @returns {string} A string representing the engine.
|
1450
|
+
*/
|
1451
|
+
matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1452
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
|
1453
|
+
}
|
1454
|
+
/**
|
1455
|
+
* Parse the conversation from ProjectLocationCollectionEngineConversation resource.
|
1456
|
+
*
|
1457
|
+
* @param {string} projectLocationCollectionEngineConversationName
|
1458
|
+
* A fully-qualified path representing project_location_collection_engine_conversation resource.
|
1459
|
+
* @returns {string} A string representing the conversation.
|
1460
|
+
*/
|
1461
|
+
matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
|
1462
|
+
return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
|
1463
|
+
}
|
1464
|
+
/**
|
1465
|
+
* Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
|
1466
|
+
*
|
1467
|
+
* @param {string} project
|
1468
|
+
* @param {string} location
|
1469
|
+
* @param {string} collection
|
1470
|
+
* @param {string} engine
|
1471
|
+
* @param {string} serving_config
|
1472
|
+
* @returns {string} Resource name string.
|
1473
|
+
*/
|
1474
|
+
projectLocationCollectionEngineServingConfigPath(project, location, collection, engine, servingConfig) {
|
1475
|
+
return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.render({
|
1476
|
+
project: project,
|
1477
|
+
location: location,
|
1478
|
+
collection: collection,
|
1479
|
+
engine: engine,
|
1480
|
+
serving_config: servingConfig,
|
1481
|
+
});
|
1482
|
+
}
|
1483
|
+
/**
|
1484
|
+
* Parse the project from ProjectLocationCollectionEngineServingConfig resource.
|
1485
|
+
*
|
1486
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1487
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1488
|
+
* @returns {string} A string representing the project.
|
1489
|
+
*/
|
1490
|
+
matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
|
1491
|
+
return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).project;
|
1492
|
+
}
|
1493
|
+
/**
|
1494
|
+
* Parse the location from ProjectLocationCollectionEngineServingConfig resource.
|
1495
|
+
*
|
1496
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1497
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1498
|
+
* @returns {string} A string representing the location.
|
1499
|
+
*/
|
1500
|
+
matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
|
1501
|
+
return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).location;
|
1502
|
+
}
|
1503
|
+
/**
|
1504
|
+
* Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
|
1505
|
+
*
|
1506
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1507
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1508
|
+
* @returns {string} A string representing the collection.
|
1509
|
+
*/
|
1510
|
+
matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
|
1511
|
+
return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).collection;
|
1512
|
+
}
|
1513
|
+
/**
|
1514
|
+
* Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
|
1515
|
+
*
|
1516
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1517
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1518
|
+
* @returns {string} A string representing the engine.
|
1519
|
+
*/
|
1520
|
+
matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
|
1521
|
+
return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).engine;
|
1522
|
+
}
|
1523
|
+
/**
|
1524
|
+
* Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
|
1525
|
+
*
|
1526
|
+
* @param {string} projectLocationCollectionEngineServingConfigName
|
1527
|
+
* A fully-qualified path representing project_location_collection_engine_serving_config resource.
|
1528
|
+
* @returns {string} A string representing the serving_config.
|
1529
|
+
*/
|
1530
|
+
matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
|
1531
|
+
return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
|
1532
|
+
}
|
1533
|
+
/**
|
1534
|
+
* Return a fully-qualified projectLocationDataStore resource name string.
|
1535
|
+
*
|
1536
|
+
* @param {string} project
|
1537
|
+
* @param {string} location
|
1538
|
+
* @param {string} data_store
|
1539
|
+
* @returns {string} Resource name string.
|
1540
|
+
*/
|
1541
|
+
projectLocationDataStorePath(project, location, dataStore) {
|
1542
|
+
return this.pathTemplates.projectLocationDataStorePathTemplate.render({
|
1543
|
+
project: project,
|
1544
|
+
location: location,
|
1545
|
+
data_store: dataStore,
|
1546
|
+
});
|
1547
|
+
}
|
1548
|
+
/**
|
1549
|
+
* Parse the project from ProjectLocationDataStore resource.
|
1550
|
+
*
|
1551
|
+
* @param {string} projectLocationDataStoreName
|
1552
|
+
* A fully-qualified path representing project_location_data_store resource.
|
1553
|
+
* @returns {string} A string representing the project.
|
1554
|
+
*/
|
1555
|
+
matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) {
|
1556
|
+
return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).project;
|
1557
|
+
}
|
1558
|
+
/**
|
1559
|
+
* Parse the location from ProjectLocationDataStore resource.
|
1560
|
+
*
|
1561
|
+
* @param {string} projectLocationDataStoreName
|
1562
|
+
* A fully-qualified path representing project_location_data_store resource.
|
1563
|
+
* @returns {string} A string representing the location.
|
1564
|
+
*/
|
1565
|
+
matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) {
|
1566
|
+
return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).location;
|
1567
|
+
}
|
1568
|
+
/**
|
1569
|
+
* Parse the data_store from ProjectLocationDataStore resource.
|
1570
|
+
*
|
1571
|
+
* @param {string} projectLocationDataStoreName
|
1572
|
+
* A fully-qualified path representing project_location_data_store resource.
|
1573
|
+
* @returns {string} A string representing the data_store.
|
1574
|
+
*/
|
1575
|
+
matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) {
|
1576
|
+
return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).data_store;
|
1577
|
+
}
|
1043
1578
|
/**
|
1044
1579
|
* Return a fully-qualified projectLocationDataStoreBranch resource name string.
|
1045
1580
|
*
|
@@ -1337,6 +1872,108 @@ class SearchServiceClient {
|
|
1337
1872
|
matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
|
1338
1873
|
return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
|
1339
1874
|
}
|
1875
|
+
/**
|
1876
|
+
* Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
|
1877
|
+
*
|
1878
|
+
* @param {string} project
|
1879
|
+
* @param {string} location
|
1880
|
+
* @param {string} data_store
|
1881
|
+
* @returns {string} Resource name string.
|
1882
|
+
*/
|
1883
|
+
projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore) {
|
1884
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.render({
|
1885
|
+
project: project,
|
1886
|
+
location: location,
|
1887
|
+
data_store: dataStore,
|
1888
|
+
});
|
1889
|
+
}
|
1890
|
+
/**
|
1891
|
+
* Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
|
1892
|
+
*
|
1893
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineName
|
1894
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
|
1895
|
+
* @returns {string} A string representing the project.
|
1896
|
+
*/
|
1897
|
+
matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
|
1898
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).project;
|
1899
|
+
}
|
1900
|
+
/**
|
1901
|
+
* Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
|
1902
|
+
*
|
1903
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineName
|
1904
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
|
1905
|
+
* @returns {string} A string representing the location.
|
1906
|
+
*/
|
1907
|
+
matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
|
1908
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).location;
|
1909
|
+
}
|
1910
|
+
/**
|
1911
|
+
* Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
|
1912
|
+
*
|
1913
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineName
|
1914
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
|
1915
|
+
* @returns {string} A string representing the data_store.
|
1916
|
+
*/
|
1917
|
+
matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
|
1918
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
|
1919
|
+
}
|
1920
|
+
/**
|
1921
|
+
* Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
|
1922
|
+
*
|
1923
|
+
* @param {string} project
|
1924
|
+
* @param {string} location
|
1925
|
+
* @param {string} data_store
|
1926
|
+
* @param {string} target_site
|
1927
|
+
* @returns {string} Resource name string.
|
1928
|
+
*/
|
1929
|
+
projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
|
1930
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
|
1931
|
+
project: project,
|
1932
|
+
location: location,
|
1933
|
+
data_store: dataStore,
|
1934
|
+
target_site: targetSite,
|
1935
|
+
});
|
1936
|
+
}
|
1937
|
+
/**
|
1938
|
+
* Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1939
|
+
*
|
1940
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1941
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1942
|
+
* @returns {string} A string representing the project.
|
1943
|
+
*/
|
1944
|
+
matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
1945
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
|
1946
|
+
}
|
1947
|
+
/**
|
1948
|
+
* Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1949
|
+
*
|
1950
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1951
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1952
|
+
* @returns {string} A string representing the location.
|
1953
|
+
*/
|
1954
|
+
matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
1955
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
|
1956
|
+
}
|
1957
|
+
/**
|
1958
|
+
* Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1959
|
+
*
|
1960
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1961
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1962
|
+
* @returns {string} A string representing the data_store.
|
1963
|
+
*/
|
1964
|
+
matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
1965
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
|
1966
|
+
}
|
1967
|
+
/**
|
1968
|
+
* Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
|
1969
|
+
*
|
1970
|
+
* @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
|
1971
|
+
* A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
|
1972
|
+
* @returns {string} A string representing the target_site.
|
1973
|
+
*/
|
1974
|
+
matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
|
1975
|
+
return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
|
1976
|
+
}
|
1340
1977
|
/**
|
1341
1978
|
* Terminate the gRPC channel and close the client.
|
1342
1979
|
*
|