@google-cloud/discoveryengine 1.1.0 → 1.2.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.
Files changed (49) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +26 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +155 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +221 -0
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +851 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
  18. package/build/protos/protos.d.ts +12587 -7
  19. package/build/protos/protos.js +34918 -3126
  20. package/build/protos/protos.json +3458 -5
  21. package/build/src/index.d.ts +3 -1
  22. package/build/src/index.js +4 -1
  23. package/build/src/v1alpha/completion_service_client.d.ts +603 -0
  24. package/build/src/v1alpha/completion_service_client.js +843 -0
  25. package/build/src/v1alpha/completion_service_client_config.json +43 -0
  26. package/build/src/v1alpha/conversational_search_service_client.d.ts +998 -0
  27. package/build/src/v1alpha/conversational_search_service_client.js +1275 -0
  28. package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
  29. package/build/src/v1alpha/document_service_client.d.ts +1140 -0
  30. package/build/src/v1alpha/document_service_client.js +1393 -0
  31. package/build/src/v1alpha/document_service_client_config.json +82 -0
  32. package/build/src/v1alpha/index.d.ts +8 -0
  33. package/build/src/v1alpha/index.js +37 -0
  34. package/build/src/v1alpha/recommendation_service_client.d.ts +735 -0
  35. package/build/src/v1alpha/recommendation_service_client.js +938 -0
  36. package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
  37. package/build/src/v1alpha/schema_service_client.d.ts +935 -0
  38. package/build/src/v1alpha/schema_service_client.js +1327 -0
  39. package/build/src/v1alpha/schema_service_client_config.json +63 -0
  40. package/build/src/v1alpha/search_service_client.d.ts +1208 -0
  41. package/build/src/v1alpha/search_service_client.js +1432 -0
  42. package/build/src/v1alpha/search_service_client_config.json +43 -0
  43. package/build/src/v1alpha/site_search_engine_service_client.d.ts +704 -0
  44. package/build/src/v1alpha/site_search_engine_service_client.js +1087 -0
  45. package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
  46. package/build/src/v1alpha/user_event_service_client.d.ts +853 -0
  47. package/build/src/v1alpha/user_event_service_client.js +1174 -0
  48. package/build/src/v1alpha/user_event_service_client_config.json +67 -0
  49. package/package.json +3 -3
