@google-cloud/discoveryengine 1.10.0 → 1.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +33 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto +232 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation_service.proto +252 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +83 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto +86 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto +264 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto +64 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto +258 -0
  10. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +14 -0
  11. package/build/protos/google/cloud/discoveryengine/v1beta/chunk.proto +119 -0
  12. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
  13. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +31 -0
  14. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +29 -2
  16. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +7 -1
  17. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +23 -0
  18. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +10 -0
  19. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  20. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
  21. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
  22. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
  23. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +191 -0
  24. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +111 -0
  25. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
  26. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
  27. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +370 -8
  30. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
  31. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +24 -0
  32. package/build/protos/protos.d.ts +32735 -21073
  33. package/build/protos/protos.js +80768 -53241
  34. package/build/protos/protos.json +5309 -2481
  35. package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
  36. package/build/src/v1alpha/acl_config_service_client.js +157 -0
  37. package/build/src/v1alpha/chunk_service_client.d.ts +108 -0
  38. package/build/src/v1alpha/chunk_service_client.js +157 -0
  39. package/build/src/v1alpha/completion_service_client.d.ts +108 -0
  40. package/build/src/v1alpha/completion_service_client.js +157 -0
  41. package/build/src/v1alpha/control_service_client.d.ts +108 -0
  42. package/build/src/v1alpha/control_service_client.js +157 -0
  43. package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -0
  44. package/build/src/v1alpha/conversational_search_service_client.js +157 -0
  45. package/build/src/v1alpha/data_store_service_client.d.ts +108 -0
  46. package/build/src/v1alpha/data_store_service_client.js +157 -0
  47. package/build/src/v1alpha/document_service_client.d.ts +108 -0
  48. package/build/src/v1alpha/document_service_client.js +157 -0
  49. package/build/src/v1alpha/engine_service_client.d.ts +108 -0
  50. package/build/src/v1alpha/engine_service_client.js +157 -0
  51. package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
  52. package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
  53. package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
  54. package/build/src/v1alpha/evaluation_service_client.js +3288 -0
  55. package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
  56. package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
  57. package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
  58. package/build/src/v1alpha/index.d.ts +3 -0
  59. package/build/src/v1alpha/index.js +7 -1
  60. package/build/src/v1alpha/project_service_client.d.ts +108 -0
  61. package/build/src/v1alpha/project_service_client.js +157 -0
  62. package/build/src/v1alpha/rank_service_client.d.ts +108 -0
  63. package/build/src/v1alpha/rank_service_client.js +157 -0
  64. package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
  65. package/build/src/v1alpha/recommendation_service_client.js +157 -0
  66. package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
  67. package/build/src/v1alpha/sample_query_service_client.js +3186 -0
  68. package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
  69. package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
  70. package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
  71. package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
  72. package/build/src/v1alpha/schema_service_client.d.ts +108 -0
  73. package/build/src/v1alpha/schema_service_client.js +157 -0
  74. package/build/src/v1alpha/search_service_client.d.ts +108 -0
  75. package/build/src/v1alpha/search_service_client.js +157 -0
  76. package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
  77. package/build/src/v1alpha/search_tuning_service_client.js +157 -0
  78. package/build/src/v1alpha/serving_config_service_client.d.ts +108 -0
  79. package/build/src/v1alpha/serving_config_service_client.js +157 -0
  80. package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -0
  81. package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
  82. package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
  83. package/build/src/v1alpha/user_event_service_client.js +157 -0
  84. package/build/src/v1beta/completion_service_client.d.ts +328 -0
  85. package/build/src/v1beta/completion_service_client.js +423 -0
  86. package/build/src/v1beta/completion_service_client_config.json +10 -0
  87. package/build/src/v1beta/control_service_client.d.ts +237 -0
  88. package/build/src/v1beta/control_service_client.js +333 -0
  89. package/build/src/v1beta/conversational_search_service_client.d.ts +255 -0
  90. package/build/src/v1beta/conversational_search_service_client.js +333 -0
  91. package/build/src/v1beta/data_store_service_client.d.ts +246 -0
  92. package/build/src/v1beta/data_store_service_client.js +339 -0
  93. package/build/src/v1beta/document_service_client.d.ts +239 -0
  94. package/build/src/v1beta/document_service_client.js +339 -0
  95. package/build/src/v1beta/engine_service_client.d.ts +237 -0
  96. package/build/src/v1beta/engine_service_client.js +339 -0
  97. package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
  98. package/build/src/v1beta/evaluation_service_client.js +3252 -0
  99. package/build/src/v1beta/evaluation_service_client_config.json +58 -0
  100. package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
  101. package/build/src/v1beta/grounded_generation_service_client.js +333 -0
  102. package/build/src/v1beta/index.d.ts +3 -0
  103. package/build/src/v1beta/index.js +7 -1
  104. package/build/src/v1beta/project_service_client.d.ts +237 -0
  105. package/build/src/v1beta/project_service_client.js +339 -0
  106. package/build/src/v1beta/rank_service_client.d.ts +237 -0
  107. package/build/src/v1beta/rank_service_client.js +333 -0
  108. package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
  109. package/build/src/v1beta/recommendation_service_client.js +333 -0
  110. package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
  111. package/build/src/v1beta/sample_query_service_client.js +3150 -0
  112. package/build/src/v1beta/sample_query_service_client_config.json +68 -0
  113. package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
  114. package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
  115. package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
  116. package/build/src/v1beta/schema_service_client.d.ts +237 -0
  117. package/build/src/v1beta/schema_service_client.js +339 -0
  118. package/build/src/v1beta/search_service_client.d.ts +414 -12
  119. package/build/src/v1beta/search_service_client.js +451 -8
  120. package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
  121. package/build/src/v1beta/search_tuning_service_client.js +339 -0
  122. package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
  123. package/build/src/v1beta/serving_config_service_client.js +333 -0
  124. package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -0
  125. package/build/src/v1beta/site_search_engine_service_client.js +339 -0
  126. package/build/src/v1beta/user_event_service_client.d.ts +312 -0
  127. package/build/src/v1beta/user_event_service_client.js +381 -0
  128. package/build/src/v1beta/user_event_service_client_config.json +5 -0
  129. package/package.json +1 -1
