@google-cloud/discoveryengine 1.2.0 → 1.3.1

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 (63) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +25 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +38 -8
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +98 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +307 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +370 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +336 -0
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +9 -3
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +123 -3
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
  16. package/build/protos/protos.d.ts +10923 -3222
  17. package/build/protos/protos.js +29891 -12914
  18. package/build/protos/protos.json +2367 -668
  19. package/build/src/index.js +1 -1
  20. package/build/src/v1/completion_service_client.js +1 -1
  21. package/build/src/v1/conversational_search_service_client.js +1 -1
  22. package/build/src/v1/document_service_client.js +1 -1
  23. package/build/src/v1/index.js +1 -1
  24. package/build/src/v1/schema_service_client.js +1 -1
  25. package/build/src/v1/search_service_client.js +1 -1
  26. package/build/src/v1/user_event_service_client.js +1 -1
  27. package/build/src/v1alpha/completion_service_client.d.ts +261 -0
  28. package/build/src/v1alpha/completion_service_client.js +360 -0
  29. package/build/src/v1alpha/conversational_search_service_client.d.ts +278 -0
  30. package/build/src/v1alpha/conversational_search_service_client.js +360 -0
  31. package/build/src/v1alpha/data_store_service_client.d.ts +1279 -0
  32. package/build/src/v1alpha/data_store_service_client.js +1739 -0
  33. package/build/src/v1alpha/data_store_service_client_config.json +46 -0
  34. package/build/src/v1alpha/document_service_client.d.ts +336 -0
  35. package/build/src/v1alpha/document_service_client.js +472 -2
  36. package/build/src/v1alpha/engine_service_client.d.ts +1298 -0
  37. package/build/src/v1alpha/engine_service_client.js +1789 -0
  38. package/build/src/v1alpha/engine_service_client_config.json +58 -0
  39. package/build/src/v1alpha/index.d.ts +3 -0
  40. package/build/src/v1alpha/index.js +7 -1
  41. package/build/src/v1alpha/recommendation_service_client.d.ts +345 -3
  42. package/build/src/v1alpha/recommendation_service_client.js +464 -0
  43. package/build/src/v1alpha/schema_service_client.d.ts +261 -0
  44. package/build/src/v1alpha/schema_service_client.js +368 -2
  45. package/build/src/v1alpha/search_service_client.d.ts +453 -9
  46. package/build/src/v1alpha/search_service_client.js +542 -6
  47. package/build/src/v1alpha/search_tuning_service_client.d.ts +968 -0
  48. package/build/src/v1alpha/search_tuning_service_client.js +1452 -0
  49. package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
  50. package/build/src/v1alpha/site_search_engine_service_client.d.ts +856 -1
  51. package/build/src/v1alpha/site_search_engine_service_client.js +993 -34
  52. package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
  53. package/build/src/v1alpha/user_event_service_client.d.ts +261 -0
  54. package/build/src/v1alpha/user_event_service_client.js +368 -2
  55. package/build/src/v1beta/completion_service_client.js +1 -1
  56. package/build/src/v1beta/conversational_search_service_client.js +1 -1
  57. package/build/src/v1beta/document_service_client.js +1 -1
  58. package/build/src/v1beta/index.js +1 -1
  59. package/build/src/v1beta/recommendation_service_client.js +1 -1
  60. package/build/src/v1beta/schema_service_client.js +1 -1
  61. package/build/src/v1beta/search_service_client.js +1 -1
  62. package/build/src/v1beta/user_event_service_client.js +1 -1
  63. package/package.json +4 -4
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
- // Copyright 2023 Google LLC
2
+ // Copyright 2024 Google LLC
3
3
  //
4
4
  // Licensed under the Apache License, Version 2.0 (the "License");
5
5
  // you may not use this file except in compliance with the License.