@@ -0,0 +1,1208 @@
1
+ /// <reference types="node" />
2
+ import type * as gax from 'google-gax';
3
+ import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
4
+ import { Transform } from 'stream';
5
+ import * as protos from '../../protos/protos';
6
+ /**
7
+ * Service for search.
8
+ * @class
9
+ * @memberof v1alpha
10
+ */
11
+ export declare class SearchServiceClient {
12
+ private _terminated;
13
+ private _opts;
14
+ private _providedCustomServicePath;
15
+ private _gaxModule;
16
+ private _gaxGrpc;
17
+ private _protos;
18
+ private _defaults;
19
+ auth: gax.GoogleAuth;
20
+ descriptors: Descriptors;
21
+ warn: (code: string, message: string, warnType?: string) => void;
22
+ innerApiCalls: {
23
+ [name: string]: Function;
24
+ };
25
+ locationsClient: LocationsClient;
26
+ pathTemplates: {
27
+ [name: string]: gax.PathTemplate;
28
+ };
29
+ searchServiceStub?: Promise<{
30
+ [name: string]: Function;
31
+ }>;
32
+ /**
33
+ * Construct an instance of SearchServiceClient.
34
+ *
35
+ * @param {object} [options] - The configuration object.
36
+ * The options accepted by the constructor are described in detail
37
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
38
+ * The common options are:
39
+ * @param {object} [options.credentials] - Credentials object.
40
+ * @param {string} [options.credentials.client_email]
41
+ * @param {string} [options.credentials.private_key]
42
+ * @param {string} [options.email] - Account email address. Required when
43
+ * using a .pem or .p12 keyFilename.
44
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
45
+ * .p12 key downloaded from the Google Developers Console. If you provide
46
+ * a path to a JSON file, the projectId option below is not necessary.
47
+ * NOTE: .pem and .p12 require you to specify options.email as well.
48
+ * @param {number} [options.port] - The port on which to connect to
49
+ * the remote host.
50
+ * @param {string} [options.projectId] - The project ID from the Google
51
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
52
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
53
+ * app is running in an environment which supports
54
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
55
+ * your project ID will be detected automatically.
56
+ * @param {string} [options.apiEndpoint] - The domain name of the
57
+ * API remote host.
58
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
59
+ * Follows the structure of {@link gapicConfig}.
60
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
61
+ * For more information, please check the
62
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
63
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
64
+ * need to avoid loading the default gRPC version and want to use the fallback
65
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
66
+ * ```
67
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
68
+ * const client = new SearchServiceClient({fallback: true}, gax);
69
+ * ```
70
+ */
71
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
72
+ /**
73
+ * Initialize the client.
74
+ * Performs asynchronous operations (such as authentication) and prepares the client.
75
+ * This function will be called automatically when any class method is called for the
76
+ * first time, but if you need to initialize it before calling an actual method,
77
+ * feel free to call initialize() directly.
78
+ *
79
+ * You can await on this method if you want to make sure the client is initialized.
80
+ *
81
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
82
+ */
83
+ initialize(): Promise<{
84
+ [name: string]: Function;
85
+ }>;
86
+ /**
87
+ * The DNS address for this API service.
88
+ * @returns {string} The DNS address for this service.
89
+ */
90
+ static get servicePath(): string;
91
+ /**
92
+ * The DNS address for this API service - same as servicePath(),
93
+ * exists for compatibility reasons.
94
+ * @returns {string} The DNS address for this service.
95
+ */
96
+ static get apiEndpoint(): string;
97
+ /**
98
+ * The port for this API service.
99
+ * @returns {number} The default port for this service.
100
+ */
101
+ static get port(): number;
102
+ /**
103
+ * The scopes needed to make gRPC calls for every method defined
104
+ * in this service.
105
+ * @returns {string[]} List of default scopes.
106
+ */
107
+ static get scopes(): string[];
108
+ getProjectId(): Promise<string>;
109
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
110
+ /**
111
+ * Performs a search.
112
+ *
113
+ * @param {Object} request
114
+ * The request object that will be sent.
115
+ * @param {string} request.servingConfig
116
+ * Required. The resource name of the Search serving config, such as
117
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
118
+ * This field is used to identify the serving configuration name, set
119
+ * of models used to make the search.
120
+ * @param {string} request.branch
121
+ * The branch resource name, such as
122
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
123
+ *
124
+ * Use `default_branch` as the branch ID or leave this field empty, to search
125
+ * documents under the default branch.
126
+ * @param {string} request.query
127
+ * Raw search query.
128
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery} request.imageQuery
129
+ * Raw image query.
130
+ * @param {number} request.pageSize
131
+ * Maximum number of
132
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
133
+ * unspecified, defaults to a reasonable value. The maximum allowed value is
134
+ * 100. Values above 100 are coerced to 100.
135
+ *
136
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
137
+ * @param {string} request.pageToken
138
+ * A page token received from a previous
139
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
140
+ * call. Provide this to retrieve the subsequent page.
141
+ *
142
+ * When paginating, all other parameters provided to
143
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
144
+ * must match the call that provided the page token. Otherwise, an
145
+ * `INVALID_ARGUMENT` error is returned.
146
+ * @param {number} request.offset
147
+ * A 0-indexed integer that specifies the current offset (that is, starting
148
+ * result location, amongst the
149
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s deemed by the
150
+ * API as relevant) in search results. This field is only considered if
151
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.page_token|page_token}
152
+ * is unset.
153
+ *
154
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
155
+ * @param {string} request.filter
156
+ * The filter syntax consists of an expression language for constructing a
157
+ * predicate from one or more fields of the documents being filtered. Filter
158
+ * expression is case-sensitive.
159
+ *
160
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
161
+ * @param {string} request.orderBy
162
+ * The order in which documents are returned. Documents can be ordered by
163
+ * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
164
+ * object. Leave it unset if ordered by relevance. `order_by` expression is
165
+ * case-sensitive.
166
+ *
167
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
168
+ * @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
169
+ * Information about the end user.
170
+ * Highly recommended for analytics.
171
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
172
+ * is used to deduce `device_type` for analytics.
173
+ * @param {number[]} request.facetSpecs
174
+ * Facet specifications for faceted search. If empty, no facets are returned.
175
+ *
176
+ * A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
177
+ * error is returned.
178
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec} request.boostSpec
179
+ * Boost specification to boost certain documents.
180
+ * @param {number[]} request.params
181
+ * Additional search parameters.
182
+ *
183
+ * For public website search only, supported values are:
184
+ *
185
+ * * `user_country_code`: string. Default empty. If set to non-empty, results
186
+ * are restricted or boosted based on the location provided.
187
+ * * `search_type`: double. Default empty. Enables non-webpage searching
188
+ * depending on the value. The only valid non-default value is 1,
189
+ * which enables image searching.
190
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
191
+ * The query expansion specification that specifies the conditions under which
192
+ * query expansion occurs.
193
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
194
+ * The spell correction specification that specifies the mode under
195
+ * which spell correction takes effect.
196
+ * @param {string} request.userPseudoId
197
+ * A unique identifier for tracking visitors. For example, this could be
198
+ * implemented with an HTTP cookie, which should be able to uniquely identify
199
+ * a visitor on a single device. This unique identifier should not change if
200
+ * the visitor logs in or out of the website.
201
+ *
202
+ * This field should NOT have a fixed value such as `unknown_visitor`.
203
+ *
204
+ * This should be the same identifier as
205
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
206
+ * and
207
+ * {@link protos.google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
208
+ *
209
+ * The field must be a UTF-8 encoded string with a length limit of 128
210
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
211
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec} request.contentSearchSpec
212
+ * A specification for configuring the behavior of content search.
213
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec} request.embeddingSpec
214
+ * Uses the provided embedding to do additional semantic document retrieval.
215
+ * The retrieval is based on the dot product of
216
+ * {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
217
+ * embedding that is provided in
218
+ * {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
219
+ *
220
+ * If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
221
+ * provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
222
+ * @param {string} request.rankingExpression
223
+ * The ranking expression controls the customized ranking on retrieval
224
+ * documents. This overrides
225
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
226
+ * The ranking expression is a single function or multiple functions that are
227
+ * joint by "+".
228
+ * * ranking_expression = function, { " + ", function };
229
+ * Supported functions:
230
+ * * double * relevance_score
231
+ * * double * dotProduct(embedding_field_path)
232
+ * Function variables:
233
+ * `relevance_score`: pre-defined keywords, used for measure relevance
234
+ * between query and document.
235
+ * `embedding_field_path`: the document embedding field
236
+ * used with query embedding vector.
237
+ * `dotProduct`: embedding function between embedding_field_path and query
238
+ * embedding vector.
239
+ *
240
+ * Example ranking expression:
241
+ * If document has an embedding field doc_embedding, the ranking expression
242
+ * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
243
+ * @param {boolean} request.safeSearch
244
+ * Whether to turn on safe search. This is only supported for
245
+ * website search.
246
+ * @param {number[]} request.userLabels
247
+ * The user labels applied to a resource must meet the following requirements:
248
+ *
249
+ * * Each resource can have multiple labels, up to a maximum of 64.
250
+ * * Each label must be a key-value pair.
251
+ * * Keys have a minimum length of 1 character and a maximum length of 63
252
+ * characters and cannot be empty. Values can be empty and have a maximum
253
+ * length of 63 characters.
254
+ * * Keys and values can contain only lowercase letters, numeric characters,
255
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
256
+ * international characters are allowed.
257
+ * * The key portion of a label must be unique. However, you can use the same
258
+ * key with multiple resources.
259
+ * * Keys must start with a lowercase letter or international character.
260
+ *
261
+ * See [Google Cloud
262
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
263
+ * for more details.
264
+ * @param {object} [options]
265
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
266
+ * @returns {Promise} - The promise which resolves to an array.
267
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult|SearchResult}.
268
+ * The client library will perform auto-pagination by default: it will call the API as many
269
+ * times as needed and will merge results from all the pages into this array.
270
+ * Note that it can affect your quota.
271
+ * We recommend using `searchAsync()`
272
+ * method described below for async iteration which you can stop as needed.
273
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
274
+ * for more details and examples.
275
+ */
276
+ search(request?: protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, options?: CallOptions): Promise<[
277
+ protos.google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult[],
278
+ protos.google.cloud.discoveryengine.v1alpha.ISearchRequest | null,
279
+ protos.google.cloud.discoveryengine.v1alpha.ISearchResponse
280
+ ]>;
281
+ search(request: protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, protos.google.cloud.discoveryengine.v1alpha.ISearchResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult>): void;
282
+ search(request: protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, protos.google.cloud.discoveryengine.v1alpha.ISearchResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult>): void;
283
+ /**
284
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
285
+ * @param {Object} request
286
+ * The request object that will be sent.
287
+ * @param {string} request.servingConfig
288
+ * Required. The resource name of the Search serving config, such as
289
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
290
+ * This field is used to identify the serving configuration name, set
291
+ * of models used to make the search.
292
+ * @param {string} request.branch
293
+ * The branch resource name, such as
294
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
295
+ *
296
+ * Use `default_branch` as the branch ID or leave this field empty, to search
297
+ * documents under the default branch.
298
+ * @param {string} request.query
299
+ * Raw search query.
300
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery} request.imageQuery
301
+ * Raw image query.
302
+ * @param {number} request.pageSize
303
+ * Maximum number of
304
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
305
+ * unspecified, defaults to a reasonable value. The maximum allowed value is
306
+ * 100. Values above 100 are coerced to 100.
307
+ *
308
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
309
+ * @param {string} request.pageToken
310
+ * A page token received from a previous
311
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
312
+ * call. Provide this to retrieve the subsequent page.
313
+ *
314
+ * When paginating, all other parameters provided to
315
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
316
+ * must match the call that provided the page token. Otherwise, an
317
+ * `INVALID_ARGUMENT` error is returned.
318
+ * @param {number} request.offset
319
+ * A 0-indexed integer that specifies the current offset (that is, starting
320
+ * result location, amongst the
321
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s deemed by the
322
+ * API as relevant) in search results. This field is only considered if
323
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.page_token|page_token}
324
+ * is unset.
325
+ *
326
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
327
+ * @param {string} request.filter
328
+ * The filter syntax consists of an expression language for constructing a
329
+ * predicate from one or more fields of the documents being filtered. Filter
330
+ * expression is case-sensitive.
331
+ *
332
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
333
+ * @param {string} request.orderBy
334
+ * The order in which documents are returned. Documents can be ordered by
335
+ * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
336
+ * object. Leave it unset if ordered by relevance. `order_by` expression is
337
+ * case-sensitive.
338
+ *
339
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
340
+ * @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
341
+ * Information about the end user.
342
+ * Highly recommended for analytics.
343
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
344
+ * is used to deduce `device_type` for analytics.
345
+ * @param {number[]} request.facetSpecs
346
+ * Facet specifications for faceted search. If empty, no facets are returned.
347
+ *
348
+ * A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
349
+ * error is returned.
350
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec} request.boostSpec
351
+ * Boost specification to boost certain documents.
352
+ * @param {number[]} request.params
353
+ * Additional search parameters.
354
+ *
355
+ * For public website search only, supported values are:
356
+ *
357
+ * * `user_country_code`: string. Default empty. If set to non-empty, results
358
+ * are restricted or boosted based on the location provided.
359
+ * * `search_type`: double. Default empty. Enables non-webpage searching
360
+ * depending on the value. The only valid non-default value is 1,
361
+ * which enables image searching.
362
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
363
+ * The query expansion specification that specifies the conditions under which
364
+ * query expansion occurs.
365
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
366
+ * The spell correction specification that specifies the mode under
367
+ * which spell correction takes effect.
368
+ * @param {string} request.userPseudoId
369
+ * A unique identifier for tracking visitors. For example, this could be
370
+ * implemented with an HTTP cookie, which should be able to uniquely identify
371
+ * a visitor on a single device. This unique identifier should not change if
372
+ * the visitor logs in or out of the website.
373
+ *
374
+ * This field should NOT have a fixed value such as `unknown_visitor`.
375
+ *
376
+ * This should be the same identifier as
377
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
378
+ * and
379
+ * {@link protos.google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
380
+ *
381
+ * The field must be a UTF-8 encoded string with a length limit of 128
382
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
383
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec} request.contentSearchSpec
384
+ * A specification for configuring the behavior of content search.
385
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec} request.embeddingSpec
386
+ * Uses the provided embedding to do additional semantic document retrieval.
387
+ * The retrieval is based on the dot product of
388
+ * {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
389
+ * embedding that is provided in
390
+ * {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
391
+ *
392
+ * If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
393
+ * provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
394
+ * @param {string} request.rankingExpression
395
+ * The ranking expression controls the customized ranking on retrieval
396
+ * documents. This overrides
397
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
398
+ * The ranking expression is a single function or multiple functions that are
399
+ * joint by "+".
400
+ * * ranking_expression = function, { " + ", function };
401
+ * Supported functions:
402
+ * * double * relevance_score
403
+ * * double * dotProduct(embedding_field_path)
404
+ * Function variables:
405
+ * `relevance_score`: pre-defined keywords, used for measure relevance
406
+ * between query and document.
407
+ * `embedding_field_path`: the document embedding field
408
+ * used with query embedding vector.
409
+ * `dotProduct`: embedding function between embedding_field_path and query
410
+ * embedding vector.
411
+ *
412
+ * Example ranking expression:
413
+ * If document has an embedding field doc_embedding, the ranking expression
414
+ * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
415
+ * @param {boolean} request.safeSearch
416
+ * Whether to turn on safe search. This is only supported for
417
+ * website search.
418
+ * @param {number[]} request.userLabels
419
+ * The user labels applied to a resource must meet the following requirements:
420
+ *
421
+ * * Each resource can have multiple labels, up to a maximum of 64.
422
+ * * Each label must be a key-value pair.
423
+ * * Keys have a minimum length of 1 character and a maximum length of 63
424
+ * characters and cannot be empty. Values can be empty and have a maximum
425
+ * length of 63 characters.
426
+ * * Keys and values can contain only lowercase letters, numeric characters,
427
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
428
+ * international characters are allowed.
429
+ * * The key portion of a label must be unique. However, you can use the same
430
+ * key with multiple resources.
431
+ * * Keys must start with a lowercase letter or international character.
432
+ *
433
+ * See [Google Cloud
434
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
435
+ * for more details.
436
+ * @param {object} [options]
437
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
438
+ * @returns {Stream}
439
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult|SearchResult} on 'data' event.
440
+ * The client library will perform auto-pagination by default: it will call the API as many
441
+ * times as needed. Note that it can affect your quota.
442
+ * We recommend using `searchAsync()`
443
+ * method described below for async iteration which you can stop as needed.
444
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
445
+ * for more details and examples.
446
+ */
447
+ searchStream(request?: protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, options?: CallOptions): Transform;
448
+ /**
449
+ * Equivalent to `search`, but returns an iterable object.
450
+ *
451
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
452
+ * @param {Object} request
453
+ * The request object that will be sent.
454
+ * @param {string} request.servingConfig
455
+ * Required. The resource name of the Search serving config, such as
456
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
457
+ * This field is used to identify the serving configuration name, set
458
+ * of models used to make the search.
459
+ * @param {string} request.branch
460
+ * The branch resource name, such as
461
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
462
+ *
463
+ * Use `default_branch` as the branch ID or leave this field empty, to search
464
+ * documents under the default branch.
465
+ * @param {string} request.query
466
+ * Raw search query.
467
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ImageQuery} request.imageQuery
468
+ * Raw image query.
469
+ * @param {number} request.pageSize
470
+ * Maximum number of
471
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s to return. If
472
+ * unspecified, defaults to a reasonable value. The maximum allowed value is
473
+ * 100. Values above 100 are coerced to 100.
474
+ *
475
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
476
+ * @param {string} request.pageToken
477
+ * A page token received from a previous
478
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
479
+ * call. Provide this to retrieve the subsequent page.
480
+ *
481
+ * When paginating, all other parameters provided to
482
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
483
+ * must match the call that provided the page token. Otherwise, an
484
+ * `INVALID_ARGUMENT` error is returned.
485
+ * @param {number} request.offset
486
+ * A 0-indexed integer that specifies the current offset (that is, starting
487
+ * result location, amongst the
488
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s deemed by the
489
+ * API as relevant) in search results. This field is only considered if
490
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.page_token|page_token}
491
+ * is unset.
492
+ *
493
+ * If this field is negative, an `INVALID_ARGUMENT` is returned.
494
+ * @param {string} request.filter
495
+ * The filter syntax consists of an expression language for constructing a
496
+ * predicate from one or more fields of the documents being filtered. Filter
497
+ * expression is case-sensitive.
498
+ *
499
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
500
+ * @param {string} request.orderBy
501
+ * The order in which documents are returned. Documents can be ordered by
502
+ * a field in an {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}
503
+ * object. Leave it unset if ordered by relevance. `order_by` expression is
504
+ * case-sensitive.
505
+ *
506
+ * If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
507
+ * @param {google.cloud.discoveryengine.v1alpha.UserInfo} request.userInfo
508
+ * Information about the end user.
509
+ * Highly recommended for analytics.
510
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_agent|UserInfo.user_agent}
511
+ * is used to deduce `device_type` for analytics.
512
+ * @param {number[]} request.facetSpecs
513
+ * Facet specifications for faceted search. If empty, no facets are returned.
514
+ *
515
+ * A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
516
+ * error is returned.
517
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.BoostSpec} request.boostSpec
518
+ * Boost specification to boost certain documents.
519
+ * @param {number[]} request.params
520
+ * Additional search parameters.
521
+ *
522
+ * For public website search only, supported values are:
523
+ *
524
+ * * `user_country_code`: string. Default empty. If set to non-empty, results
525
+ * are restricted or boosted based on the location provided.
526
+ * * `search_type`: double. Default empty. Enables non-webpage searching
527
+ * depending on the value. The only valid non-default value is 1,
528
+ * which enables image searching.
529
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
530
+ * The query expansion specification that specifies the conditions under which
531
+ * query expansion occurs.
532
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
533
+ * The spell correction specification that specifies the mode under
534
+ * which spell correction takes effect.
535
+ * @param {string} request.userPseudoId
536
+ * A unique identifier for tracking visitors. For example, this could be
537
+ * implemented with an HTTP cookie, which should be able to uniquely identify
538
+ * a visitor on a single device. This unique identifier should not change if
539
+ * the visitor logs in or out of the website.
540
+ *
541
+ * This field should NOT have a fixed value such as `unknown_visitor`.
542
+ *
543
+ * This should be the same identifier as
544
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
545
+ * and
546
+ * {@link protos.google.cloud.discoveryengine.v1alpha.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
547
+ *
548
+ * The field must be a UTF-8 encoded string with a length limit of 128
549
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
550
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec} request.contentSearchSpec
551
+ * A specification for configuring the behavior of content search.
552
+ * @param {google.cloud.discoveryengine.v1alpha.SearchRequest.EmbeddingSpec} request.embeddingSpec
553
+ * Uses the provided embedding to do additional semantic document retrieval.
554
+ * The retrieval is based on the dot product of
555
+ * {@link protos.|SearchRequest.embedding_spec.embedding_vectors.vector} and the document
556
+ * embedding that is provided in
557
+ * {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path}.
558
+ *
559
+ * If {@link protos.|SearchRequest.embedding_spec.embedding_vectors.field_path} is not
560
+ * provided, it will use {@link protos.|ServingConfig.embedding_config.field_paths}.
561
+ * @param {string} request.rankingExpression
562
+ * The ranking expression controls the customized ranking on retrieval
563
+ * documents. This overrides
564
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig.ranking_expression|ServingConfig.ranking_expression}.
565
+ * The ranking expression is a single function or multiple functions that are
566
+ * joint by "+".
567
+ * * ranking_expression = function, { " + ", function };
568
+ * Supported functions:
569
+ * * double * relevance_score
570
+ * * double * dotProduct(embedding_field_path)
571
+ * Function variables:
572
+ * `relevance_score`: pre-defined keywords, used for measure relevance
573
+ * between query and document.
574
+ * `embedding_field_path`: the document embedding field
575
+ * used with query embedding vector.
576
+ * `dotProduct`: embedding function between embedding_field_path and query
577
+ * embedding vector.
578
+ *
579
+ * Example ranking expression:
580
+ * If document has an embedding field doc_embedding, the ranking expression
581
+ * could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
582
+ * @param {boolean} request.safeSearch
583
+ * Whether to turn on safe search. This is only supported for
584
+ * website search.
585
+ * @param {number[]} request.userLabels
586
+ * The user labels applied to a resource must meet the following requirements:
587
+ *
588
+ * * Each resource can have multiple labels, up to a maximum of 64.
589
+ * * Each label must be a key-value pair.
590
+ * * Keys have a minimum length of 1 character and a maximum length of 63
591
+ * characters and cannot be empty. Values can be empty and have a maximum
592
+ * length of 63 characters.
593
+ * * Keys and values can contain only lowercase letters, numeric characters,
594
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
595
+ * international characters are allowed.
596
+ * * The key portion of a label must be unique. However, you can use the same
597
+ * key with multiple resources.
598
+ * * Keys must start with a lowercase letter or international character.
599
+ *
600
+ * See [Google Cloud
601
+ * Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
602
+ * for more details.
603
+ * @param {object} [options]
604
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
605
+ * @returns {Object}
606
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
607
+ * When you iterate the returned iterable, each element will be an object representing
608
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchResponse.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
609
+ * so you can stop the iteration when you don't need more results.
610
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
611
+ * for more details and examples.
612
+ * @example <caption>include:samples/generated/v1alpha/search_service.search.js</caption>
613
+ * region_tag:discoveryengine_v1alpha_generated_SearchService_Search_async
614
+ */
615
+ searchAsync(request?: protos.google.cloud.discoveryengine.v1alpha.ISearchRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.SearchResponse.ISearchResult>;
616
+ /**
617
+ * Gets information about a location.
618
+ *
619
+ * @param {Object} request
620
+ * The request object that will be sent.
621
+ * @param {string} request.name
622
+ * Resource name for the location.
623
+ * @param {object} [options]
624
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
625
+ * @returns {Promise} - The promise which resolves to an array.
626
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
627
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
628
+ * for more details and examples.
629
+ * @example
630
+ * ```
631
+ * const [response] = await client.getLocation(request);
632
+ * ```
633
+ */
634
+ 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>;
635
+ /**
636
+ * Lists information about the supported locations for this service. Returns an iterable object.
637
+ *
638
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
639
+ * @param {Object} request
640
+ * The request object that will be sent.
641
+ * @param {string} request.name
642
+ * The resource that owns the locations collection, if applicable.
643
+ * @param {string} request.filter
644
+ * The standard list filter.
645
+ * @param {number} request.pageSize
646
+ * The standard list page size.
647
+ * @param {string} request.pageToken
648
+ * The standard list page token.
649
+ * @param {object} [options]
650
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
651
+ * @returns {Object}
652
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
653
+ * When you iterate the returned iterable, each element will be an object representing
654
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
655
+ * so you can stop the iteration when you don't need more results.
656
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
657
+ * for more details and examples.
658
+ * @example
659
+ * ```
660
+ * const iterable = client.listLocationsAsync(request);
661
+ * for await (const response of iterable) {
662
+ * // process response
663
+ * }
664
+ * ```
665
+ */
666
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
667
+ /**
668
+ * Return a fully-qualified projectLocationCollectionDataStoreBranch resource name string.
669
+ *
670
+ * @param {string} project
671
+ * @param {string} location
672
+ * @param {string} collection
673
+ * @param {string} data_store
674
+ * @param {string} branch
675
+ * @returns {string} Resource name string.
676
+ */
677
+ projectLocationCollectionDataStoreBranchPath(project: string, location: string, collection: string, dataStore: string, branch: string): string;
678
+ /**
679
+ * Parse the project from ProjectLocationCollectionDataStoreBranch resource.
680
+ *
681
+ * @param {string} projectLocationCollectionDataStoreBranchName
682
+ * A fully-qualified path representing project_location_collection_data_store_branch resource.
683
+ * @returns {string} A string representing the project.
684
+ */
685
+ matchProjectFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
686
+ /**
687
+ * Parse the location from ProjectLocationCollectionDataStoreBranch resource.
688
+ *
689
+ * @param {string} projectLocationCollectionDataStoreBranchName
690
+ * A fully-qualified path representing project_location_collection_data_store_branch resource.
691
+ * @returns {string} A string representing the location.
692
+ */
693
+ matchLocationFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
694
+ /**
695
+ * Parse the collection from ProjectLocationCollectionDataStoreBranch resource.
696
+ *
697
+ * @param {string} projectLocationCollectionDataStoreBranchName
698
+ * A fully-qualified path representing project_location_collection_data_store_branch resource.
699
+ * @returns {string} A string representing the collection.
700
+ */
701
+ matchCollectionFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
702
+ /**
703
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranch resource.
704
+ *
705
+ * @param {string} projectLocationCollectionDataStoreBranchName
706
+ * A fully-qualified path representing project_location_collection_data_store_branch resource.
707
+ * @returns {string} A string representing the data_store.
708
+ */
709
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
710
+ /**
711
+ * Parse the branch from ProjectLocationCollectionDataStoreBranch resource.
712
+ *
713
+ * @param {string} projectLocationCollectionDataStoreBranchName
714
+ * A fully-qualified path representing project_location_collection_data_store_branch resource.
715
+ * @returns {string} A string representing the branch.
716
+ */
717
+ matchBranchFromProjectLocationCollectionDataStoreBranchName(projectLocationCollectionDataStoreBranchName: string): string | number;
718
+ /**
719
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
720
+ *
721
+ * @param {string} project
722
+ * @param {string} location
723
+ * @param {string} collection
724
+ * @param {string} data_store
725
+ * @param {string} branch
726
+ * @param {string} document
727
+ * @returns {string} Resource name string.
728
+ */
729
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
730
+ /**
731
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
732
+ *
733
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
734
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
735
+ * @returns {string} A string representing the project.
736
+ */
737
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
738
+ /**
739
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
740
+ *
741
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
742
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
743
+ * @returns {string} A string representing the location.
744
+ */
745
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
746
+ /**
747
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
748
+ *
749
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
750
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
751
+ * @returns {string} A string representing the collection.
752
+ */
753
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
754
+ /**
755
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
756
+ *
757
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
758
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
759
+ * @returns {string} A string representing the data_store.
760
+ */
761
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
762
+ /**
763
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
764
+ *
765
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
766
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
767
+ * @returns {string} A string representing the branch.
768
+ */
769
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
770
+ /**
771
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
772
+ *
773
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
774
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
775
+ * @returns {string} A string representing the document.
776
+ */
777
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
778
+ /**
779
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
780
+ *
781
+ * @param {string} project
782
+ * @param {string} location
783
+ * @param {string} collection
784
+ * @param {string} data_store
785
+ * @param {string} conversation
786
+ * @returns {string} Resource name string.
787
+ */
788
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
789
+ /**
790
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
791
+ *
792
+ * @param {string} projectLocationCollectionDataStoreConversationName
793
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
794
+ * @returns {string} A string representing the project.
795
+ */
796
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
797
+ /**
798
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
799
+ *
800
+ * @param {string} projectLocationCollectionDataStoreConversationName
801
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
802
+ * @returns {string} A string representing the location.
803
+ */
804
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
805
+ /**
806
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
807
+ *
808
+ * @param {string} projectLocationCollectionDataStoreConversationName
809
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
810
+ * @returns {string} A string representing the collection.
811
+ */
812
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
813
+ /**
814
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
815
+ *
816
+ * @param {string} projectLocationCollectionDataStoreConversationName
817
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
818
+ * @returns {string} A string representing the data_store.
819
+ */
820
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
821
+ /**
822
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
823
+ *
824
+ * @param {string} projectLocationCollectionDataStoreConversationName
825
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
826
+ * @returns {string} A string representing the conversation.
827
+ */
828
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
829
+ /**
830
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
831
+ *
832
+ * @param {string} project
833
+ * @param {string} location
834
+ * @param {string} collection
835
+ * @param {string} data_store
836
+ * @param {string} schema
837
+ * @returns {string} Resource name string.
838
+ */
839
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
840
+ /**
841
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
842
+ *
843
+ * @param {string} projectLocationCollectionDataStoreSchemaName
844
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
845
+ * @returns {string} A string representing the project.
846
+ */
847
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
848
+ /**
849
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
850
+ *
851
+ * @param {string} projectLocationCollectionDataStoreSchemaName
852
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
853
+ * @returns {string} A string representing the location.
854
+ */
855
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
856
+ /**
857
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
858
+ *
859
+ * @param {string} projectLocationCollectionDataStoreSchemaName
860
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
861
+ * @returns {string} A string representing the collection.
862
+ */
863
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
864
+ /**
865
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
866
+ *
867
+ * @param {string} projectLocationCollectionDataStoreSchemaName
868
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
869
+ * @returns {string} A string representing the data_store.
870
+ */
871
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
872
+ /**
873
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
874
+ *
875
+ * @param {string} projectLocationCollectionDataStoreSchemaName
876
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
877
+ * @returns {string} A string representing the schema.
878
+ */
879
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
880
+ /**
881
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
882
+ *
883
+ * @param {string} project
884
+ * @param {string} location
885
+ * @param {string} collection
886
+ * @param {string} data_store
887
+ * @param {string} serving_config
888
+ * @returns {string} Resource name string.
889
+ */
890
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
891
+ /**
892
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
893
+ *
894
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
895
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
896
+ * @returns {string} A string representing the project.
897
+ */
898
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
899
+ /**
900
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
901
+ *
902
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
903
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
904
+ * @returns {string} A string representing the location.
905
+ */
906
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
907
+ /**
908
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
909
+ *
910
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
911
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
912
+ * @returns {string} A string representing the collection.
913
+ */
914
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
915
+ /**
916
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
917
+ *
918
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
919
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
920
+ * @returns {string} A string representing the data_store.
921
+ */
922
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
923
+ /**
924
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
925
+ *
926
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
927
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
928
+ * @returns {string} A string representing the serving_config.
929
+ */
930
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
931
+ /**
932
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
933
+ *
934
+ * @param {string} project
935
+ * @param {string} location
936
+ * @param {string} collection
937
+ * @param {string} engine
938
+ * @param {string} serving_config
939
+ * @returns {string} Resource name string.
940
+ */
941
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
942
+ /**
943
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
944
+ *
945
+ * @param {string} projectLocationCollectionEngineServingConfigName
946
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
947
+ * @returns {string} A string representing the project.
948
+ */
949
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
950
+ /**
951
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
952
+ *
953
+ * @param {string} projectLocationCollectionEngineServingConfigName
954
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
955
+ * @returns {string} A string representing the location.
956
+ */
957
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
958
+ /**
959
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
960
+ *
961
+ * @param {string} projectLocationCollectionEngineServingConfigName
962
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
963
+ * @returns {string} A string representing the collection.
964
+ */
965
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
966
+ /**
967
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
968
+ *
969
+ * @param {string} projectLocationCollectionEngineServingConfigName
970
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
971
+ * @returns {string} A string representing the engine.
972
+ */
973
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
974
+ /**
975
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
976
+ *
977
+ * @param {string} projectLocationCollectionEngineServingConfigName
978
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
979
+ * @returns {string} A string representing the serving_config.
980
+ */
981
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
982
+ /**
983
+ * Return a fully-qualified projectLocationDataStoreBranch resource name string.
984
+ *
985
+ * @param {string} project
986
+ * @param {string} location
987
+ * @param {string} data_store
988
+ * @param {string} branch
989
+ * @returns {string} Resource name string.
990
+ */
991
+ projectLocationDataStoreBranchPath(project: string, location: string, dataStore: string, branch: string): string;
992
+ /**
993
+ * Parse the project from ProjectLocationDataStoreBranch resource.
994
+ *
995
+ * @param {string} projectLocationDataStoreBranchName
996
+ * A fully-qualified path representing project_location_data_store_branch resource.
997
+ * @returns {string} A string representing the project.
998
+ */
999
+ matchProjectFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
1000
+ /**
1001
+ * Parse the location from ProjectLocationDataStoreBranch resource.
1002
+ *
1003
+ * @param {string} projectLocationDataStoreBranchName
1004
+ * A fully-qualified path representing project_location_data_store_branch resource.
1005
+ * @returns {string} A string representing the location.
1006
+ */
1007
+ matchLocationFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
1008
+ /**
1009
+ * Parse the data_store from ProjectLocationDataStoreBranch resource.
1010
+ *
1011
+ * @param {string} projectLocationDataStoreBranchName
1012
+ * A fully-qualified path representing project_location_data_store_branch resource.
1013
+ * @returns {string} A string representing the data_store.
1014
+ */
1015
+ matchDataStoreFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
1016
+ /**
1017
+ * Parse the branch from ProjectLocationDataStoreBranch resource.
1018
+ *
1019
+ * @param {string} projectLocationDataStoreBranchName
1020
+ * A fully-qualified path representing project_location_data_store_branch resource.
1021
+ * @returns {string} A string representing the branch.
1022
+ */
1023
+ matchBranchFromProjectLocationDataStoreBranchName(projectLocationDataStoreBranchName: string): string | number;
1024
+ /**
1025
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
1026
+ *
1027
+ * @param {string} project
1028
+ * @param {string} location
1029
+ * @param {string} data_store
1030
+ * @param {string} branch
1031
+ * @param {string} document
1032
+ * @returns {string} Resource name string.
1033
+ */
1034
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
1035
+ /**
1036
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
1037
+ *
1038
+ * @param {string} projectLocationDataStoreBranchDocumentName
1039
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1040
+ * @returns {string} A string representing the project.
1041
+ */
1042
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1043
+ /**
1044
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
1045
+ *
1046
+ * @param {string} projectLocationDataStoreBranchDocumentName
1047
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1048
+ * @returns {string} A string representing the location.
1049
+ */
1050
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1051
+ /**
1052
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
1053
+ *
1054
+ * @param {string} projectLocationDataStoreBranchDocumentName
1055
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1056
+ * @returns {string} A string representing the data_store.
1057
+ */
1058
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1059
+ /**
1060
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
1061
+ *
1062
+ * @param {string} projectLocationDataStoreBranchDocumentName
1063
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1064
+ * @returns {string} A string representing the branch.
1065
+ */
1066
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1067
+ /**
1068
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
1069
+ *
1070
+ * @param {string} projectLocationDataStoreBranchDocumentName
1071
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1072
+ * @returns {string} A string representing the document.
1073
+ */
1074
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1075
+ /**
1076
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
1077
+ *
1078
+ * @param {string} project
1079
+ * @param {string} location
1080
+ * @param {string} data_store
1081
+ * @param {string} conversation
1082
+ * @returns {string} Resource name string.
1083
+ */
1084
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
1085
+ /**
1086
+ * Parse the project from ProjectLocationDataStoreConversation resource.
1087
+ *
1088
+ * @param {string} projectLocationDataStoreConversationName
1089
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1090
+ * @returns {string} A string representing the project.
1091
+ */
1092
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1093
+ /**
1094
+ * Parse the location from ProjectLocationDataStoreConversation resource.
1095
+ *
1096
+ * @param {string} projectLocationDataStoreConversationName
1097
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1098
+ * @returns {string} A string representing the location.
1099
+ */
1100
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1101
+ /**
1102
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
1103
+ *
1104
+ * @param {string} projectLocationDataStoreConversationName
1105
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1106
+ * @returns {string} A string representing the data_store.
1107
+ */
1108
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1109
+ /**
1110
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1111
+ *
1112
+ * @param {string} projectLocationDataStoreConversationName
1113
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1114
+ * @returns {string} A string representing the conversation.
1115
+ */
1116
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1117
+ /**
1118
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1119
+ *
1120
+ * @param {string} project
1121
+ * @param {string} location
1122
+ * @param {string} data_store
1123
+ * @param {string} schema
1124
+ * @returns {string} Resource name string.
1125
+ */
1126
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
1127
+ /**
1128
+ * Parse the project from ProjectLocationDataStoreSchema resource.
1129
+ *
1130
+ * @param {string} projectLocationDataStoreSchemaName
1131
+ * A fully-qualified path representing project_location_data_store_schema resource.
1132
+ * @returns {string} A string representing the project.
1133
+ */
1134
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1135
+ /**
1136
+ * Parse the location from ProjectLocationDataStoreSchema resource.
1137
+ *
1138
+ * @param {string} projectLocationDataStoreSchemaName
1139
+ * A fully-qualified path representing project_location_data_store_schema resource.
1140
+ * @returns {string} A string representing the location.
1141
+ */
1142
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1143
+ /**
1144
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
1145
+ *
1146
+ * @param {string} projectLocationDataStoreSchemaName
1147
+ * A fully-qualified path representing project_location_data_store_schema resource.
1148
+ * @returns {string} A string representing the data_store.
1149
+ */
1150
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1151
+ /**
1152
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
1153
+ *
1154
+ * @param {string} projectLocationDataStoreSchemaName
1155
+ * A fully-qualified path representing project_location_data_store_schema resource.
1156
+ * @returns {string} A string representing the schema.
1157
+ */
1158
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1159
+ /**
1160
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
1161
+ *
1162
+ * @param {string} project
1163
+ * @param {string} location
1164
+ * @param {string} data_store
1165
+ * @param {string} serving_config
1166
+ * @returns {string} Resource name string.
1167
+ */
1168
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
1169
+ /**
1170
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
1171
+ *
1172
+ * @param {string} projectLocationDataStoreServingConfigName
1173
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1174
+ * @returns {string} A string representing the project.
1175
+ */
1176
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1177
+ /**
1178
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
1179
+ *
1180
+ * @param {string} projectLocationDataStoreServingConfigName
1181
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1182
+ * @returns {string} A string representing the location.
1183
+ */
1184
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1185
+ /**
1186
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
1187
+ *
1188
+ * @param {string} projectLocationDataStoreServingConfigName
1189
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1190
+ * @returns {string} A string representing the data_store.
1191
+ */
1192
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1193
+ /**
1194
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
1195
+ *
1196
+ * @param {string} projectLocationDataStoreServingConfigName
1197
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1198
+ * @returns {string} A string representing the serving_config.
1199
+ */
1200
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1201
+ /**
1202
+ * Terminate the gRPC channel and close the client.
1203
+ *
1204
+ * The client will no longer be usable and all future behavior is undefined.
1205
+ * @returns {Promise} A promise that resolves when the client is closed.
1206
+ */
1207
+ close(): Promise<void>;
1208
+ }