@@ -344,6 +344,39 @@ export declare class RecommendationServiceClient {
344
344
  * @returns {string} A string representing the engine.
345
345
  */
346
346
  matchEngineFromEngineName(engineName: string): string | number;
347
+ /**
348
+ * Return a fully-qualified evaluation resource name string.
349
+ *
350
+ * @param {string} project
351
+ * @param {string} location
352
+ * @param {string} evaluation
353
+ * @returns {string} Resource name string.
354
+ */
355
+ evaluationPath(project: string, location: string, evaluation: string): string;
356
+ /**
357
+ * Parse the project from Evaluation resource.
358
+ *
359
+ * @param {string} evaluationName
360
+ * A fully-qualified path representing Evaluation resource.
361
+ * @returns {string} A string representing the project.
362
+ */
363
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
364
+ /**
365
+ * Parse the location from Evaluation resource.
366
+ *
367
+ * @param {string} evaluationName
368
+ * A fully-qualified path representing Evaluation resource.
369
+ * @returns {string} A string representing the location.
370
+ */
371
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
372
+ /**
373
+ * Parse the evaluation from Evaluation resource.
374
+ *
375
+ * @param {string} evaluationName
376
+ * A fully-qualified path representing Evaluation resource.
377
+ * @returns {string} A string representing the evaluation.
378
+ */
379
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
347
380
  /**
348
381
  * Return a fully-qualified project resource name string.
349
382
  *
@@ -461,6 +494,75 @@ export declare class RecommendationServiceClient {
461
494
  * @returns {string} A string representing the document.
462
495
  */
463
496
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
497
+ /**
498
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
499
+ *
500
+ * @param {string} project
501
+ * @param {string} location
502
+ * @param {string} collection
503
+ * @param {string} data_store
504
+ * @param {string} branch
505
+ * @param {string} document
506
+ * @param {string} chunk
507
+ * @returns {string} Resource name string.
508
+ */
509
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;
510
+ /**
511
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
512
+ *
513
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
514
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
515
+ * @returns {string} A string representing the project.
516
+ */
517
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
518
+ /**
519
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
520
+ *
521
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
522
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
523
+ * @returns {string} A string representing the location.
524
+ */
525
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
526
+ /**
527
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
528
+ *
529
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
530
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
531
+ * @returns {string} A string representing the collection.
532
+ */
533
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
534
+ /**
535
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
536
+ *
537
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
538
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
539
+ * @returns {string} A string representing the data_store.
540
+ */
541
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
542
+ /**
543
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
544
+ *
545
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
546
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
547
+ * @returns {string} A string representing the branch.
548
+ */
549
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
550
+ /**
551
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
552
+ *
553
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
554
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
555
+ * @returns {string} A string representing the document.
556
+ */
557
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
558
+ /**
559
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
560
+ *
561
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
562
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
563
+ * @returns {string} A string representing the chunk.
564
+ */
565
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
464
566
  /**
465
567
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
466
568
  *
@@ -1310,6 +1412,66 @@ export declare class RecommendationServiceClient {
1310
1412
  * @returns {string} A string representing the document.
1311
1413
  */
1312
1414
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1415
+ /**
1416
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
1417
+ *
1418
+ * @param {string} project
1419
+ * @param {string} location
1420
+ * @param {string} data_store
1421
+ * @param {string} branch
1422
+ * @param {string} document
1423
+ * @param {string} chunk
1424
+ * @returns {string} Resource name string.
1425
+ */
1426
+ projectLocationDataStoreBranchDocumentChunkPath(project: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;
1427
+ /**
1428
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
1429
+ *
1430
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1431
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1432
+ * @returns {string} A string representing the project.
1433
+ */
1434
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1435
+ /**
1436
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
1437
+ *
1438
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1439
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1440
+ * @returns {string} A string representing the location.
1441
+ */
1442
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1443
+ /**
1444
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
1445
+ *
1446
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1447
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1448
+ * @returns {string} A string representing the data_store.
1449
+ */
1450
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1451
+ /**
1452
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
1453
+ *
1454
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1455
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1456
+ * @returns {string} A string representing the branch.
1457
+ */
1458
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1459
+ /**
1460
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
1461
+ *
1462
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1463
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1464
+ * @returns {string} A string representing the document.
1465
+ */
1466
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1467
+ /**
1468
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
1469
+ *
1470
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1471
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1472
+ * @returns {string} A string representing the chunk.
1473
+ */
1474
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1313
1475
  /**
1314
1476
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
1315
1477
  *
@@ -1721,6 +1883,81 @@ export declare class RecommendationServiceClient {
1721
1883
  * @returns {string} A string representing the target_site.
1722
1884
  */
1723
1885
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1886
+ /**
1887
+ * Return a fully-qualified sampleQuery resource name string.
1888
+ *
1889
+ * @param {string} project
1890
+ * @param {string} location
1891
+ * @param {string} sample_query_set
1892
+ * @param {string} sample_query
1893
+ * @returns {string} Resource name string.
1894
+ */
1895
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
1896
+ /**
1897
+ * Parse the project from SampleQuery resource.
1898
+ *
1899
+ * @param {string} sampleQueryName
1900
+ * A fully-qualified path representing SampleQuery resource.
1901
+ * @returns {string} A string representing the project.
1902
+ */
1903
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
1904
+ /**
1905
+ * Parse the location from SampleQuery resource.
1906
+ *
1907
+ * @param {string} sampleQueryName
1908
+ * A fully-qualified path representing SampleQuery resource.
1909
+ * @returns {string} A string representing the location.
1910
+ */
1911
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
1912
+ /**
1913
+ * Parse the sample_query_set from SampleQuery resource.
1914
+ *
1915
+ * @param {string} sampleQueryName
1916
+ * A fully-qualified path representing SampleQuery resource.
1917
+ * @returns {string} A string representing the sample_query_set.
1918
+ */
1919
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
1920
+ /**
1921
+ * Parse the sample_query from SampleQuery resource.
1922
+ *
1923
+ * @param {string} sampleQueryName
1924
+ * A fully-qualified path representing SampleQuery resource.
1925
+ * @returns {string} A string representing the sample_query.
1926
+ */
1927
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
1928
+ /**
1929
+ * Return a fully-qualified sampleQuerySet resource name string.
1930
+ *
1931
+ * @param {string} project
1932
+ * @param {string} location
1933
+ * @param {string} sample_query_set
1934
+ * @returns {string} Resource name string.
1935
+ */
1936
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
1937
+ /**
1938
+ * Parse the project from SampleQuerySet resource.
1939
+ *
1940
+ * @param {string} sampleQuerySetName
1941
+ * A fully-qualified path representing SampleQuerySet resource.
1942
+ * @returns {string} A string representing the project.
1943
+ */
1944
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1945
+ /**
1946
+ * Parse the location from SampleQuerySet resource.
1947
+ *
1948
+ * @param {string} sampleQuerySetName
1949
+ * A fully-qualified path representing SampleQuerySet resource.
1950
+ * @returns {string} A string representing the location.
1951
+ */
1952
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1953
+ /**
1954
+ * Parse the sample_query_set from SampleQuerySet resource.
1955
+ *
1956
+ * @param {string} sampleQuerySetName
1957
+ * A fully-qualified path representing SampleQuerySet resource.
1958
+ * @returns {string} A string representing the sample_query_set.
1959
+ */
1960
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1724
1961
  /**
1725
1962
  * Terminate the gRPC channel and close the client.
1726
1963
  *
@@ -151,9 +151,11 @@ class RecommendationServiceClient {
151
151
  // Create useful helper objects for these.
152
152
  this.pathTemplates = {
153
153
  enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
154
+ evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
154
155
  projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
155
156
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
156
157
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
158
+ projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
157
159
  projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
158
160
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
159
161
  projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -171,6 +173,7 @@ class RecommendationServiceClient {
171
173
  projectLocationCollectionEngineSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}'),
172
174
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
173
175
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
176
+ projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
174
177
  projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
175
178
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
176
179
  projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -181,6 +184,8 @@ class RecommendationServiceClient {
181
184
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
182
185
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
183
186
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
187
+ sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
188
+ sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
184
189
  };
185
190
  // Put together the default options sent with requests.
186
191
  this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1beta.RecommendationService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -429,6 +434,54 @@ class RecommendationServiceClient {
429
434
  matchEngineFromEngineName(engineName) {
430
435
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
431
436
  }
437
+ /**
438
+ * Return a fully-qualified evaluation resource name string.
439
+ *
440
+ * @param {string} project
441
+ * @param {string} location
442
+ * @param {string} evaluation
443
+ * @returns {string} Resource name string.
444
+ */
445
+ evaluationPath(project, location, evaluation) {
446
+ return this.pathTemplates.evaluationPathTemplate.render({
447
+ project: project,
448
+ location: location,
449
+ evaluation: evaluation,
450
+ });
451
+ }
452
+ /**
453
+ * Parse the project from Evaluation resource.
454
+ *
455
+ * @param {string} evaluationName
456
+ * A fully-qualified path representing Evaluation resource.
457
+ * @returns {string} A string representing the project.
458
+ */
459
+ matchProjectFromEvaluationName(evaluationName) {
460
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
461
+ .project;
462
+ }
463
+ /**
464
+ * Parse the location from Evaluation resource.
465
+ *
466
+ * @param {string} evaluationName
467
+ * A fully-qualified path representing Evaluation resource.
468
+ * @returns {string} A string representing the location.
469
+ */
470
+ matchLocationFromEvaluationName(evaluationName) {
471
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
472
+ .location;
473
+ }
474
+ /**
475
+ * Parse the evaluation from Evaluation resource.
476
+ *
477
+ * @param {string} evaluationName
478
+ * A fully-qualified path representing Evaluation resource.
479
+ * @returns {string} A string representing the evaluation.
480
+ */
481
+ matchEvaluationFromEvaluationName(evaluationName) {
482
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
483
+ .evaluation;
484
+ }
432
485
  /**
433
486
  * Return a fully-qualified project resource name string.
434
487
  *
@@ -588,6 +641,99 @@ class RecommendationServiceClient {
588
641
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
589
642
  return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
590
643
  }
644
+ /**
645
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
646
+ *
647
+ * @param {string} project
648
+ * @param {string} location
649
+ * @param {string} collection
650
+ * @param {string} data_store
651
+ * @param {string} branch
652
+ * @param {string} document
653
+ * @param {string} chunk
654
+ * @returns {string} Resource name string.
655
+ */
656
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project, location, collection, dataStore, branch, document, chunk) {
657
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.render({
658
+ project: project,
659
+ location: location,
660
+ collection: collection,
661
+ data_store: dataStore,
662
+ branch: branch,
663
+ document: document,
664
+ chunk: chunk,
665
+ });
666
+ }
667
+ /**
668
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
669
+ *
670
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
671
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
672
+ * @returns {string} A string representing the project.
673
+ */
674
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
675
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).project;
676
+ }
677
+ /**
678
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
679
+ *
680
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
681
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
682
+ * @returns {string} A string representing the location.
683
+ */
684
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
685
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).location;
686
+ }
687
+ /**
688
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
689
+ *
690
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
691
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
692
+ * @returns {string} A string representing the collection.
693
+ */
694
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
695
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).collection;
696
+ }
697
+ /**
698
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
699
+ *
700
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
701
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
702
+ * @returns {string} A string representing the data_store.
703
+ */
704
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
705
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).data_store;
706
+ }
707
+ /**
708
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
709
+ *
710
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
711
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
712
+ * @returns {string} A string representing the branch.
713
+ */
714
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
715
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).branch;
716
+ }
717
+ /**
718
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
719
+ *
720
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
721
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
722
+ * @returns {string} A string representing the document.
723
+ */
724
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
725
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).document;
726
+ }
727
+ /**
728
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
729
+ *
730
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
731
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
732
+ * @returns {string} A string representing the chunk.
733
+ */
734
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
735
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).chunk;
736
+ }
591
737
  /**
592
738
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
593
739
  *
@@ -1737,6 +1883,87 @@ class RecommendationServiceClient {
1737
1883
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1738
1884
  return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
1739
1885
  }
1886
+ /**
1887
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
1888
+ *
1889
+ * @param {string} project
1890
+ * @param {string} location
1891
+ * @param {string} data_store
1892
+ * @param {string} branch
1893
+ * @param {string} document
1894
+ * @param {string} chunk
1895
+ * @returns {string} Resource name string.
1896
+ */
1897
+ projectLocationDataStoreBranchDocumentChunkPath(project, location, dataStore, branch, document, chunk) {
1898
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.render({
1899
+ project: project,
1900
+ location: location,
1901
+ data_store: dataStore,
1902
+ branch: branch,
1903
+ document: document,
1904
+ chunk: chunk,
1905
+ });
1906
+ }
1907
+ /**
1908
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
1909
+ *
1910
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1911
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1912
+ * @returns {string} A string representing the project.
1913
+ */
1914
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1915
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).project;
1916
+ }
1917
+ /**
1918
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
1919
+ *
1920
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1921
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1922
+ * @returns {string} A string representing the location.
1923
+ */
1924
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1925
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).location;
1926
+ }
1927
+ /**
1928
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
1929
+ *
1930
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1931
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1932
+ * @returns {string} A string representing the data_store.
1933
+ */
1934
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1935
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).data_store;
1936
+ }
1937
+ /**
1938
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
1939
+ *
1940
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1941
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1942
+ * @returns {string} A string representing the branch.
1943
+ */
1944
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1945
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).branch;
1946
+ }
1947
+ /**
1948
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
1949
+ *
1950
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1951
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1952
+ * @returns {string} A string representing the document.
1953
+ */
1954
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1955
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).document;
1956
+ }
1957
+ /**
1958
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
1959
+ *
1960
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1961
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1962
+ * @returns {string} A string representing the chunk.
1963
+ */
1964
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1965
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).chunk;
1966
+ }
1740
1967
  /**
1741
1968
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
1742
1969
  *
@@ -2295,6 +2522,112 @@ class RecommendationServiceClient {
2295
2522
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2296
2523
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2297
2524
  }
2525
+ /**
2526
+ * Return a fully-qualified sampleQuery resource name string.
2527
+ *
2528
+ * @param {string} project
2529
+ * @param {string} location
2530
+ * @param {string} sample_query_set
2531
+ * @param {string} sample_query
2532
+ * @returns {string} Resource name string.
2533
+ */
2534
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2535
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2536
+ project: project,
2537
+ location: location,
2538
+ sample_query_set: sampleQuerySet,
2539
+ sample_query: sampleQuery,
2540
+ });
2541
+ }
2542
+ /**
2543
+ * Parse the project from SampleQuery resource.
2544
+ *
2545
+ * @param {string} sampleQueryName
2546
+ * A fully-qualified path representing SampleQuery resource.
2547
+ * @returns {string} A string representing the project.
2548
+ */
2549
+ matchProjectFromSampleQueryName(sampleQueryName) {
2550
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2551
+ .project;
2552
+ }
2553
+ /**
2554
+ * Parse the location from SampleQuery resource.
2555
+ *
2556
+ * @param {string} sampleQueryName
2557
+ * A fully-qualified path representing SampleQuery resource.
2558
+ * @returns {string} A string representing the location.
2559
+ */
2560
+ matchLocationFromSampleQueryName(sampleQueryName) {
2561
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2562
+ .location;
2563
+ }
2564
+ /**
2565
+ * Parse the sample_query_set from SampleQuery resource.
2566
+ *
2567
+ * @param {string} sampleQueryName
2568
+ * A fully-qualified path representing SampleQuery resource.
2569
+ * @returns {string} A string representing the sample_query_set.
2570
+ */
2571
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2572
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2573
+ .sample_query_set;
2574
+ }
2575
+ /**
2576
+ * Parse the sample_query from SampleQuery resource.
2577
+ *
2578
+ * @param {string} sampleQueryName
2579
+ * A fully-qualified path representing SampleQuery resource.
2580
+ * @returns {string} A string representing the sample_query.
2581
+ */
2582
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2583
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2584
+ .sample_query;
2585
+ }
2586
+ /**
2587
+ * Return a fully-qualified sampleQuerySet resource name string.
2588
+ *
2589
+ * @param {string} project
2590
+ * @param {string} location
2591
+ * @param {string} sample_query_set
2592
+ * @returns {string} Resource name string.
2593
+ */
2594
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2595
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2596
+ project: project,
2597
+ location: location,
2598
+ sample_query_set: sampleQuerySet,
2599
+ });
2600
+ }
2601
+ /**
2602
+ * Parse the project from SampleQuerySet resource.
2603
+ *
2604
+ * @param {string} sampleQuerySetName
2605
+ * A fully-qualified path representing SampleQuerySet resource.
2606
+ * @returns {string} A string representing the project.
2607
+ */
2608
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2609
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2610
+ }
2611
+ /**
2612
+ * Parse the location from SampleQuerySet resource.
2613
+ *
2614
+ * @param {string} sampleQuerySetName
2615
+ * A fully-qualified path representing SampleQuerySet resource.
2616
+ * @returns {string} A string representing the location.
2617
+ */
2618
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
2619
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
2620
+ }
2621
+ /**
2622
+ * Parse the sample_query_set from SampleQuerySet resource.
2623
+ *
2624
+ * @param {string} sampleQuerySetName
2625
+ * A fully-qualified path representing SampleQuerySet resource.
2626
+ * @returns {string} A string representing the sample_query_set.
2627
+ */
2628
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
2629
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
2630
+ }
2298
2631
  /**
2299
2632
  * Terminate the gRPC channel and close the client.
2300
2633
  *