@google-cloud/discoveryengine 0.8.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/README.md +13 -1
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +30 -2
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +15 -2
- package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +114 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +303 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +8 -5
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +4 -3
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +27 -23
- package/build/protos/google/cloud/discoveryengine/v1/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +428 -20
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +48 -39
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +7 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +13 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +138 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +2 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +17 -17
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +276 -64
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +45 -36
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
- package/build/protos/protos.d.ts +13913 -8367
- package/build/protos/protos.js +36766 -22883
- package/build/protos/protos.json +3956 -2571
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +4 -1
- package/build/src/v1/completion_service_client.d.ts +161 -12
- package/build/src/v1/completion_service_client.js +188 -4
- package/build/src/v1/conversational_search_service_client.d.ts +947 -0
- package/build/src/v1/conversational_search_service_client.js +1205 -0
- package/build/src/v1/conversational_search_service_client_config.json +68 -0
- package/build/src/v1/document_service_client.d.ts +245 -109
- package/build/src/v1/document_service_client.js +231 -31
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +3 -1
- package/build/src/v1/schema_service_client.d.ts +187 -53
- package/build/src/v1/schema_service_client.js +224 -27
- package/build/src/v1/search_service_client.d.ts +266 -59
- package/build/src/v1/search_service_client.js +267 -41
- package/build/src/v1/user_event_service_client.d.ts +159 -19
- package/build/src/v1/user_event_service_client.js +208 -7
- package/build/src/v1beta/completion_service_client.d.ts +159 -12
- package/build/src/v1beta/completion_service_client.js +188 -4
- package/build/src/v1beta/conversational_search_service_client.d.ts +947 -0
- package/build/src/v1beta/conversational_search_service_client.js +1205 -0
- package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
- package/build/src/v1beta/document_service_client.d.ts +237 -101
- package/build/src/v1beta/document_service_client.js +227 -27
- 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 +158 -15
- package/build/src/v1beta/recommendation_service_client.js +188 -4
- package/build/src/v1beta/schema_service_client.d.ts +187 -53
- package/build/src/v1beta/schema_service_client.js +224 -27
- package/build/src/v1beta/search_service_client.d.ts +305 -71
- package/build/src/v1beta/search_service_client.js +293 -49
- package/build/src/v1beta/user_event_service_client.d.ts +156 -16
- package/build/src/v1beta/user_event_service_client.js +208 -7
- package/package.json +10 -13
@@ -1,6 +1,6 @@
|
|
1
1
|
/// <reference types="node" />
|
2
2
|
import type * as gax from 'google-gax';
|
3
|
-
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
|
3
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
|
4
4
|
import { Transform } from 'stream';
|
5
5
|
import * as protos from '../../protos/protos';
|
6
6
|
/**
|
@@ -22,6 +22,7 @@ export declare class SearchServiceClient {
|
|
22
22
|
innerApiCalls: {
|
23
23
|
[name: string]: Function;
|
24
24
|
};
|
25
|
+
locationsClient: LocationsClient;
|
25
26
|
pathTemplates: {
|
26
27
|
[name: string]: gax.PathTemplate;
|
27
28
|
};
|
@@ -56,8 +57,7 @@ export declare class SearchServiceClient {
|
|
56
57
|
* API remote host.
|
57
58
|
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
58
59
|
* Follows the structure of {@link gapicConfig}.
|
59
|
-
* @param {boolean
|
60
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
60
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
61
61
|
* For more information, please check the
|
62
62
|
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
63
63
|
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
@@ -65,7 +65,7 @@ export declare class SearchServiceClient {
|
|
65
65
|
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
66
66
|
* ```
|
67
67
|
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
68
|
-
* const client = new SearchServiceClient({fallback:
|
68
|
+
* const client = new SearchServiceClient({fallback: true}, gax);
|
69
69
|
* ```
|
70
70
|
*/
|
71
71
|
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
@@ -125,34 +125,57 @@ 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.v1.SearchRequest.ImageQuery} request.imageQuery
|
129
|
+
* Raw image query.
|
128
130
|
* @param {number} request.pageSize
|
129
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
131
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
130
132
|
* return. If unspecified, defaults to a reasonable value. The maximum allowed
|
131
|
-
* value is 100. Values above 100
|
133
|
+
* 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.v1.SearchService.Search|SearchService.Search}
|
138
|
+
* {@link protos.google.cloud.discoveryengine.v1.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.v1.SearchService.Search|SearchService.Search}
|
142
|
+
* {@link protos.google.cloud.discoveryengine.v1.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.v1.Document|Document}s deemed by the API as
|
148
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
147
149
|
* relevant) in search results. This field is only considered if
|
148
|
-
* {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
150
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
149
151
|
* unset.
|
150
152
|
*
|
151
153
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
154
|
+
* @param {string} request.filter
|
155
|
+
* The filter syntax consists of an expression language for constructing a
|
156
|
+
* predicate from one or more fields of the documents being filtered. Filter
|
157
|
+
* expression is case-sensitive.
|
158
|
+
*
|
159
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
160
|
+
* @param {string} request.orderBy
|
161
|
+
* The order in which documents are returned. Documents can be ordered by
|
162
|
+
* a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
|
163
|
+
* Leave it unset if ordered by relevance. `order_by` expression is
|
164
|
+
* case-sensitive.
|
165
|
+
*
|
166
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
152
167
|
* @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
|
153
168
|
* Information about the end user.
|
154
|
-
* Highly recommended for analytics.
|
155
|
-
*
|
169
|
+
* Highly recommended for analytics.
|
170
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
|
171
|
+
* is used to deduce `device_type` for analytics.
|
172
|
+
* @param {number[]} request.facetSpecs
|
173
|
+
* Facet specifications for faceted search. If empty, no facets are returned.
|
174
|
+
*
|
175
|
+
* A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
|
176
|
+
* error is returned.
|
177
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
|
178
|
+
* Boost specification to boost certain documents.
|
156
179
|
* @param {number[]} request.params
|
157
180
|
* Additional search parameters.
|
158
181
|
*
|
@@ -165,10 +188,10 @@ export declare class SearchServiceClient {
|
|
165
188
|
* which enables image searching.
|
166
189
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
167
190
|
* The query expansion specification that specifies the conditions under which
|
168
|
-
* query expansion
|
191
|
+
* query expansion occurs.
|
169
192
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
|
170
193
|
* The spell correction specification that specifies the mode under
|
171
|
-
* which spell correction
|
194
|
+
* which spell correction takes effect.
|
172
195
|
* @param {string} request.userPseudoId
|
173
196
|
* A unique identifier for tracking visitors. For example, this could be
|
174
197
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -178,18 +201,17 @@ export declare class SearchServiceClient {
|
|
178
201
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
179
202
|
*
|
180
203
|
* This should be the same identifier as
|
181
|
-
* {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
204
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
182
205
|
* and
|
183
|
-
* {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
206
|
+
* {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
184
207
|
*
|
185
208
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
186
209
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
187
210
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
188
|
-
*
|
189
|
-
* search.
|
211
|
+
* A specification for configuring the behavior of content search.
|
190
212
|
* @param {boolean} request.safeSearch
|
191
213
|
* Whether to turn on safe search. This is only supported for
|
192
|
-
*
|
214
|
+
* website search.
|
193
215
|
* @param {number[]} request.userLabels
|
194
216
|
* The user labels applied to a resource must meet the following requirements:
|
195
217
|
*
|
@@ -211,14 +233,13 @@ export declare class SearchServiceClient {
|
|
211
233
|
* @param {object} [options]
|
212
234
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
213
235
|
* @returns {Promise} - The promise which resolves to an array.
|
214
|
-
* The first element of the array is Array of {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult
|
236
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}.
|
215
237
|
* The client library will perform auto-pagination by default: it will call the API as many
|
216
238
|
* times as needed and will merge results from all the pages into this array.
|
217
239
|
* Note that it can affect your quota.
|
218
240
|
* We recommend using `searchAsync()`
|
219
241
|
* method described below for async iteration which you can stop as needed.
|
220
|
-
* Please see the
|
221
|
-
* [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 }
|
222
243
|
* for more details and examples.
|
223
244
|
*/
|
224
245
|
search(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Promise<[
|
@@ -245,34 +266,57 @@ export declare class SearchServiceClient {
|
|
245
266
|
* documents under the default branch.
|
246
267
|
* @param {string} request.query
|
247
268
|
* Raw search query.
|
269
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
|
270
|
+
* Raw image query.
|
248
271
|
* @param {number} request.pageSize
|
249
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
272
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
250
273
|
* return. If unspecified, defaults to a reasonable value. The maximum allowed
|
251
|
-
* value is 100. Values above 100
|
274
|
+
* value is 100. Values above 100 are coerced to 100.
|
252
275
|
*
|
253
276
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
254
277
|
* @param {string} request.pageToken
|
255
278
|
* A page token received from a previous
|
256
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
279
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
257
280
|
* call. Provide this to retrieve the subsequent page.
|
258
281
|
*
|
259
282
|
* When paginating, all other parameters provided to
|
260
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
283
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
261
284
|
* must match the call that provided the page token. Otherwise, an
|
262
285
|
* `INVALID_ARGUMENT` error is returned.
|
263
286
|
* @param {number} request.offset
|
264
287
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
265
288
|
* result location, amongst the
|
266
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
289
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
267
290
|
* relevant) in search results. This field is only considered if
|
268
|
-
* {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
291
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
269
292
|
* unset.
|
270
293
|
*
|
271
294
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
295
|
+
* @param {string} request.filter
|
296
|
+
* The filter syntax consists of an expression language for constructing a
|
297
|
+
* predicate from one or more fields of the documents being filtered. Filter
|
298
|
+
* expression is case-sensitive.
|
299
|
+
*
|
300
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
301
|
+
* @param {string} request.orderBy
|
302
|
+
* The order in which documents are returned. Documents can be ordered by
|
303
|
+
* a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
|
304
|
+
* Leave it unset if ordered by relevance. `order_by` expression is
|
305
|
+
* case-sensitive.
|
306
|
+
*
|
307
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
272
308
|
* @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
|
273
309
|
* Information about the end user.
|
274
|
-
* Highly recommended for analytics.
|
275
|
-
*
|
310
|
+
* Highly recommended for analytics.
|
311
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
|
312
|
+
* is used to deduce `device_type` for analytics.
|
313
|
+
* @param {number[]} request.facetSpecs
|
314
|
+
* Facet specifications for faceted search. If empty, no facets are returned.
|
315
|
+
*
|
316
|
+
* A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
|
317
|
+
* error is returned.
|
318
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
|
319
|
+
* Boost specification to boost certain documents.
|
276
320
|
* @param {number[]} request.params
|
277
321
|
* Additional search parameters.
|
278
322
|
*
|
@@ -285,10 +329,10 @@ export declare class SearchServiceClient {
|
|
285
329
|
* which enables image searching.
|
286
330
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
287
331
|
* The query expansion specification that specifies the conditions under which
|
288
|
-
* query expansion
|
332
|
+
* query expansion occurs.
|
289
333
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
|
290
334
|
* The spell correction specification that specifies the mode under
|
291
|
-
* which spell correction
|
335
|
+
* which spell correction takes effect.
|
292
336
|
* @param {string} request.userPseudoId
|
293
337
|
* A unique identifier for tracking visitors. For example, this could be
|
294
338
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -298,18 +342,17 @@ export declare class SearchServiceClient {
|
|
298
342
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
299
343
|
*
|
300
344
|
* This should be the same identifier as
|
301
|
-
* {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
345
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
302
346
|
* and
|
303
|
-
* {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
347
|
+
* {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
304
348
|
*
|
305
349
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
306
350
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
307
351
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
308
|
-
*
|
309
|
-
* search.
|
352
|
+
* A specification for configuring the behavior of content search.
|
310
353
|
* @param {boolean} request.safeSearch
|
311
354
|
* Whether to turn on safe search. This is only supported for
|
312
|
-
*
|
355
|
+
* website search.
|
313
356
|
* @param {number[]} request.userLabels
|
314
357
|
* The user labels applied to a resource must meet the following requirements:
|
315
358
|
*
|
@@ -331,13 +374,12 @@ export declare class SearchServiceClient {
|
|
331
374
|
* @param {object} [options]
|
332
375
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
333
376
|
* @returns {Stream}
|
334
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult
|
377
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult} on 'data' event.
|
335
378
|
* The client library will perform auto-pagination by default: it will call the API as many
|
336
379
|
* times as needed. Note that it can affect your quota.
|
337
380
|
* We recommend using `searchAsync()`
|
338
381
|
* method described below for async iteration which you can stop as needed.
|
339
|
-
* Please see the
|
340
|
-
* [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 }
|
341
383
|
* for more details and examples.
|
342
384
|
*/
|
343
385
|
searchStream(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): Transform;
|
@@ -360,34 +402,57 @@ export declare class SearchServiceClient {
|
|
360
402
|
* documents under the default branch.
|
361
403
|
* @param {string} request.query
|
362
404
|
* Raw search query.
|
405
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.ImageQuery} request.imageQuery
|
406
|
+
* Raw image query.
|
363
407
|
* @param {number} request.pageSize
|
364
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
408
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
365
409
|
* return. If unspecified, defaults to a reasonable value. The maximum allowed
|
366
|
-
* value is 100. Values above 100
|
410
|
+
* value is 100. Values above 100 are coerced to 100.
|
367
411
|
*
|
368
412
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
369
413
|
* @param {string} request.pageToken
|
370
414
|
* A page token received from a previous
|
371
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
415
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
372
416
|
* call. Provide this to retrieve the subsequent page.
|
373
417
|
*
|
374
418
|
* When paginating, all other parameters provided to
|
375
|
-
* {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
419
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
|
376
420
|
* must match the call that provided the page token. Otherwise, an
|
377
421
|
* `INVALID_ARGUMENT` error is returned.
|
378
422
|
* @param {number} request.offset
|
379
423
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
380
424
|
* result location, amongst the
|
381
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
425
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s deemed by the API as
|
382
426
|
* relevant) in search results. This field is only considered if
|
383
|
-
* {@link google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
427
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchRequest.page_token|page_token} is
|
384
428
|
* unset.
|
385
429
|
*
|
386
430
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
431
|
+
* @param {string} request.filter
|
432
|
+
* The filter syntax consists of an expression language for constructing a
|
433
|
+
* predicate from one or more fields of the documents being filtered. Filter
|
434
|
+
* expression is case-sensitive.
|
435
|
+
*
|
436
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
437
|
+
* @param {string} request.orderBy
|
438
|
+
* The order in which documents are returned. Documents can be ordered by
|
439
|
+
* a field in an {@link protos.google.cloud.discoveryengine.v1.Document|Document} object.
|
440
|
+
* Leave it unset if ordered by relevance. `order_by` expression is
|
441
|
+
* case-sensitive.
|
442
|
+
*
|
443
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
387
444
|
* @param {google.cloud.discoveryengine.v1.UserInfo} request.userInfo
|
388
445
|
* Information about the end user.
|
389
|
-
* Highly recommended for analytics.
|
390
|
-
*
|
446
|
+
* Highly recommended for analytics.
|
447
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_agent|UserInfo.user_agent}
|
448
|
+
* is used to deduce `device_type` for analytics.
|
449
|
+
* @param {number[]} request.facetSpecs
|
450
|
+
* Facet specifications for faceted search. If empty, no facets are returned.
|
451
|
+
*
|
452
|
+
* A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
|
453
|
+
* error is returned.
|
454
|
+
* @param {google.cloud.discoveryengine.v1.SearchRequest.BoostSpec} request.boostSpec
|
455
|
+
* Boost specification to boost certain documents.
|
391
456
|
* @param {number[]} request.params
|
392
457
|
* Additional search parameters.
|
393
458
|
*
|
@@ -400,10 +465,10 @@ export declare class SearchServiceClient {
|
|
400
465
|
* which enables image searching.
|
401
466
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
402
467
|
* The query expansion specification that specifies the conditions under which
|
403
|
-
* query expansion
|
468
|
+
* query expansion occurs.
|
404
469
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
|
405
470
|
* The spell correction specification that specifies the mode under
|
406
|
-
* which spell correction
|
471
|
+
* which spell correction takes effect.
|
407
472
|
* @param {string} request.userPseudoId
|
408
473
|
* A unique identifier for tracking visitors. For example, this could be
|
409
474
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -413,18 +478,17 @@ export declare class SearchServiceClient {
|
|
413
478
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
414
479
|
*
|
415
480
|
* This should be the same identifier as
|
416
|
-
* {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
481
|
+
* {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
417
482
|
* and
|
418
|
-
* {@link google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
483
|
+
* {@link protos.google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
419
484
|
*
|
420
485
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
421
486
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
422
487
|
* @param {google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
423
|
-
*
|
424
|
-
* search.
|
488
|
+
* A specification for configuring the behavior of content search.
|
425
489
|
* @param {boolean} request.safeSearch
|
426
490
|
* Whether to turn on safe search. This is only supported for
|
427
|
-
*
|
491
|
+
* website search.
|
428
492
|
* @param {number[]} request.userLabels
|
429
493
|
* The user labels applied to a resource must meet the following requirements:
|
430
494
|
*
|
@@ -446,17 +510,67 @@ export declare class SearchServiceClient {
|
|
446
510
|
* @param {object} [options]
|
447
511
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
448
512
|
* @returns {Object}
|
449
|
-
* 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 }.
|
450
514
|
* When you iterate the returned iterable, each element will be an object representing
|
451
|
-
* {@link google.cloud.discoveryengine.v1.SearchResponse.SearchResult
|
515
|
+
* {@link protos.google.cloud.discoveryengine.v1.SearchResponse.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
|
452
516
|
* so you can stop the iteration when you don't need more results.
|
453
|
-
* Please see the
|
454
|
-
* [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 }
|
455
518
|
* for more details and examples.
|
456
519
|
* @example <caption>include:samples/generated/v1/search_service.search.js</caption>
|
457
520
|
* region_tag:discoveryengine_v1_generated_SearchService_Search_async
|
458
521
|
*/
|
459
522
|
searchAsync(request?: protos.google.cloud.discoveryengine.v1.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.SearchResponse.ISearchResult>;
|
523
|
+
/**
|
524
|
+
* Gets information about a location.
|
525
|
+
*
|
526
|
+
* @param {Object} request
|
527
|
+
* The request object that will be sent.
|
528
|
+
* @param {string} request.name
|
529
|
+
* Resource name for the location.
|
530
|
+
* @param {object} [options]
|
531
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
532
|
+
* @returns {Promise} - The promise which resolves to an array.
|
533
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
534
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
535
|
+
* for more details and examples.
|
536
|
+
* @example
|
537
|
+
* ```
|
538
|
+
* const [response] = await client.getLocation(request);
|
539
|
+
* ```
|
540
|
+
*/
|
541
|
+
getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
|
542
|
+
/**
|
543
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
544
|
+
*
|
545
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
546
|
+
* @param {Object} request
|
547
|
+
* The request object that will be sent.
|
548
|
+
* @param {string} request.name
|
549
|
+
* The resource that owns the locations collection, if applicable.
|
550
|
+
* @param {string} request.filter
|
551
|
+
* The standard list filter.
|
552
|
+
* @param {number} request.pageSize
|
553
|
+
* The standard list page size.
|
554
|
+
* @param {string} request.pageToken
|
555
|
+
* The standard list page token.
|
556
|
+
* @param {object} [options]
|
557
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
558
|
+
* @returns {Object}
|
559
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
560
|
+
* When you iterate the returned iterable, each element will be an object representing
|
561
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
562
|
+
* so you can stop the iteration when you don't need more results.
|
563
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
564
|
+
* for more details and examples.
|
565
|
+
* @example
|
566
|
+
* ```
|
567
|
+
* const iterable = client.listLocationsAsync(request);
|
568
|
+
* for await (const response of iterable) {
|
569
|
+
* // process response
|
570
|
+
* }
|
571
|
+
* ```
|
572
|
+
*/
|
573
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
460
574
|
/**
|
461
575
|
* Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
|
462
576
|
*
|
@@ -568,6 +682,57 @@ export declare class SearchServiceClient {
|
|
568
682
|
* @returns {string} A string representing the document.
|
569
683
|
*/
|
570
684
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
685
|
+
/**
|
686
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
687
|
+
*
|
688
|
+
* @param {string} project
|
689
|
+
* @param {string} location
|
690
|
+
* @param {string} collection
|
691
|
+
* @param {string} data_store
|
692
|
+
* @param {string} conversation
|
693
|
+
* @returns {string} Resource name string.
|
694
|
+
*/
|
695
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
696
|
+
/**
|
697
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
698
|
+
*
|
699
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
700
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
701
|
+
* @returns {string} A string representing the project.
|
702
|
+
*/
|
703
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
704
|
+
/**
|
705
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
706
|
+
*
|
707
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
708
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
709
|
+
* @returns {string} A string representing the location.
|
710
|
+
*/
|
711
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
712
|
+
/**
|
713
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
714
|
+
*
|
715
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
716
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
717
|
+
* @returns {string} A string representing the collection.
|
718
|
+
*/
|
719
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
720
|
+
/**
|
721
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
722
|
+
*
|
723
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
724
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
725
|
+
* @returns {string} A string representing the data_store.
|
726
|
+
*/
|
727
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
728
|
+
/**
|
729
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
730
|
+
*
|
731
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
732
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
733
|
+
* @returns {string} A string representing the conversation.
|
734
|
+
*/
|
735
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
571
736
|
/**
|
572
737
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
573
738
|
*
|
@@ -763,6 +928,48 @@ export declare class SearchServiceClient {
|
|
763
928
|
* @returns {string} A string representing the document.
|
764
929
|
*/
|
765
930
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
931
|
+
/**
|
932
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
933
|
+
*
|
934
|
+
* @param {string} project
|
935
|
+
* @param {string} location
|
936
|
+
* @param {string} data_store
|
937
|
+
* @param {string} conversation
|
938
|
+
* @returns {string} Resource name string.
|
939
|
+
*/
|
940
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
941
|
+
/**
|
942
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
943
|
+
*
|
944
|
+
* @param {string} projectLocationDataStoreConversationName
|
945
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
946
|
+
* @returns {string} A string representing the project.
|
947
|
+
*/
|
948
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
949
|
+
/**
|
950
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
951
|
+
*
|
952
|
+
* @param {string} projectLocationDataStoreConversationName
|
953
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
954
|
+
* @returns {string} A string representing the location.
|
955
|
+
*/
|
956
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
957
|
+
/**
|
958
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
959
|
+
*
|
960
|
+
* @param {string} projectLocationDataStoreConversationName
|
961
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
962
|
+
* @returns {string} A string representing the data_store.
|
963
|
+
*/
|
964
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
965
|
+
/**
|
966
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
967
|
+
*
|
968
|
+
* @param {string} projectLocationDataStoreConversationName
|
969
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
970
|
+
* @returns {string} A string representing the conversation.
|
971
|
+
*/
|
972
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
766
973
|
/**
|
767
974
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
768
975
|
*
|