@google-cloud/discoveryengine 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
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,735 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LocationsClient, LocationProtos } from 'google-gax';
3
+ import * as protos from '../../protos/protos';
4
+ /**
5
+ * Service for making recommendations.
6
+ * @class
7
+ * @memberof v1alpha
8
+ */
9
+ export declare class RecommendationServiceClient {
10
+ private _terminated;
11
+ private _opts;
12
+ private _providedCustomServicePath;
13
+ private _gaxModule;
14
+ private _gaxGrpc;
15
+ private _protos;
16
+ private _defaults;
17
+ auth: gax.GoogleAuth;
18
+ descriptors: Descriptors;
19
+ warn: (code: string, message: string, warnType?: string) => void;
20
+ innerApiCalls: {
21
+ [name: string]: Function;
22
+ };
23
+ locationsClient: LocationsClient;
24
+ pathTemplates: {
25
+ [name: string]: gax.PathTemplate;
26
+ };
27
+ recommendationServiceStub?: Promise<{
28
+ [name: string]: Function;
29
+ }>;
30
+ /**
31
+ * Construct an instance of RecommendationServiceClient.
32
+ *
33
+ * @param {object} [options] - The configuration object.
34
+ * The options accepted by the constructor are described in detail
35
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
36
+ * The common options are:
37
+ * @param {object} [options.credentials] - Credentials object.
38
+ * @param {string} [options.credentials.client_email]
39
+ * @param {string} [options.credentials.private_key]
40
+ * @param {string} [options.email] - Account email address. Required when
41
+ * using a .pem or .p12 keyFilename.
42
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
43
+ * .p12 key downloaded from the Google Developers Console. If you provide
44
+ * a path to a JSON file, the projectId option below is not necessary.
45
+ * NOTE: .pem and .p12 require you to specify options.email as well.
46
+ * @param {number} [options.port] - The port on which to connect to
47
+ * the remote host.
48
+ * @param {string} [options.projectId] - The project ID from the Google
49
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
50
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
51
+ * app is running in an environment which supports
52
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
53
+ * your project ID will be detected automatically.
54
+ * @param {string} [options.apiEndpoint] - The domain name of the
55
+ * API remote host.
56
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
57
+ * Follows the structure of {@link gapicConfig}.
58
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
59
+ * For more information, please check the
60
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
61
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
62
+ * need to avoid loading the default gRPC version and want to use the fallback
63
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
64
+ * ```
65
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
66
+ * const client = new RecommendationServiceClient({fallback: true}, gax);
67
+ * ```
68
+ */
69
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
70
+ /**
71
+ * Initialize the client.
72
+ * Performs asynchronous operations (such as authentication) and prepares the client.
73
+ * This function will be called automatically when any class method is called for the
74
+ * first time, but if you need to initialize it before calling an actual method,
75
+ * feel free to call initialize() directly.
76
+ *
77
+ * You can await on this method if you want to make sure the client is initialized.
78
+ *
79
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
80
+ */
81
+ initialize(): Promise<{
82
+ [name: string]: Function;
83
+ }>;
84
+ /**
85
+ * The DNS address for this API service.
86
+ * @returns {string} The DNS address for this service.
87
+ */
88
+ static get servicePath(): string;
89
+ /**
90
+ * The DNS address for this API service - same as servicePath(),
91
+ * exists for compatibility reasons.
92
+ * @returns {string} The DNS address for this service.
93
+ */
94
+ static get apiEndpoint(): string;
95
+ /**
96
+ * The port for this API service.
97
+ * @returns {number} The default port for this service.
98
+ */
99
+ static get port(): number;
100
+ /**
101
+ * The scopes needed to make gRPC calls for every method defined
102
+ * in this service.
103
+ * @returns {string[]} List of default scopes.
104
+ */
105
+ static get scopes(): string[];
106
+ getProjectId(): Promise<string>;
107
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
108
+ /**
109
+ * Makes a recommendation, which requires a contextual user event.
110
+ *
111
+ * @param {Object} request
112
+ * The request object that will be sent.
113
+ * @param {string} request.servingConfig
114
+ * Required. Full resource name of the format:
115
+ * `projects/* /locations/global/collections/* /dataStores/* /servingConfigs/*`
116
+ *
117
+ * Before you can request recommendations from your model, you must create at
118
+ * least one serving config for it.
119
+ * @param {google.cloud.discoveryengine.v1alpha.UserEvent} request.userEvent
120
+ * Required. Context about the user, what they are looking at and what action
121
+ * they took to trigger the Recommend request. Note that this user event
122
+ * detail won't be ingested to userEvent logs. Thus, a separate userEvent
123
+ * write request is required for event logging.
124
+ *
125
+ * Don't set
126
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
127
+ * or
128
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_id|UserEvent.user_info.user_id}
129
+ * to the same fixed ID for different users. If you are trying to receive
130
+ * non-personalized recommendations (not recommended; this can negatively
131
+ * impact model performance), instead set
132
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
133
+ * to a random unique ID and leave
134
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserInfo.user_id|UserEvent.user_info.user_id}
135
+ * unset.
136
+ * @param {number} request.pageSize
137
+ * Maximum number of results to return. Set this property
138
+ * to the number of recommendation results needed. If zero, the service will
139
+ * choose a reasonable default. The maximum allowed value is 100. Values
140
+ * above 100 will be coerced to 100.
141
+ * @param {string} request.filter
142
+ * Filter for restricting recommendation results with a length limit of 5,000
143
+ * characters. Currently, only filter expressions on the `filter_tags`
144
+ * attribute is supported.
145
+ *
146
+ *
147
+ * Examples:
148
+ *
149
+ * * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
150
+ * * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
151
+ *
152
+ * If `attributeFilteringSyntax` is set to true under the `params` field, then
153
+ * attribute-based expressions are expected instead of the above described
154
+ * tag-based syntax. Examples:
155
+ *
156
+ * * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
157
+ * * (available: true) AND
158
+ * (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
159
+ *
160
+ * If your filter blocks all results, the API will return generic
161
+ * (unfiltered) popular Documents. If you only want results strictly matching
162
+ * the filters, set `strictFiltering` to True in
163
+ * {@link protos.google.cloud.discoveryengine.v1alpha.RecommendRequest.params|RecommendRequest.params}
164
+ * to receive empty results instead.
165
+ *
166
+ * Note that the API will never return
167
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Document}s with
168
+ * `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
169
+ * @param {boolean} request.validateOnly
170
+ * Use validate only mode for this recommendation query. If set to true, a
171
+ * fake model will be used that returns arbitrary Document IDs.
172
+ * Note that the validate only mode should only be used for testing the API,
173
+ * or if the model is not ready.
174
+ * @param {number[]} request.params
175
+ * Additional domain specific parameters for the recommendations.
176
+ *
177
+ * Allowed values:
178
+ *
179
+ * * `returnDocument`: Boolean. If set to true, the associated Document
180
+ * object will be returned in
181
+ * {@link protos.google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.document|RecommendResponse.RecommendationResult.document}.
182
+ * * `returnScore`: Boolean. If set to true, the recommendation 'score'
183
+ * corresponding to each returned Document will be set in
184
+ * {@link protos.google.cloud.discoveryengine.v1alpha.RecommendResponse.RecommendationResult.metadata|RecommendResponse.RecommendationResult.metadata}.
185
+ * The given 'score' indicates the probability of a Document conversion
186
+ * given the user's context and history.
187
+ * * `strictFiltering`: Boolean. True by default. If set to false, the service
188
+ * will return generic (unfiltered) popular Documents instead of empty if
189
+ * your filter blocks all recommendation results.
190
+ * * `diversityLevel`: String. Default empty. If set to be non-empty, then
191
+ * it needs to be one of:
192
+ * * `no-diversity`
193
+ * * `low-diversity`
194
+ * * `medium-diversity`
195
+ * * `high-diversity`
196
+ * * `auto-diversity`
197
+ * This gives request-level control and adjusts recommendation results
198
+ * based on Document category.
199
+ * * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
200
+ * the `filter` field is interpreted according to the new,
201
+ * attribute-based syntax.
202
+ * @param {number[]} request.userLabels
203
+ * The user labels applied to a resource must meet the following requirements:
204
+ *
205
+ * * Each resource can have multiple labels, up to a maximum of 64.
206
+ * * Each label must be a key-value pair.
207
+ * * Keys have a minimum length of 1 character and a maximum length of 63
208
+ * characters and cannot be empty. Values can be empty and have a maximum
209
+ * length of 63 characters.
210
+ * * Keys and values can contain only lowercase letters, numeric characters,
211
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
212
+ * international characters are allowed.
213
+ * * The key portion of a label must be unique. However, you can use the same
214
+ * key with multiple resources.
215
+ * * Keys must start with a lowercase letter or international character.
216
+ *
217
+ * See [Requirements for
218
+ * labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
219
+ * for more details.
220
+ * @param {object} [options]
221
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
222
+ * @returns {Promise} - The promise which resolves to an array.
223
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.RecommendResponse|RecommendResponse}.
224
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
225
+ * for more details and examples.
226
+ * @example <caption>include:samples/generated/v1alpha/recommendation_service.recommend.js</caption>
227
+ * region_tag:discoveryengine_v1alpha_generated_RecommendationService_Recommend_async
228
+ */
229
+ recommend(request?: protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest, options?: CallOptions): Promise<[
230
+ protos.google.cloud.discoveryengine.v1alpha.IRecommendResponse,
231
+ protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest | undefined,
232
+ {} | undefined
233
+ ]>;
234
+ recommend(request: protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IRecommendResponse, protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest | null | undefined, {} | null | undefined>): void;
235
+ recommend(request: protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IRecommendResponse, protos.google.cloud.discoveryengine.v1alpha.IRecommendRequest | null | undefined, {} | null | undefined>): void;
236
+ /**
237
+ * Gets information about a location.
238
+ *
239
+ * @param {Object} request
240
+ * The request object that will be sent.
241
+ * @param {string} request.name
242
+ * Resource name for the location.
243
+ * @param {object} [options]
244
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
245
+ * @returns {Promise} - The promise which resolves to an array.
246
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
247
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
248
+ * for more details and examples.
249
+ * @example
250
+ * ```
251
+ * const [response] = await client.getLocation(request);
252
+ * ```
253
+ */
254
+ 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>;
255
+ /**
256
+ * Lists information about the supported locations for this service. Returns an iterable object.
257
+ *
258
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
259
+ * @param {Object} request
260
+ * The request object that will be sent.
261
+ * @param {string} request.name
262
+ * The resource that owns the locations collection, if applicable.
263
+ * @param {string} request.filter
264
+ * The standard list filter.
265
+ * @param {number} request.pageSize
266
+ * The standard list page size.
267
+ * @param {string} request.pageToken
268
+ * The standard list page token.
269
+ * @param {object} [options]
270
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
271
+ * @returns {Object}
272
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
273
+ * When you iterate the returned iterable, each element will be an object representing
274
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
275
+ * so you can stop the iteration when you don't need more results.
276
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
277
+ * for more details and examples.
278
+ * @example
279
+ * ```
280
+ * const iterable = client.listLocationsAsync(request);
281
+ * for await (const response of iterable) {
282
+ * // process response
283
+ * }
284
+ * ```
285
+ */
286
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
287
+ /**
288
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
289
+ *
290
+ * @param {string} project
291
+ * @param {string} location
292
+ * @param {string} collection
293
+ * @param {string} data_store
294
+ * @param {string} branch
295
+ * @param {string} document
296
+ * @returns {string} Resource name string.
297
+ */
298
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
299
+ /**
300
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
301
+ *
302
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
303
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
304
+ * @returns {string} A string representing the project.
305
+ */
306
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
307
+ /**
308
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
309
+ *
310
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
311
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
312
+ * @returns {string} A string representing the location.
313
+ */
314
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
315
+ /**
316
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
317
+ *
318
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
319
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
320
+ * @returns {string} A string representing the collection.
321
+ */
322
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
323
+ /**
324
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
325
+ *
326
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
327
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
328
+ * @returns {string} A string representing the data_store.
329
+ */
330
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
331
+ /**
332
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
333
+ *
334
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
335
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
336
+ * @returns {string} A string representing the branch.
337
+ */
338
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
339
+ /**
340
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
341
+ *
342
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
343
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
344
+ * @returns {string} A string representing the document.
345
+ */
346
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
347
+ /**
348
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
349
+ *
350
+ * @param {string} project
351
+ * @param {string} location
352
+ * @param {string} collection
353
+ * @param {string} data_store
354
+ * @param {string} conversation
355
+ * @returns {string} Resource name string.
356
+ */
357
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
358
+ /**
359
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
360
+ *
361
+ * @param {string} projectLocationCollectionDataStoreConversationName
362
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
363
+ * @returns {string} A string representing the project.
364
+ */
365
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
366
+ /**
367
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
368
+ *
369
+ * @param {string} projectLocationCollectionDataStoreConversationName
370
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
371
+ * @returns {string} A string representing the location.
372
+ */
373
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
374
+ /**
375
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
376
+ *
377
+ * @param {string} projectLocationCollectionDataStoreConversationName
378
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
379
+ * @returns {string} A string representing the collection.
380
+ */
381
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
382
+ /**
383
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
384
+ *
385
+ * @param {string} projectLocationCollectionDataStoreConversationName
386
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
387
+ * @returns {string} A string representing the data_store.
388
+ */
389
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
390
+ /**
391
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
392
+ *
393
+ * @param {string} projectLocationCollectionDataStoreConversationName
394
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
395
+ * @returns {string} A string representing the conversation.
396
+ */
397
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
398
+ /**
399
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
400
+ *
401
+ * @param {string} project
402
+ * @param {string} location
403
+ * @param {string} collection
404
+ * @param {string} data_store
405
+ * @param {string} schema
406
+ * @returns {string} Resource name string.
407
+ */
408
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
409
+ /**
410
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
411
+ *
412
+ * @param {string} projectLocationCollectionDataStoreSchemaName
413
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
414
+ * @returns {string} A string representing the project.
415
+ */
416
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
417
+ /**
418
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
419
+ *
420
+ * @param {string} projectLocationCollectionDataStoreSchemaName
421
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
422
+ * @returns {string} A string representing the location.
423
+ */
424
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
425
+ /**
426
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
427
+ *
428
+ * @param {string} projectLocationCollectionDataStoreSchemaName
429
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
430
+ * @returns {string} A string representing the collection.
431
+ */
432
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
433
+ /**
434
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
435
+ *
436
+ * @param {string} projectLocationCollectionDataStoreSchemaName
437
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
438
+ * @returns {string} A string representing the data_store.
439
+ */
440
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
441
+ /**
442
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
443
+ *
444
+ * @param {string} projectLocationCollectionDataStoreSchemaName
445
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
446
+ * @returns {string} A string representing the schema.
447
+ */
448
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
449
+ /**
450
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
451
+ *
452
+ * @param {string} project
453
+ * @param {string} location
454
+ * @param {string} collection
455
+ * @param {string} data_store
456
+ * @param {string} serving_config
457
+ * @returns {string} Resource name string.
458
+ */
459
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
460
+ /**
461
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
462
+ *
463
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
464
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
465
+ * @returns {string} A string representing the project.
466
+ */
467
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
468
+ /**
469
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
470
+ *
471
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
472
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
473
+ * @returns {string} A string representing the location.
474
+ */
475
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
476
+ /**
477
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
478
+ *
479
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
480
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
481
+ * @returns {string} A string representing the collection.
482
+ */
483
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
484
+ /**
485
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
486
+ *
487
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
488
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
489
+ * @returns {string} A string representing the data_store.
490
+ */
491
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
492
+ /**
493
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
494
+ *
495
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
496
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
497
+ * @returns {string} A string representing the serving_config.
498
+ */
499
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
500
+ /**
501
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
502
+ *
503
+ * @param {string} project
504
+ * @param {string} location
505
+ * @param {string} collection
506
+ * @param {string} engine
507
+ * @param {string} serving_config
508
+ * @returns {string} Resource name string.
509
+ */
510
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
511
+ /**
512
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
513
+ *
514
+ * @param {string} projectLocationCollectionEngineServingConfigName
515
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
516
+ * @returns {string} A string representing the project.
517
+ */
518
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
519
+ /**
520
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
521
+ *
522
+ * @param {string} projectLocationCollectionEngineServingConfigName
523
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
524
+ * @returns {string} A string representing the location.
525
+ */
526
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
527
+ /**
528
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
529
+ *
530
+ * @param {string} projectLocationCollectionEngineServingConfigName
531
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
532
+ * @returns {string} A string representing the collection.
533
+ */
534
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
535
+ /**
536
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
537
+ *
538
+ * @param {string} projectLocationCollectionEngineServingConfigName
539
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
540
+ * @returns {string} A string representing the engine.
541
+ */
542
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
543
+ /**
544
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
545
+ *
546
+ * @param {string} projectLocationCollectionEngineServingConfigName
547
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
548
+ * @returns {string} A string representing the serving_config.
549
+ */
550
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
551
+ /**
552
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
553
+ *
554
+ * @param {string} project
555
+ * @param {string} location
556
+ * @param {string} data_store
557
+ * @param {string} branch
558
+ * @param {string} document
559
+ * @returns {string} Resource name string.
560
+ */
561
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
562
+ /**
563
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
564
+ *
565
+ * @param {string} projectLocationDataStoreBranchDocumentName
566
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
567
+ * @returns {string} A string representing the project.
568
+ */
569
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
570
+ /**
571
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
572
+ *
573
+ * @param {string} projectLocationDataStoreBranchDocumentName
574
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
575
+ * @returns {string} A string representing the location.
576
+ */
577
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
578
+ /**
579
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
580
+ *
581
+ * @param {string} projectLocationDataStoreBranchDocumentName
582
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
583
+ * @returns {string} A string representing the data_store.
584
+ */
585
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
586
+ /**
587
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
588
+ *
589
+ * @param {string} projectLocationDataStoreBranchDocumentName
590
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
591
+ * @returns {string} A string representing the branch.
592
+ */
593
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
594
+ /**
595
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
596
+ *
597
+ * @param {string} projectLocationDataStoreBranchDocumentName
598
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
599
+ * @returns {string} A string representing the document.
600
+ */
601
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
602
+ /**
603
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
604
+ *
605
+ * @param {string} project
606
+ * @param {string} location
607
+ * @param {string} data_store
608
+ * @param {string} conversation
609
+ * @returns {string} Resource name string.
610
+ */
611
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
612
+ /**
613
+ * Parse the project from ProjectLocationDataStoreConversation resource.
614
+ *
615
+ * @param {string} projectLocationDataStoreConversationName
616
+ * A fully-qualified path representing project_location_data_store_conversation resource.
617
+ * @returns {string} A string representing the project.
618
+ */
619
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
620
+ /**
621
+ * Parse the location from ProjectLocationDataStoreConversation resource.
622
+ *
623
+ * @param {string} projectLocationDataStoreConversationName
624
+ * A fully-qualified path representing project_location_data_store_conversation resource.
625
+ * @returns {string} A string representing the location.
626
+ */
627
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
628
+ /**
629
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
630
+ *
631
+ * @param {string} projectLocationDataStoreConversationName
632
+ * A fully-qualified path representing project_location_data_store_conversation resource.
633
+ * @returns {string} A string representing the data_store.
634
+ */
635
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
636
+ /**
637
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
638
+ *
639
+ * @param {string} projectLocationDataStoreConversationName
640
+ * A fully-qualified path representing project_location_data_store_conversation resource.
641
+ * @returns {string} A string representing the conversation.
642
+ */
643
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
644
+ /**
645
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
646
+ *
647
+ * @param {string} project
648
+ * @param {string} location
649
+ * @param {string} data_store
650
+ * @param {string} schema
651
+ * @returns {string} Resource name string.
652
+ */
653
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
654
+ /**
655
+ * Parse the project from ProjectLocationDataStoreSchema resource.
656
+ *
657
+ * @param {string} projectLocationDataStoreSchemaName
658
+ * A fully-qualified path representing project_location_data_store_schema resource.
659
+ * @returns {string} A string representing the project.
660
+ */
661
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
662
+ /**
663
+ * Parse the location from ProjectLocationDataStoreSchema resource.
664
+ *
665
+ * @param {string} projectLocationDataStoreSchemaName
666
+ * A fully-qualified path representing project_location_data_store_schema resource.
667
+ * @returns {string} A string representing the location.
668
+ */
669
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
670
+ /**
671
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
672
+ *
673
+ * @param {string} projectLocationDataStoreSchemaName
674
+ * A fully-qualified path representing project_location_data_store_schema resource.
675
+ * @returns {string} A string representing the data_store.
676
+ */
677
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
678
+ /**
679
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
680
+ *
681
+ * @param {string} projectLocationDataStoreSchemaName
682
+ * A fully-qualified path representing project_location_data_store_schema resource.
683
+ * @returns {string} A string representing the schema.
684
+ */
685
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
686
+ /**
687
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
688
+ *
689
+ * @param {string} project
690
+ * @param {string} location
691
+ * @param {string} data_store
692
+ * @param {string} serving_config
693
+ * @returns {string} Resource name string.
694
+ */
695
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
696
+ /**
697
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
698
+ *
699
+ * @param {string} projectLocationDataStoreServingConfigName
700
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
701
+ * @returns {string} A string representing the project.
702
+ */
703
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
704
+ /**
705
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
706
+ *
707
+ * @param {string} projectLocationDataStoreServingConfigName
708
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
709
+ * @returns {string} A string representing the location.
710
+ */
711
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
712
+ /**
713
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
714
+ *
715
+ * @param {string} projectLocationDataStoreServingConfigName
716
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
717
+ * @returns {string} A string representing the data_store.
718
+ */
719
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
720
+ /**
721
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
722
+ *
723
+ * @param {string} projectLocationDataStoreServingConfigName
724
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
725
+ * @returns {string} A string representing the serving_config.
726
+ */
727
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
728
+ /**
729
+ * Terminate the gRPC channel and close the client.
730
+ *
731
+ * The client will no longer be usable and all future behavior is undefined.
732
+ * @returns {Promise} A promise that resolves when the client is closed.
733
+ */
734
+ close(): Promise<void>;
735
+ }