@google-cloud/discoveryengine 0.7.0 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- package/CHANGELOG.md +24 -0
- package/README.md +6 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +1 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +15 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +131 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +281 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +6 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +26 -22
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +193 -47
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +41 -36
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
- package/build/protos/protos.d.ts +6529 -4472
- package/build/protos/protos.js +16561 -11622
- package/build/protos/protos.json +1842 -1317
- package/build/src/v1/completion_service_client.d.ts +6 -7
- package/build/src/v1/document_service_client.d.ts +83 -94
- package/build/src/v1/document_service_client.js +18 -22
- package/build/src/v1/schema_service_client.d.ts +39 -49
- package/build/src/v1/schema_service_client.js +17 -22
- package/build/src/v1/search_service_client.d.ts +31 -34
- package/build/src/v1/search_service_client.js +21 -23
- package/build/src/v1/user_event_service_client.d.ts +6 -10
- package/build/src/v1/user_event_service_client.js +1 -2
- package/build/src/v1beta/completion_service_client.d.ts +106 -8
- package/build/src/v1beta/completion_service_client.js +128 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +876 -0
- package/build/src/v1beta/conversational_search_service_client.js +1149 -0
- package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
- package/build/src/v1beta/document_service_client.d.ts +183 -98
- package/build/src/v1beta/document_service_client.js +166 -22
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +103 -11
- package/build/src/v1beta/recommendation_service_client.js +128 -0
- package/build/src/v1beta/schema_service_client.d.ts +132 -49
- package/build/src/v1beta/schema_service_client.js +163 -22
- package/build/src/v1beta/search_service_client.d.ts +163 -67
- package/build/src/v1beta/search_service_client.js +175 -45
- package/build/src/v1beta/user_event_service_client.d.ts +104 -15
- package/build/src/v1beta/user_event_service_client.js +147 -2
- package/package.json +8 -11
@@ -125,27 +125,29 @@ export declare class SearchServiceClient {
|
|
125
125
|
* documents under the default branch.
|
126
126
|
* @param {string} request.query
|
127
127
|
* Raw search query.
|
128
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery} request.imageQuery
|
129
|
+
* Raw image query.
|
128
130
|
* @param {number} request.pageSize
|
129
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
131
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
|
130
132
|
* to return. If unspecified, defaults to a reasonable value. The maximum
|
131
|
-
* allowed value is 100. Values above 100
|
133
|
+
* allowed value is 100. Values above 100 are coerced to 100.
|
132
134
|
*
|
133
135
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
134
136
|
* @param {string} request.pageToken
|
135
137
|
* A page token received from a previous
|
136
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
138
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
137
139
|
* call. Provide this to retrieve the subsequent page.
|
138
140
|
*
|
139
141
|
* When paginating, all other parameters provided to
|
140
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
142
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
141
143
|
* must match the call that provided the page token. Otherwise, an
|
142
144
|
* `INVALID_ARGUMENT` error is returned.
|
143
145
|
* @param {number} request.offset
|
144
146
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
145
147
|
* result location, amongst the
|
146
|
-
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
148
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
147
149
|
* as relevant) in search results. This field is only considered if
|
148
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
150
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
149
151
|
* is unset.
|
150
152
|
*
|
151
153
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -156,16 +158,17 @@ export declare class SearchServiceClient {
|
|
156
158
|
*
|
157
159
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
158
160
|
* @param {string} request.orderBy
|
159
|
-
* The order in which documents are returned.
|
160
|
-
* a field in an {@link google.cloud.discoveryengine.v1beta.Document|Document}
|
161
|
-
* object. Leave it unset if ordered by relevance.
|
161
|
+
* The order in which documents are returned. Documents can be ordered by
|
162
|
+
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
163
|
+
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
162
164
|
* case-sensitive.
|
163
165
|
*
|
164
|
-
* If this field is unrecognizable, an
|
166
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
165
167
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
166
168
|
* Information about the end user.
|
167
|
-
* Highly recommended for analytics.
|
168
|
-
*
|
169
|
+
* Highly recommended for analytics.
|
170
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_agent|UserInfo.user_agent}
|
171
|
+
* is used to deduce `device_type` for analytics.
|
169
172
|
* @param {number[]} request.facetSpecs
|
170
173
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
171
174
|
*
|
@@ -185,10 +188,10 @@ export declare class SearchServiceClient {
|
|
185
188
|
* which enables image searching.
|
186
189
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
187
190
|
* The query expansion specification that specifies the conditions under which
|
188
|
-
* query expansion
|
191
|
+
* query expansion occurs.
|
189
192
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
|
190
193
|
* The spell correction specification that specifies the mode under
|
191
|
-
* which spell correction
|
194
|
+
* which spell correction takes effect.
|
192
195
|
* @param {string} request.userPseudoId
|
193
196
|
* A unique identifier for tracking visitors. For example, this could be
|
194
197
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -198,18 +201,17 @@ export declare class SearchServiceClient {
|
|
198
201
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
199
202
|
*
|
200
203
|
* This should be the same identifier as
|
201
|
-
* {@link google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
204
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
202
205
|
* and
|
203
|
-
* {@link google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
206
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
204
207
|
*
|
205
208
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
206
209
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
207
210
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
208
|
-
*
|
209
|
-
* search.
|
211
|
+
* A specification for configuring the behavior of content search.
|
210
212
|
* @param {boolean} request.safeSearch
|
211
213
|
* Whether to turn on safe search. This is only supported for
|
212
|
-
*
|
214
|
+
* website search.
|
213
215
|
* @param {number[]} request.userLabels
|
214
216
|
* The user labels applied to a resource must meet the following requirements:
|
215
217
|
*
|
@@ -231,14 +233,13 @@ export declare class SearchServiceClient {
|
|
231
233
|
* @param {object} [options]
|
232
234
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
233
235
|
* @returns {Promise} - The promise which resolves to an array.
|
234
|
-
* The first element of the array is Array of {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult
|
236
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult|SearchResult}.
|
235
237
|
* The client library will perform auto-pagination by default: it will call the API as many
|
236
238
|
* times as needed and will merge results from all the pages into this array.
|
237
239
|
* Note that it can affect your quota.
|
238
240
|
* We recommend using `searchAsync()`
|
239
241
|
* method described below for async iteration which you can stop as needed.
|
240
|
-
* Please see the
|
241
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
242
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
242
243
|
* for more details and examples.
|
243
244
|
*/
|
244
245
|
search(request?: protos.google.cloud.discoveryengine.v1beta.ISearchRequest, options?: CallOptions): Promise<[
|
@@ -265,27 +266,29 @@ export declare class SearchServiceClient {
|
|
265
266
|
* documents under the default branch.
|
266
267
|
* @param {string} request.query
|
267
268
|
* Raw search query.
|
269
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery} request.imageQuery
|
270
|
+
* Raw image query.
|
268
271
|
* @param {number} request.pageSize
|
269
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
272
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
|
270
273
|
* to return. If unspecified, defaults to a reasonable value. The maximum
|
271
|
-
* allowed value is 100. Values above 100
|
274
|
+
* allowed value is 100. Values above 100 are coerced to 100.
|
272
275
|
*
|
273
276
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
274
277
|
* @param {string} request.pageToken
|
275
278
|
* A page token received from a previous
|
276
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
279
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
277
280
|
* call. Provide this to retrieve the subsequent page.
|
278
281
|
*
|
279
282
|
* When paginating, all other parameters provided to
|
280
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
283
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
281
284
|
* must match the call that provided the page token. Otherwise, an
|
282
285
|
* `INVALID_ARGUMENT` error is returned.
|
283
286
|
* @param {number} request.offset
|
284
287
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
285
288
|
* result location, amongst the
|
286
|
-
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
289
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
287
290
|
* as relevant) in search results. This field is only considered if
|
288
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
291
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
289
292
|
* is unset.
|
290
293
|
*
|
291
294
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -296,16 +299,17 @@ export declare class SearchServiceClient {
|
|
296
299
|
*
|
297
300
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
298
301
|
* @param {string} request.orderBy
|
299
|
-
* The order in which documents are returned.
|
300
|
-
* a field in an {@link google.cloud.discoveryengine.v1beta.Document|Document}
|
301
|
-
* object. Leave it unset if ordered by relevance.
|
302
|
+
* The order in which documents are returned. Documents can be ordered by
|
303
|
+
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
304
|
+
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
302
305
|
* case-sensitive.
|
303
306
|
*
|
304
|
-
* If this field is unrecognizable, an
|
307
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
305
308
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
306
309
|
* Information about the end user.
|
307
|
-
* Highly recommended for analytics.
|
308
|
-
*
|
310
|
+
* Highly recommended for analytics.
|
311
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_agent|UserInfo.user_agent}
|
312
|
+
* is used to deduce `device_type` for analytics.
|
309
313
|
* @param {number[]} request.facetSpecs
|
310
314
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
311
315
|
*
|
@@ -325,10 +329,10 @@ export declare class SearchServiceClient {
|
|
325
329
|
* which enables image searching.
|
326
330
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
327
331
|
* The query expansion specification that specifies the conditions under which
|
328
|
-
* query expansion
|
332
|
+
* query expansion occurs.
|
329
333
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
|
330
334
|
* The spell correction specification that specifies the mode under
|
331
|
-
* which spell correction
|
335
|
+
* which spell correction takes effect.
|
332
336
|
* @param {string} request.userPseudoId
|
333
337
|
* A unique identifier for tracking visitors. For example, this could be
|
334
338
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -338,18 +342,17 @@ export declare class SearchServiceClient {
|
|
338
342
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
339
343
|
*
|
340
344
|
* This should be the same identifier as
|
341
|
-
* {@link google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
345
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
342
346
|
* and
|
343
|
-
* {@link google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
347
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
344
348
|
*
|
345
349
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
346
350
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
347
351
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
348
|
-
*
|
349
|
-
* search.
|
352
|
+
* A specification for configuring the behavior of content search.
|
350
353
|
* @param {boolean} request.safeSearch
|
351
354
|
* Whether to turn on safe search. This is only supported for
|
352
|
-
*
|
355
|
+
* website search.
|
353
356
|
* @param {number[]} request.userLabels
|
354
357
|
* The user labels applied to a resource must meet the following requirements:
|
355
358
|
*
|
@@ -371,13 +374,12 @@ export declare class SearchServiceClient {
|
|
371
374
|
* @param {object} [options]
|
372
375
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
373
376
|
* @returns {Stream}
|
374
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult
|
377
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult|SearchResult} on 'data' event.
|
375
378
|
* The client library will perform auto-pagination by default: it will call the API as many
|
376
379
|
* times as needed. Note that it can affect your quota.
|
377
380
|
* We recommend using `searchAsync()`
|
378
381
|
* method described below for async iteration which you can stop as needed.
|
379
|
-
* Please see the
|
380
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
382
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
381
383
|
* for more details and examples.
|
382
384
|
*/
|
383
385
|
searchStream(request?: protos.google.cloud.discoveryengine.v1beta.ISearchRequest, options?: CallOptions): Transform;
|
@@ -400,27 +402,29 @@ export declare class SearchServiceClient {
|
|
400
402
|
* documents under the default branch.
|
401
403
|
* @param {string} request.query
|
402
404
|
* Raw search query.
|
405
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery} request.imageQuery
|
406
|
+
* Raw image query.
|
403
407
|
* @param {number} request.pageSize
|
404
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
408
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
|
405
409
|
* to return. If unspecified, defaults to a reasonable value. The maximum
|
406
|
-
* allowed value is 100. Values above 100
|
410
|
+
* allowed value is 100. Values above 100 are coerced to 100.
|
407
411
|
*
|
408
412
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
409
413
|
* @param {string} request.pageToken
|
410
414
|
* A page token received from a previous
|
411
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
415
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
412
416
|
* call. Provide this to retrieve the subsequent page.
|
413
417
|
*
|
414
418
|
* When paginating, all other parameters provided to
|
415
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
419
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
416
420
|
* must match the call that provided the page token. Otherwise, an
|
417
421
|
* `INVALID_ARGUMENT` error is returned.
|
418
422
|
* @param {number} request.offset
|
419
423
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
420
424
|
* result location, amongst the
|
421
|
-
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
425
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
422
426
|
* as relevant) in search results. This field is only considered if
|
423
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
427
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
424
428
|
* is unset.
|
425
429
|
*
|
426
430
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -431,16 +435,17 @@ export declare class SearchServiceClient {
|
|
431
435
|
*
|
432
436
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
433
437
|
* @param {string} request.orderBy
|
434
|
-
* The order in which documents are returned.
|
435
|
-
* a field in an {@link google.cloud.discoveryengine.v1beta.Document|Document}
|
436
|
-
* object. Leave it unset if ordered by relevance.
|
438
|
+
* The order in which documents are returned. Documents can be ordered by
|
439
|
+
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
440
|
+
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
437
441
|
* case-sensitive.
|
438
442
|
*
|
439
|
-
* If this field is unrecognizable, an
|
443
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
440
444
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
441
445
|
* Information about the end user.
|
442
|
-
* Highly recommended for analytics.
|
443
|
-
*
|
446
|
+
* Highly recommended for analytics.
|
447
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_agent|UserInfo.user_agent}
|
448
|
+
* is used to deduce `device_type` for analytics.
|
444
449
|
* @param {number[]} request.facetSpecs
|
445
450
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
446
451
|
*
|
@@ -460,10 +465,10 @@ export declare class SearchServiceClient {
|
|
460
465
|
* which enables image searching.
|
461
466
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
462
467
|
* The query expansion specification that specifies the conditions under which
|
463
|
-
* query expansion
|
468
|
+
* query expansion occurs.
|
464
469
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
|
465
470
|
* The spell correction specification that specifies the mode under
|
466
|
-
* which spell correction
|
471
|
+
* which spell correction takes effect.
|
467
472
|
* @param {string} request.userPseudoId
|
468
473
|
* A unique identifier for tracking visitors. For example, this could be
|
469
474
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -473,18 +478,17 @@ export declare class SearchServiceClient {
|
|
473
478
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
474
479
|
*
|
475
480
|
* This should be the same identifier as
|
476
|
-
* {@link google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
481
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
477
482
|
* and
|
478
|
-
* {@link google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
483
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
479
484
|
*
|
480
485
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
481
486
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
482
487
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
483
|
-
*
|
484
|
-
* search.
|
488
|
+
* A specification for configuring the behavior of content search.
|
485
489
|
* @param {boolean} request.safeSearch
|
486
490
|
* Whether to turn on safe search. This is only supported for
|
487
|
-
*
|
491
|
+
* website search.
|
488
492
|
* @param {number[]} request.userLabels
|
489
493
|
* The user labels applied to a resource must meet the following requirements:
|
490
494
|
*
|
@@ -506,12 +510,11 @@ export declare class SearchServiceClient {
|
|
506
510
|
* @param {object} [options]
|
507
511
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
508
512
|
* @returns {Object}
|
509
|
-
* An iterable Object that allows
|
513
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
510
514
|
* When you iterate the returned iterable, each element will be an object representing
|
511
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult
|
515
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
|
512
516
|
* so you can stop the iteration when you don't need more results.
|
513
|
-
* Please see the
|
514
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
517
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
515
518
|
* for more details and examples.
|
516
519
|
* @example <caption>include:samples/generated/v1beta/search_service.search.js</caption>
|
517
520
|
* region_tag:discoveryengine_v1beta_generated_SearchService_Search_async
|
@@ -628,6 +631,57 @@ export declare class SearchServiceClient {
|
|
628
631
|
* @returns {string} A string representing the document.
|
629
632
|
*/
|
630
633
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
634
|
+
/**
|
635
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
636
|
+
*
|
637
|
+
* @param {string} project
|
638
|
+
* @param {string} location
|
639
|
+
* @param {string} collection
|
640
|
+
* @param {string} data_store
|
641
|
+
* @param {string} conversation
|
642
|
+
* @returns {string} Resource name string.
|
643
|
+
*/
|
644
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
645
|
+
/**
|
646
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
647
|
+
*
|
648
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
649
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
650
|
+
* @returns {string} A string representing the project.
|
651
|
+
*/
|
652
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
653
|
+
/**
|
654
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
655
|
+
*
|
656
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
657
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
658
|
+
* @returns {string} A string representing the location.
|
659
|
+
*/
|
660
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
661
|
+
/**
|
662
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
663
|
+
*
|
664
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
665
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
666
|
+
* @returns {string} A string representing the collection.
|
667
|
+
*/
|
668
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
669
|
+
/**
|
670
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
671
|
+
*
|
672
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
673
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
674
|
+
* @returns {string} A string representing the data_store.
|
675
|
+
*/
|
676
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
677
|
+
/**
|
678
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
679
|
+
*
|
680
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
681
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
682
|
+
* @returns {string} A string representing the conversation.
|
683
|
+
*/
|
684
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
631
685
|
/**
|
632
686
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
633
687
|
*
|
@@ -823,6 +877,48 @@ export declare class SearchServiceClient {
|
|
823
877
|
* @returns {string} A string representing the document.
|
824
878
|
*/
|
825
879
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
880
|
+
/**
|
881
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
882
|
+
*
|
883
|
+
* @param {string} project
|
884
|
+
* @param {string} location
|
885
|
+
* @param {string} data_store
|
886
|
+
* @param {string} conversation
|
887
|
+
* @returns {string} Resource name string.
|
888
|
+
*/
|
889
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
890
|
+
/**
|
891
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
892
|
+
*
|
893
|
+
* @param {string} projectLocationDataStoreConversationName
|
894
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
895
|
+
* @returns {string} A string representing the project.
|
896
|
+
*/
|
897
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
898
|
+
/**
|
899
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
900
|
+
*
|
901
|
+
* @param {string} projectLocationDataStoreConversationName
|
902
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
903
|
+
* @returns {string} A string representing the location.
|
904
|
+
*/
|
905
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
906
|
+
/**
|
907
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
908
|
+
*
|
909
|
+
* @param {string} projectLocationDataStoreConversationName
|
910
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
911
|
+
* @returns {string} A string representing the data_store.
|
912
|
+
*/
|
913
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
914
|
+
/**
|
915
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
916
|
+
*
|
917
|
+
* @param {string} projectLocationDataStoreConversationName
|
918
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
919
|
+
* @returns {string} A string representing the conversation.
|
920
|
+
*/
|
921
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
826
922
|
/**
|
827
923
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
828
924
|
*
|