@@ -221,6 +221,48 @@ export declare class CompletionServiceClient {
221
221
  * ```
222
222
  */
223
223
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
224
+ /**
225
+ * Return a fully-qualified engine resource name string.
226
+ *
227
+ * @param {string} project
228
+ * @param {string} location
229
+ * @param {string} collection
230
+ * @param {string} engine
231
+ * @returns {string} Resource name string.
232
+ */
233
+ enginePath(project: string, location: string, collection: string, engine: string): string;
234
+ /**
235
+ * Parse the project from Engine resource.
236
+ *
237
+ * @param {string} engineName
238
+ * A fully-qualified path representing Engine resource.
239
+ * @returns {string} A string representing the project.
240
+ */
241
+ matchProjectFromEngineName(engineName: string): string | number;
242
+ /**
243
+ * Parse the location from Engine resource.
244
+ *
245
+ * @param {string} engineName
246
+ * A fully-qualified path representing Engine resource.
247
+ * @returns {string} A string representing the location.
248
+ */
249
+ matchLocationFromEngineName(engineName: string): string | number;
250
+ /**
251
+ * Parse the collection from Engine resource.
252
+ *
253
+ * @param {string} engineName
254
+ * A fully-qualified path representing Engine resource.
255
+ * @returns {string} A string representing the collection.
256
+ */
257
+ matchCollectionFromEngineName(engineName: string): string | number;
258
+ /**
259
+ * Parse the engine from Engine resource.
260
+ *
261
+ * @param {string} engineName
262
+ * A fully-qualified path representing Engine resource.
263
+ * @returns {string} A string representing the engine.
264
+ */
265
+ matchEngineFromEngineName(engineName: string): string | number;
224
266
  /**
225
267
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
226
268
  *
@@ -425,6 +467,150 @@ export declare class CompletionServiceClient {
425
467
  * @returns {string} A string representing the schema.
426
468
  */
427
469
  matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
470
+ /**
471
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
472
+ *
473
+ * @param {string} project
474
+ * @param {string} location
475
+ * @param {string} collection
476
+ * @param {string} data_store
477
+ * @returns {string} Resource name string.
478
+ */
479
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
480
+ /**
481
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
482
+ *
483
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
484
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
485
+ * @returns {string} A string representing the project.
486
+ */
487
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
488
+ /**
489
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
490
+ *
491
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
492
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
493
+ * @returns {string} A string representing the location.
494
+ */
495
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
496
+ /**
497
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
498
+ *
499
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
500
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
501
+ * @returns {string} A string representing the collection.
502
+ */
503
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
504
+ /**
505
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
506
+ *
507
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
508
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
509
+ * @returns {string} A string representing the data_store.
510
+ */
511
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
512
+ /**
513
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
514
+ *
515
+ * @param {string} project
516
+ * @param {string} location
517
+ * @param {string} collection
518
+ * @param {string} data_store
519
+ * @param {string} target_site
520
+ * @returns {string} Resource name string.
521
+ */
522
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
523
+ /**
524
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
525
+ *
526
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
527
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
528
+ * @returns {string} A string representing the project.
529
+ */
530
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
531
+ /**
532
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
533
+ *
534
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
535
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
536
+ * @returns {string} A string representing the location.
537
+ */
538
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
539
+ /**
540
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
541
+ *
542
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
543
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
544
+ * @returns {string} A string representing the collection.
545
+ */
546
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
547
+ /**
548
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
549
+ *
550
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
551
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
552
+ * @returns {string} A string representing the data_store.
553
+ */
554
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
555
+ /**
556
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
557
+ *
558
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
559
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
560
+ * @returns {string} A string representing the target_site.
561
+ */
562
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
563
+ /**
564
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
565
+ *
566
+ * @param {string} project
567
+ * @param {string} location
568
+ * @param {string} collection
569
+ * @param {string} engine
570
+ * @param {string} conversation
571
+ * @returns {string} Resource name string.
572
+ */
573
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
574
+ /**
575
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
576
+ *
577
+ * @param {string} projectLocationCollectionEngineConversationName
578
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
579
+ * @returns {string} A string representing the project.
580
+ */
581
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
582
+ /**
583
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
584
+ *
585
+ * @param {string} projectLocationCollectionEngineConversationName
586
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
587
+ * @returns {string} A string representing the location.
588
+ */
589
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
590
+ /**
591
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
592
+ *
593
+ * @param {string} projectLocationCollectionEngineConversationName
594
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
595
+ * @returns {string} A string representing the collection.
596
+ */
597
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
598
+ /**
599
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
600
+ *
601
+ * @param {string} projectLocationCollectionEngineConversationName
602
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
603
+ * @returns {string} A string representing the engine.
604
+ */
605
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
606
+ /**
607
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
608
+ *
609
+ * @param {string} projectLocationCollectionEngineConversationName
610
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
611
+ * @returns {string} A string representing the conversation.
612
+ */
613
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
428
614
  /**
429
615
  * Return a fully-qualified projectLocationDataStore resource name string.
430
616
  *
@@ -593,6 +779,81 @@ export declare class CompletionServiceClient {
593
779
  * @returns {string} A string representing the schema.
594
780
  */
595
781
  matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
782
+ /**
783
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
784
+ *
785
+ * @param {string} project
786
+ * @param {string} location
787
+ * @param {string} data_store
788
+ * @returns {string} Resource name string.
789
+ */
790
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
791
+ /**
792
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
793
+ *
794
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
795
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
796
+ * @returns {string} A string representing the project.
797
+ */
798
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
799
+ /**
800
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
801
+ *
802
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
803
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
804
+ * @returns {string} A string representing the location.
805
+ */
806
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
807
+ /**
808
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
809
+ *
810
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
811
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
812
+ * @returns {string} A string representing the data_store.
813
+ */
814
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
815
+ /**
816
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
817
+ *
818
+ * @param {string} project
819
+ * @param {string} location
820
+ * @param {string} data_store
821
+ * @param {string} target_site
822
+ * @returns {string} Resource name string.
823
+ */
824
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
825
+ /**
826
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
827
+ *
828
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
829
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
830
+ * @returns {string} A string representing the project.
831
+ */
832
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
833
+ /**
834
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
835
+ *
836
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
837
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
838
+ * @returns {string} A string representing the location.
839
+ */
840
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
841
+ /**
842
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
843
+ *
844
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
845
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
846
+ * @returns {string} A string representing the data_store.
847
+ */
848
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
849
+ /**
850
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
851
+ *
852
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
853
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
854
+ * @returns {string} A string representing the target_site.
855
+ */
856
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
596
857
  /**
597
858
  * Terminate the gRPC channel and close the client.
598
859
  *