@google-cloud/discoveryengine 0.7.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +24 -0
- package/README.md +6 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +1 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +15 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +131 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +281 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +6 -5
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +26 -22
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +193 -47
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +41 -36
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
- package/build/protos/protos.d.ts +6529 -4472
- package/build/protos/protos.js +16561 -11622
- package/build/protos/protos.json +1842 -1317
- package/build/src/v1/completion_service_client.d.ts +6 -7
- package/build/src/v1/document_service_client.d.ts +83 -94
- package/build/src/v1/document_service_client.js +18 -22
- package/build/src/v1/schema_service_client.d.ts +39 -49
- package/build/src/v1/schema_service_client.js +17 -22
- package/build/src/v1/search_service_client.d.ts +31 -34
- package/build/src/v1/search_service_client.js +21 -23
- package/build/src/v1/user_event_service_client.d.ts +6 -10
- package/build/src/v1/user_event_service_client.js +1 -2
- package/build/src/v1beta/completion_service_client.d.ts +106 -8
- package/build/src/v1beta/completion_service_client.js +128 -0
- package/build/src/v1beta/conversational_search_service_client.d.ts +876 -0
- package/build/src/v1beta/conversational_search_service_client.js +1149 -0
- package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
- package/build/src/v1beta/document_service_client.d.ts +183 -98
- package/build/src/v1beta/document_service_client.js +166 -22
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +103 -11
- package/build/src/v1beta/recommendation_service_client.js +128 -0
- package/build/src/v1beta/schema_service_client.d.ts +132 -49
- package/build/src/v1beta/schema_service_client.js +163 -22
- package/build/src/v1beta/search_service_client.d.ts +163 -67
- package/build/src/v1beta/search_service_client.js +175 -45
- package/build/src/v1beta/user_event_service_client.d.ts +104 -15
- package/build/src/v1beta/user_event_service_client.js +147 -2
- package/package.json +8 -11
@@ -140,10 +140,12 @@ class SearchServiceClient {
|
|
140
140
|
this.pathTemplates = {
|
141
141
|
projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
|
142
142
|
projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
143
|
+
projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
|
143
144
|
projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
|
144
145
|
projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
|
145
146
|
projectLocationDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}'),
|
146
147
|
projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
|
148
|
+
projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
|
147
149
|
projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
|
148
150
|
projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
|
149
151
|
};
|
@@ -283,27 +285,29 @@ class SearchServiceClient {
|
|
283
285
|
* documents under the default branch.
|
284
286
|
* @param {string} request.query
|
285
287
|
* Raw search query.
|
288
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery} request.imageQuery
|
289
|
+
* Raw image query.
|
286
290
|
* @param {number} request.pageSize
|
287
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
291
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
|
288
292
|
* to return. If unspecified, defaults to a reasonable value. The maximum
|
289
|
-
* allowed value is 100. Values above 100
|
293
|
+
* allowed value is 100. Values above 100 are coerced to 100.
|
290
294
|
*
|
291
295
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
292
296
|
* @param {string} request.pageToken
|
293
297
|
* A page token received from a previous
|
294
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
298
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
295
299
|
* call. Provide this to retrieve the subsequent page.
|
296
300
|
*
|
297
301
|
* When paginating, all other parameters provided to
|
298
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
302
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
299
303
|
* must match the call that provided the page token. Otherwise, an
|
300
304
|
* `INVALID_ARGUMENT` error is returned.
|
301
305
|
* @param {number} request.offset
|
302
306
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
303
307
|
* result location, amongst the
|
304
|
-
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
308
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
305
309
|
* as relevant) in search results. This field is only considered if
|
306
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
310
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
307
311
|
* is unset.
|
308
312
|
*
|
309
313
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -314,16 +318,17 @@ class SearchServiceClient {
|
|
314
318
|
*
|
315
319
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
316
320
|
* @param {string} request.orderBy
|
317
|
-
* The order in which documents are returned.
|
318
|
-
* a field in an {@link google.cloud.discoveryengine.v1beta.Document|Document}
|
319
|
-
* object. Leave it unset if ordered by relevance.
|
321
|
+
* The order in which documents are returned. Documents can be ordered by
|
322
|
+
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
323
|
+
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
320
324
|
* case-sensitive.
|
321
325
|
*
|
322
|
-
* If this field is unrecognizable, an
|
326
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
323
327
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
324
328
|
* Information about the end user.
|
325
|
-
* Highly recommended for analytics.
|
326
|
-
*
|
329
|
+
* Highly recommended for analytics.
|
330
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_agent|UserInfo.user_agent}
|
331
|
+
* is used to deduce `device_type` for analytics.
|
327
332
|
* @param {number[]} request.facetSpecs
|
328
333
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
329
334
|
*
|
@@ -343,10 +348,10 @@ class SearchServiceClient {
|
|
343
348
|
* which enables image searching.
|
344
349
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
345
350
|
* The query expansion specification that specifies the conditions under which
|
346
|
-
* query expansion
|
351
|
+
* query expansion occurs.
|
347
352
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
|
348
353
|
* The spell correction specification that specifies the mode under
|
349
|
-
* which spell correction
|
354
|
+
* which spell correction takes effect.
|
350
355
|
* @param {string} request.userPseudoId
|
351
356
|
* A unique identifier for tracking visitors. For example, this could be
|
352
357
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -356,18 +361,17 @@ class SearchServiceClient {
|
|
356
361
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
357
362
|
*
|
358
363
|
* This should be the same identifier as
|
359
|
-
* {@link google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
364
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
360
365
|
* and
|
361
|
-
* {@link google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
366
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
362
367
|
*
|
363
368
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
364
369
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
365
370
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
366
|
-
*
|
367
|
-
* search.
|
371
|
+
* A specification for configuring the behavior of content search.
|
368
372
|
* @param {boolean} request.safeSearch
|
369
373
|
* Whether to turn on safe search. This is only supported for
|
370
|
-
*
|
374
|
+
* website search.
|
371
375
|
* @param {number[]} request.userLabels
|
372
376
|
* The user labels applied to a resource must meet the following requirements:
|
373
377
|
*
|
@@ -389,13 +393,12 @@ class SearchServiceClient {
|
|
389
393
|
* @param {object} [options]
|
390
394
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
391
395
|
* @returns {Stream}
|
392
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult
|
396
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult|SearchResult} on 'data' event.
|
393
397
|
* The client library will perform auto-pagination by default: it will call the API as many
|
394
398
|
* times as needed. Note that it can affect your quota.
|
395
399
|
* We recommend using `searchAsync()`
|
396
400
|
* method described below for async iteration which you can stop as needed.
|
397
|
-
* Please see the
|
398
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
401
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
399
402
|
* for more details and examples.
|
400
403
|
*/
|
401
404
|
searchStream(request, options) {
|
@@ -432,27 +435,29 @@ class SearchServiceClient {
|
|
432
435
|
* documents under the default branch.
|
433
436
|
* @param {string} request.query
|
434
437
|
* Raw search query.
|
438
|
+
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ImageQuery} request.imageQuery
|
439
|
+
* Raw image query.
|
435
440
|
* @param {number} request.pageSize
|
436
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1beta.Document|Document}s
|
441
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s
|
437
442
|
* to return. If unspecified, defaults to a reasonable value. The maximum
|
438
|
-
* allowed value is 100. Values above 100
|
443
|
+
* allowed value is 100. Values above 100 are coerced to 100.
|
439
444
|
*
|
440
445
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
441
446
|
* @param {string} request.pageToken
|
442
447
|
* A page token received from a previous
|
443
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
448
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
444
449
|
* call. Provide this to retrieve the subsequent page.
|
445
450
|
*
|
446
451
|
* When paginating, all other parameters provided to
|
447
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
452
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchService.Search|SearchService.Search}
|
448
453
|
* must match the call that provided the page token. Otherwise, an
|
449
454
|
* `INVALID_ARGUMENT` error is returned.
|
450
455
|
* @param {number} request.offset
|
451
456
|
* A 0-indexed integer that specifies the current offset (that is, starting
|
452
457
|
* result location, amongst the
|
453
|
-
* {@link google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
458
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}s deemed by the API
|
454
459
|
* as relevant) in search results. This field is only considered if
|
455
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
460
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchRequest.page_token|page_token}
|
456
461
|
* is unset.
|
457
462
|
*
|
458
463
|
* If this field is negative, an `INVALID_ARGUMENT` is returned.
|
@@ -463,16 +468,17 @@ class SearchServiceClient {
|
|
463
468
|
*
|
464
469
|
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
465
470
|
* @param {string} request.orderBy
|
466
|
-
* The order in which documents are returned.
|
467
|
-
* a field in an {@link google.cloud.discoveryengine.v1beta.Document|Document}
|
468
|
-
* object. Leave it unset if ordered by relevance.
|
471
|
+
* The order in which documents are returned. Documents can be ordered by
|
472
|
+
* a field in an {@link protos.google.cloud.discoveryengine.v1beta.Document|Document}
|
473
|
+
* object. Leave it unset if ordered by relevance. `order_by` expression is
|
469
474
|
* case-sensitive.
|
470
475
|
*
|
471
|
-
* If this field is unrecognizable, an
|
476
|
+
* If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
|
472
477
|
* @param {google.cloud.discoveryengine.v1beta.UserInfo} request.userInfo
|
473
478
|
* Information about the end user.
|
474
|
-
* Highly recommended for analytics.
|
475
|
-
*
|
479
|
+
* Highly recommended for analytics.
|
480
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserInfo.user_agent|UserInfo.user_agent}
|
481
|
+
* is used to deduce `device_type` for analytics.
|
476
482
|
* @param {number[]} request.facetSpecs
|
477
483
|
* Facet specifications for faceted search. If empty, no facets are returned.
|
478
484
|
*
|
@@ -492,10 +498,10 @@ class SearchServiceClient {
|
|
492
498
|
* which enables image searching.
|
493
499
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.QueryExpansionSpec} request.queryExpansionSpec
|
494
500
|
* The query expansion specification that specifies the conditions under which
|
495
|
-
* query expansion
|
501
|
+
* query expansion occurs.
|
496
502
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.SpellCorrectionSpec} request.spellCorrectionSpec
|
497
503
|
* The spell correction specification that specifies the mode under
|
498
|
-
* which spell correction
|
504
|
+
* which spell correction takes effect.
|
499
505
|
* @param {string} request.userPseudoId
|
500
506
|
* A unique identifier for tracking visitors. For example, this could be
|
501
507
|
* implemented with an HTTP cookie, which should be able to uniquely identify
|
@@ -505,18 +511,17 @@ class SearchServiceClient {
|
|
505
511
|
* This field should NOT have a fixed value such as `unknown_visitor`.
|
506
512
|
*
|
507
513
|
* This should be the same identifier as
|
508
|
-
* {@link google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
514
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
|
509
515
|
* and
|
510
|
-
* {@link google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
516
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.CompleteQueryRequest.user_pseudo_id|CompleteQueryRequest.user_pseudo_id}
|
511
517
|
*
|
512
518
|
* The field must be a UTF-8 encoded string with a length limit of 128
|
513
519
|
* characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
514
520
|
* @param {google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec} request.contentSearchSpec
|
515
|
-
*
|
516
|
-
* search.
|
521
|
+
* A specification for configuring the behavior of content search.
|
517
522
|
* @param {boolean} request.safeSearch
|
518
523
|
* Whether to turn on safe search. This is only supported for
|
519
|
-
*
|
524
|
+
* website search.
|
520
525
|
* @param {number[]} request.userLabels
|
521
526
|
* The user labels applied to a resource must meet the following requirements:
|
522
527
|
*
|
@@ -538,12 +543,11 @@ class SearchServiceClient {
|
|
538
543
|
* @param {object} [options]
|
539
544
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
540
545
|
* @returns {Object}
|
541
|
-
* An iterable Object that allows
|
546
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
542
547
|
* When you iterate the returned iterable, each element will be an object representing
|
543
|
-
* {@link google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult
|
548
|
+
* {@link protos.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult|SearchResult}. The API will be called under the hood as needed, once per the page,
|
544
549
|
* so you can stop the iteration when you don't need more results.
|
545
|
-
* Please see the
|
546
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
550
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
547
551
|
* for more details and examples.
|
548
552
|
* @example <caption>include:samples/generated/v1beta/search_service.search.js</caption>
|
549
553
|
* region_tag:discoveryengine_v1beta_generated_SearchService_Search_async
|
@@ -716,6 +720,75 @@ class SearchServiceClient {
|
|
716
720
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
|
717
721
|
return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
|
718
722
|
}
|
723
|
+
/**
|
724
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
725
|
+
*
|
726
|
+
* @param {string} project
|
727
|
+
* @param {string} location
|
728
|
+
* @param {string} collection
|
729
|
+
* @param {string} data_store
|
730
|
+
* @param {string} conversation
|
731
|
+
* @returns {string} Resource name string.
|
732
|
+
*/
|
733
|
+
projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
|
734
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
|
735
|
+
project: project,
|
736
|
+
location: location,
|
737
|
+
collection: collection,
|
738
|
+
data_store: dataStore,
|
739
|
+
conversation: conversation,
|
740
|
+
});
|
741
|
+
}
|
742
|
+
/**
|
743
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
744
|
+
*
|
745
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
746
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
747
|
+
* @returns {string} A string representing the project.
|
748
|
+
*/
|
749
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
750
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
|
751
|
+
}
|
752
|
+
/**
|
753
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
754
|
+
*
|
755
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
756
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
757
|
+
* @returns {string} A string representing the location.
|
758
|
+
*/
|
759
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
760
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
|
761
|
+
}
|
762
|
+
/**
|
763
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
764
|
+
*
|
765
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
766
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
767
|
+
* @returns {string} A string representing the collection.
|
768
|
+
*/
|
769
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
770
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
|
771
|
+
}
|
772
|
+
/**
|
773
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
774
|
+
*
|
775
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
776
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
777
|
+
* @returns {string} A string representing the data_store.
|
778
|
+
*/
|
779
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
780
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
|
781
|
+
}
|
782
|
+
/**
|
783
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
784
|
+
*
|
785
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
786
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
787
|
+
* @returns {string} A string representing the conversation.
|
788
|
+
*/
|
789
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
|
790
|
+
return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
|
791
|
+
}
|
719
792
|
/**
|
720
793
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
721
794
|
*
|
@@ -980,6 +1053,63 @@ class SearchServiceClient {
|
|
980
1053
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
|
981
1054
|
return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
|
982
1055
|
}
|
1056
|
+
/**
|
1057
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
1058
|
+
*
|
1059
|
+
* @param {string} project
|
1060
|
+
* @param {string} location
|
1061
|
+
* @param {string} data_store
|
1062
|
+
* @param {string} conversation
|
1063
|
+
* @returns {string} Resource name string.
|
1064
|
+
*/
|
1065
|
+
projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
|
1066
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
|
1067
|
+
project: project,
|
1068
|
+
location: location,
|
1069
|
+
data_store: dataStore,
|
1070
|
+
conversation: conversation,
|
1071
|
+
});
|
1072
|
+
}
|
1073
|
+
/**
|
1074
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
1075
|
+
*
|
1076
|
+
* @param {string} projectLocationDataStoreConversationName
|
1077
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1078
|
+
* @returns {string} A string representing the project.
|
1079
|
+
*/
|
1080
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
|
1081
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
|
1082
|
+
}
|
1083
|
+
/**
|
1084
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
1085
|
+
*
|
1086
|
+
* @param {string} projectLocationDataStoreConversationName
|
1087
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1088
|
+
* @returns {string} A string representing the location.
|
1089
|
+
*/
|
1090
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
|
1091
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
|
1092
|
+
}
|
1093
|
+
/**
|
1094
|
+
* Parse the data_store 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 data_store.
|
1099
|
+
*/
|
1100
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
|
1101
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
|
1102
|
+
}
|
1103
|
+
/**
|
1104
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
1105
|
+
*
|
1106
|
+
* @param {string} projectLocationDataStoreConversationName
|
1107
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1108
|
+
* @returns {string} A string representing the conversation.
|
1109
|
+
*/
|
1110
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
|
1111
|
+
return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
|
1112
|
+
}
|
983
1113
|
/**
|
984
1114
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
985
1115
|
*
|
@@ -119,9 +119,8 @@ export declare class UserEventServiceClient {
|
|
119
119
|
* @param {object} [options]
|
120
120
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
121
121
|
* @returns {Promise} - The promise which resolves to an array.
|
122
|
-
* The first element of the array is an object representing {@link google.cloud.discoveryengine.v1beta.UserEvent
|
123
|
-
* Please see the
|
124
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
122
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1beta.UserEvent|UserEvent}.
|
123
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
125
124
|
* for more details and examples.
|
126
125
|
* @example <caption>include:samples/generated/v1beta/user_event_service.write_user_event.js</caption>
|
127
126
|
* region_tag:discoveryengine_v1beta_generated_UserEventService_WriteUserEvent_async
|
@@ -135,7 +134,7 @@ export declare class UserEventServiceClient {
|
|
135
134
|
writeUserEvent(request: protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IUserEvent, protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
|
136
135
|
/**
|
137
136
|
* Writes a single user event from the browser. This uses a GET request to
|
138
|
-
* due to browser restriction of POST-ing to a
|
137
|
+
* due to browser restriction of POST-ing to a third-party domain.
|
139
138
|
*
|
140
139
|
* This method is used only by the Discovery Engine API JavaScript pixel and
|
141
140
|
* Google Tag Manager. Users should not call this method directly.
|
@@ -151,7 +150,7 @@ export declare class UserEventServiceClient {
|
|
151
150
|
* @param {string} request.uri
|
152
151
|
* The URL including cgi-parameters but excluding the hash fragment with a
|
153
152
|
* length limit of 5,000 characters. This is often more useful than the
|
154
|
-
* referer URL, because many browsers only send the domain for
|
153
|
+
* referer URL, because many browsers only send the domain for third-party
|
155
154
|
* requests.
|
156
155
|
* @param {number} request.ets
|
157
156
|
* The event timestamp in milliseconds. This prevents browser caching of
|
@@ -160,9 +159,8 @@ export declare class UserEventServiceClient {
|
|
160
159
|
* @param {object} [options]
|
161
160
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
162
161
|
* @returns {Promise} - The promise which resolves to an array.
|
163
|
-
* The first element of the array is an object representing {@link google.api.HttpBody
|
164
|
-
* Please see the
|
165
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
162
|
+
* The first element of the array is an object representing {@link protos.google.api.HttpBody|HttpBody}.
|
163
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
166
164
|
* for more details and examples.
|
167
165
|
* @example <caption>include:samples/generated/v1beta/user_event_service.collect_user_event.js</caption>
|
168
166
|
* region_tag:discoveryengine_v1beta_generated_UserEventService_CollectUserEvent_async
|
@@ -186,11 +184,11 @@ export declare class UserEventServiceClient {
|
|
186
184
|
* @param {Object} request
|
187
185
|
* The request object that will be sent.
|
188
186
|
* @param {google.cloud.discoveryengine.v1beta.ImportUserEventsRequest.InlineSource} request.inlineSource
|
189
|
-
*
|
187
|
+
* The Inline source for the input content for UserEvents.
|
190
188
|
* @param {google.cloud.discoveryengine.v1beta.GcsSource} request.gcsSource
|
191
|
-
*
|
189
|
+
* Cloud Storage location for the input content.
|
192
190
|
* @param {google.cloud.discoveryengine.v1beta.BigQuerySource} request.bigquerySource
|
193
|
-
*
|
191
|
+
* BigQuery input source.
|
194
192
|
* @param {string} request.parent
|
195
193
|
* Required. Parent DataStore resource name, of the form
|
196
194
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
|
@@ -203,8 +201,7 @@ export declare class UserEventServiceClient {
|
|
203
201
|
* The first element of the array is an object representing
|
204
202
|
* a long running operation. Its `promise()` method returns a promise
|
205
203
|
* you can `await` for.
|
206
|
-
* Please see the
|
207
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
204
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
208
205
|
* for more details and examples.
|
209
206
|
* @example <caption>include:samples/generated/v1beta/user_event_service.import_user_events.js</caption>
|
210
207
|
* region_tag:discoveryengine_v1beta_generated_UserEventService_ImportUserEvents_async
|
@@ -222,8 +219,7 @@ export declare class UserEventServiceClient {
|
|
222
219
|
* The operation name that will be passed.
|
223
220
|
* @returns {Promise} - The promise which resolves to an object.
|
224
221
|
* The decoded operation object has result and metadata field to get information from.
|
225
|
-
* Please see the
|
226
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
222
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
227
223
|
* for more details and examples.
|
228
224
|
* @example <caption>include:samples/generated/v1beta/user_event_service.import_user_events.js</caption>
|
229
225
|
* region_tag:discoveryengine_v1beta_generated_UserEventService_ImportUserEvents_async
|
@@ -451,6 +447,57 @@ export declare class UserEventServiceClient {
|
|
451
447
|
* @returns {string} A string representing the document.
|
452
448
|
*/
|
453
449
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
450
|
+
/**
|
451
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
452
|
+
*
|
453
|
+
* @param {string} project
|
454
|
+
* @param {string} location
|
455
|
+
* @param {string} collection
|
456
|
+
* @param {string} data_store
|
457
|
+
* @param {string} conversation
|
458
|
+
* @returns {string} Resource name string.
|
459
|
+
*/
|
460
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
461
|
+
/**
|
462
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
463
|
+
*
|
464
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
465
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
466
|
+
* @returns {string} A string representing the project.
|
467
|
+
*/
|
468
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
469
|
+
/**
|
470
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
471
|
+
*
|
472
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
473
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
474
|
+
* @returns {string} A string representing the location.
|
475
|
+
*/
|
476
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
477
|
+
/**
|
478
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
479
|
+
*
|
480
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
481
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
482
|
+
* @returns {string} A string representing the collection.
|
483
|
+
*/
|
484
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
485
|
+
/**
|
486
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
487
|
+
*
|
488
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
489
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
490
|
+
* @returns {string} A string representing the data_store.
|
491
|
+
*/
|
492
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
493
|
+
/**
|
494
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
495
|
+
*
|
496
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
497
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
498
|
+
* @returns {string} A string representing the conversation.
|
499
|
+
*/
|
500
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
454
501
|
/**
|
455
502
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
456
503
|
*
|
@@ -586,6 +633,48 @@ export declare class UserEventServiceClient {
|
|
586
633
|
* @returns {string} A string representing the document.
|
587
634
|
*/
|
588
635
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
636
|
+
/**
|
637
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
638
|
+
*
|
639
|
+
* @param {string} project
|
640
|
+
* @param {string} location
|
641
|
+
* @param {string} data_store
|
642
|
+
* @param {string} conversation
|
643
|
+
* @returns {string} Resource name string.
|
644
|
+
*/
|
645
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
646
|
+
/**
|
647
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
648
|
+
*
|
649
|
+
* @param {string} projectLocationDataStoreConversationName
|
650
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
651
|
+
* @returns {string} A string representing the project.
|
652
|
+
*/
|
653
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
654
|
+
/**
|
655
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
656
|
+
*
|
657
|
+
* @param {string} projectLocationDataStoreConversationName
|
658
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
659
|
+
* @returns {string} A string representing the location.
|
660
|
+
*/
|
661
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
662
|
+
/**
|
663
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
664
|
+
*
|
665
|
+
* @param {string} projectLocationDataStoreConversationName
|
666
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
667
|
+
* @returns {string} A string representing the data_store.
|
668
|
+
*/
|
669
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
670
|
+
/**
|
671
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
672
|
+
*
|
673
|
+
* @param {string} projectLocationDataStoreConversationName
|
674
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
675
|
+
* @returns {string} A string representing the conversation.
|
676
|
+
*/
|
677
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
589
678
|
/**
|
590
679
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
591
680
|
*
|