@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
@@ -284,6 +284,39 @@ export declare class AclConfigServiceClient {
284
284
  * @returns {string} A string representing the engine.
285
285
  */
286
286
  matchEngineFromEngineName(engineName: string): string | number;
287
+ /**
288
+ * Return a fully-qualified evaluation resource name string.
289
+ *
290
+ * @param {string} project
291
+ * @param {string} location
292
+ * @param {string} evaluation
293
+ * @returns {string} Resource name string.
294
+ */
295
+ evaluationPath(project: string, location: string, evaluation: string): string;
296
+ /**
297
+ * Parse the project from Evaluation resource.
298
+ *
299
+ * @param {string} evaluationName
300
+ * A fully-qualified path representing Evaluation resource.
301
+ * @returns {string} A string representing the project.
302
+ */
303
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
304
+ /**
305
+ * Parse the location from Evaluation resource.
306
+ *
307
+ * @param {string} evaluationName
308
+ * A fully-qualified path representing Evaluation resource.
309
+ * @returns {string} A string representing the location.
310
+ */
311
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
312
+ /**
313
+ * Parse the evaluation from Evaluation resource.
314
+ *
315
+ * @param {string} evaluationName
316
+ * A fully-qualified path representing Evaluation resource.
317
+ * @returns {string} A string representing the evaluation.
318
+ */
319
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
287
320
  /**
288
321
  * Return a fully-qualified project resource name string.
289
322
  *
@@ -1790,6 +1823,81 @@ export declare class AclConfigServiceClient {
1790
1823
  * @returns {string} A string representing the target_site.
1791
1824
  */
1792
1825
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1826
+ /**
1827
+ * Return a fully-qualified sampleQuery resource name string.
1828
+ *
1829
+ * @param {string} project
1830
+ * @param {string} location
1831
+ * @param {string} sample_query_set
1832
+ * @param {string} sample_query
1833
+ * @returns {string} Resource name string.
1834
+ */
1835
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
1836
+ /**
1837
+ * Parse the project from SampleQuery resource.
1838
+ *
1839
+ * @param {string} sampleQueryName
1840
+ * A fully-qualified path representing SampleQuery resource.
1841
+ * @returns {string} A string representing the project.
1842
+ */
1843
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
1844
+ /**
1845
+ * Parse the location from SampleQuery resource.
1846
+ *
1847
+ * @param {string} sampleQueryName
1848
+ * A fully-qualified path representing SampleQuery resource.
1849
+ * @returns {string} A string representing the location.
1850
+ */
1851
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
1852
+ /**
1853
+ * Parse the sample_query_set from SampleQuery resource.
1854
+ *
1855
+ * @param {string} sampleQueryName
1856
+ * A fully-qualified path representing SampleQuery resource.
1857
+ * @returns {string} A string representing the sample_query_set.
1858
+ */
1859
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
1860
+ /**
1861
+ * Parse the sample_query from SampleQuery resource.
1862
+ *
1863
+ * @param {string} sampleQueryName
1864
+ * A fully-qualified path representing SampleQuery resource.
1865
+ * @returns {string} A string representing the sample_query.
1866
+ */
1867
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
1868
+ /**
1869
+ * Return a fully-qualified sampleQuerySet resource name string.
1870
+ *
1871
+ * @param {string} project
1872
+ * @param {string} location
1873
+ * @param {string} sample_query_set
1874
+ * @returns {string} Resource name string.
1875
+ */
1876
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
1877
+ /**
1878
+ * Parse the project from SampleQuerySet resource.
1879
+ *
1880
+ * @param {string} sampleQuerySetName
1881
+ * A fully-qualified path representing SampleQuerySet resource.
1882
+ * @returns {string} A string representing the project.
1883
+ */
1884
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1885
+ /**
1886
+ * Parse the location from SampleQuerySet resource.
1887
+ *
1888
+ * @param {string} sampleQuerySetName
1889
+ * A fully-qualified path representing SampleQuerySet resource.
1890
+ * @returns {string} A string representing the location.
1891
+ */
1892
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1893
+ /**
1894
+ * Parse the sample_query_set from SampleQuerySet resource.
1895
+ *
1896
+ * @param {string} sampleQuerySetName
1897
+ * A fully-qualified path representing SampleQuerySet resource.
1898
+ * @returns {string} A string representing the sample_query_set.
1899
+ */
1900
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1793
1901
  /**
1794
1902
  * Terminate the gRPC channel and close the client.
1795
1903
  *
@@ -151,6 +151,7 @@ class AclConfigServiceClient {
151
151
  this.pathTemplates = {
152
152
  aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
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}'),
@@ -183,6 +184,8 @@ class AclConfigServiceClient {
183
184
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
184
185
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
185
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}'),
186
189
  };
187
190
  // Put together the default options sent with requests.
188
191
  this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.AclConfigService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -487,6 +490,54 @@ class AclConfigServiceClient {
487
490
  matchEngineFromEngineName(engineName) {
488
491
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
489
492
  }
493
+ /**
494
+ * Return a fully-qualified evaluation resource name string.
495
+ *
496
+ * @param {string} project
497
+ * @param {string} location
498
+ * @param {string} evaluation
499
+ * @returns {string} Resource name string.
500
+ */
501
+ evaluationPath(project, location, evaluation) {
502
+ return this.pathTemplates.evaluationPathTemplate.render({
503
+ project: project,
504
+ location: location,
505
+ evaluation: evaluation,
506
+ });
507
+ }
508
+ /**
509
+ * Parse the project from Evaluation resource.
510
+ *
511
+ * @param {string} evaluationName
512
+ * A fully-qualified path representing Evaluation resource.
513
+ * @returns {string} A string representing the project.
514
+ */
515
+ matchProjectFromEvaluationName(evaluationName) {
516
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
517
+ .project;
518
+ }
519
+ /**
520
+ * Parse the location from Evaluation resource.
521
+ *
522
+ * @param {string} evaluationName
523
+ * A fully-qualified path representing Evaluation resource.
524
+ * @returns {string} A string representing the location.
525
+ */
526
+ matchLocationFromEvaluationName(evaluationName) {
527
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
528
+ .location;
529
+ }
530
+ /**
531
+ * Parse the evaluation from Evaluation resource.
532
+ *
533
+ * @param {string} evaluationName
534
+ * A fully-qualified path representing Evaluation resource.
535
+ * @returns {string} A string representing the evaluation.
536
+ */
537
+ matchEvaluationFromEvaluationName(evaluationName) {
538
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
539
+ .evaluation;
540
+ }
490
541
  /**
491
542
  * Return a fully-qualified project resource name string.
492
543
  *
@@ -2527,6 +2578,112 @@ class AclConfigServiceClient {
2527
2578
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2528
2579
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2529
2580
  }
2581
+ /**
2582
+ * Return a fully-qualified sampleQuery resource name string.
2583
+ *
2584
+ * @param {string} project
2585
+ * @param {string} location
2586
+ * @param {string} sample_query_set
2587
+ * @param {string} sample_query
2588
+ * @returns {string} Resource name string.
2589
+ */
2590
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2591
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2592
+ project: project,
2593
+ location: location,
2594
+ sample_query_set: sampleQuerySet,
2595
+ sample_query: sampleQuery,
2596
+ });
2597
+ }
2598
+ /**
2599
+ * Parse the project from SampleQuery resource.
2600
+ *
2601
+ * @param {string} sampleQueryName
2602
+ * A fully-qualified path representing SampleQuery resource.
2603
+ * @returns {string} A string representing the project.
2604
+ */
2605
+ matchProjectFromSampleQueryName(sampleQueryName) {
2606
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2607
+ .project;
2608
+ }
2609
+ /**
2610
+ * Parse the location from SampleQuery resource.
2611
+ *
2612
+ * @param {string} sampleQueryName
2613
+ * A fully-qualified path representing SampleQuery resource.
2614
+ * @returns {string} A string representing the location.
2615
+ */
2616
+ matchLocationFromSampleQueryName(sampleQueryName) {
2617
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2618
+ .location;
2619
+ }
2620
+ /**
2621
+ * Parse the sample_query_set from SampleQuery resource.
2622
+ *
2623
+ * @param {string} sampleQueryName
2624
+ * A fully-qualified path representing SampleQuery resource.
2625
+ * @returns {string} A string representing the sample_query_set.
2626
+ */
2627
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2628
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2629
+ .sample_query_set;
2630
+ }
2631
+ /**
2632
+ * Parse the sample_query from SampleQuery resource.
2633
+ *
2634
+ * @param {string} sampleQueryName
2635
+ * A fully-qualified path representing SampleQuery resource.
2636
+ * @returns {string} A string representing the sample_query.
2637
+ */
2638
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2639
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2640
+ .sample_query;
2641
+ }
2642
+ /**
2643
+ * Return a fully-qualified sampleQuerySet resource name string.
2644
+ *
2645
+ * @param {string} project
2646
+ * @param {string} location
2647
+ * @param {string} sample_query_set
2648
+ * @returns {string} Resource name string.
2649
+ */
2650
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2651
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2652
+ project: project,
2653
+ location: location,
2654
+ sample_query_set: sampleQuerySet,
2655
+ });
2656
+ }
2657
+ /**
2658
+ * Parse the project from SampleQuerySet resource.
2659
+ *
2660
+ * @param {string} sampleQuerySetName
2661
+ * A fully-qualified path representing SampleQuerySet resource.
2662
+ * @returns {string} A string representing the project.
2663
+ */
2664
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2665
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2666
+ }
2667
+ /**
2668
+ * Parse the location from SampleQuerySet resource.
2669
+ *
2670
+ * @param {string} sampleQuerySetName
2671
+ * A fully-qualified path representing SampleQuerySet resource.
2672
+ * @returns {string} A string representing the location.
2673
+ */
2674
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
2675
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
2676
+ }
2677
+ /**
2678
+ * Parse the sample_query_set from SampleQuerySet resource.
2679
+ *
2680
+ * @param {string} sampleQuerySetName
2681
+ * A fully-qualified path representing SampleQuerySet resource.
2682
+ * @returns {string} A string representing the sample_query_set.
2683
+ */
2684
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
2685
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
2686
+ }
2530
2687
  /**
2531
2688
  * Terminate the gRPC channel and close the client.
2532
2689
  *
@@ -400,6 +400,39 @@ export declare class ChunkServiceClient {
400
400
  * @returns {string} A string representing the engine.
401
401
  */
402
402
  matchEngineFromEngineName(engineName: string): string | number;
403
+ /**
404
+ * Return a fully-qualified evaluation resource name string.
405
+ *
406
+ * @param {string} project
407
+ * @param {string} location
408
+ * @param {string} evaluation
409
+ * @returns {string} Resource name string.
410
+ */
411
+ evaluationPath(project: string, location: string, evaluation: string): string;
412
+ /**
413
+ * Parse the project from Evaluation resource.
414
+ *
415
+ * @param {string} evaluationName
416
+ * A fully-qualified path representing Evaluation resource.
417
+ * @returns {string} A string representing the project.
418
+ */
419
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
420
+ /**
421
+ * Parse the location from Evaluation resource.
422
+ *
423
+ * @param {string} evaluationName
424
+ * A fully-qualified path representing Evaluation resource.
425
+ * @returns {string} A string representing the location.
426
+ */
427
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
428
+ /**
429
+ * Parse the evaluation from Evaluation resource.
430
+ *
431
+ * @param {string} evaluationName
432
+ * A fully-qualified path representing Evaluation resource.
433
+ * @returns {string} A string representing the evaluation.
434
+ */
435
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
403
436
  /**
404
437
  * Return a fully-qualified project resource name string.
405
438
  *
@@ -1906,6 +1939,81 @@ export declare class ChunkServiceClient {
1906
1939
  * @returns {string} A string representing the target_site.
1907
1940
  */
1908
1941
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1942
+ /**
1943
+ * Return a fully-qualified sampleQuery resource name string.
1944
+ *
1945
+ * @param {string} project
1946
+ * @param {string} location
1947
+ * @param {string} sample_query_set
1948
+ * @param {string} sample_query
1949
+ * @returns {string} Resource name string.
1950
+ */
1951
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
1952
+ /**
1953
+ * Parse the project from SampleQuery resource.
1954
+ *
1955
+ * @param {string} sampleQueryName
1956
+ * A fully-qualified path representing SampleQuery resource.
1957
+ * @returns {string} A string representing the project.
1958
+ */
1959
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
1960
+ /**
1961
+ * Parse the location from SampleQuery resource.
1962
+ *
1963
+ * @param {string} sampleQueryName
1964
+ * A fully-qualified path representing SampleQuery resource.
1965
+ * @returns {string} A string representing the location.
1966
+ */
1967
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
1968
+ /**
1969
+ * Parse the sample_query_set from SampleQuery resource.
1970
+ *
1971
+ * @param {string} sampleQueryName
1972
+ * A fully-qualified path representing SampleQuery resource.
1973
+ * @returns {string} A string representing the sample_query_set.
1974
+ */
1975
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
1976
+ /**
1977
+ * Parse the sample_query from SampleQuery resource.
1978
+ *
1979
+ * @param {string} sampleQueryName
1980
+ * A fully-qualified path representing SampleQuery resource.
1981
+ * @returns {string} A string representing the sample_query.
1982
+ */
1983
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
1984
+ /**
1985
+ * Return a fully-qualified sampleQuerySet resource name string.
1986
+ *
1987
+ * @param {string} project
1988
+ * @param {string} location
1989
+ * @param {string} sample_query_set
1990
+ * @returns {string} Resource name string.
1991
+ */
1992
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
1993
+ /**
1994
+ * Parse the project from SampleQuerySet resource.
1995
+ *
1996
+ * @param {string} sampleQuerySetName
1997
+ * A fully-qualified path representing SampleQuerySet resource.
1998
+ * @returns {string} A string representing the project.
1999
+ */
2000
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2001
+ /**
2002
+ * Parse the location from SampleQuerySet resource.
2003
+ *
2004
+ * @param {string} sampleQuerySetName
2005
+ * A fully-qualified path representing SampleQuerySet resource.
2006
+ * @returns {string} A string representing the location.
2007
+ */
2008
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2009
+ /**
2010
+ * Parse the sample_query_set from SampleQuerySet resource.
2011
+ *
2012
+ * @param {string} sampleQuerySetName
2013
+ * A fully-qualified path representing SampleQuerySet resource.
2014
+ * @returns {string} A string representing the sample_query_set.
2015
+ */
2016
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1909
2017
  /**
1910
2018
  * Terminate the gRPC channel and close the client.
1911
2019
  *
@@ -153,6 +153,7 @@ class ChunkServiceClient {
153
153
  this.pathTemplates = {
154
154
  aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
155
155
  enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
156
+ evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
156
157
  projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
157
158
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
158
159
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
@@ -185,6 +186,8 @@ class ChunkServiceClient {
185
186
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
186
187
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
187
188
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
189
+ sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
190
+ sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
188
191
  };
189
192
  // Some of the methods on this service return "paged" results,
190
193
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -608,6 +611,54 @@ class ChunkServiceClient {
608
611
  matchEngineFromEngineName(engineName) {
609
612
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
610
613
  }
614
+ /**
615
+ * Return a fully-qualified evaluation resource name string.
616
+ *
617
+ * @param {string} project
618
+ * @param {string} location
619
+ * @param {string} evaluation
620
+ * @returns {string} Resource name string.
621
+ */
622
+ evaluationPath(project, location, evaluation) {
623
+ return this.pathTemplates.evaluationPathTemplate.render({
624
+ project: project,
625
+ location: location,
626
+ evaluation: evaluation,
627
+ });
628
+ }
629
+ /**
630
+ * Parse the project from Evaluation resource.
631
+ *
632
+ * @param {string} evaluationName
633
+ * A fully-qualified path representing Evaluation resource.
634
+ * @returns {string} A string representing the project.
635
+ */
636
+ matchProjectFromEvaluationName(evaluationName) {
637
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
638
+ .project;
639
+ }
640
+ /**
641
+ * Parse the location from Evaluation resource.
642
+ *
643
+ * @param {string} evaluationName
644
+ * A fully-qualified path representing Evaluation resource.
645
+ * @returns {string} A string representing the location.
646
+ */
647
+ matchLocationFromEvaluationName(evaluationName) {
648
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
649
+ .location;
650
+ }
651
+ /**
652
+ * Parse the evaluation from Evaluation resource.
653
+ *
654
+ * @param {string} evaluationName
655
+ * A fully-qualified path representing Evaluation resource.
656
+ * @returns {string} A string representing the evaluation.
657
+ */
658
+ matchEvaluationFromEvaluationName(evaluationName) {
659
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
660
+ .evaluation;
661
+ }
611
662
  /**
612
663
  * Return a fully-qualified project resource name string.
613
664
  *
@@ -2648,6 +2699,112 @@ class ChunkServiceClient {
2648
2699
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2649
2700
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2650
2701
  }
2702
+ /**
2703
+ * Return a fully-qualified sampleQuery resource name string.
2704
+ *
2705
+ * @param {string} project
2706
+ * @param {string} location
2707
+ * @param {string} sample_query_set
2708
+ * @param {string} sample_query
2709
+ * @returns {string} Resource name string.
2710
+ */
2711
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2712
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2713
+ project: project,
2714
+ location: location,
2715
+ sample_query_set: sampleQuerySet,
2716
+ sample_query: sampleQuery,
2717
+ });
2718
+ }
2719
+ /**
2720
+ * Parse the project from SampleQuery resource.
2721
+ *
2722
+ * @param {string} sampleQueryName
2723
+ * A fully-qualified path representing SampleQuery resource.
2724
+ * @returns {string} A string representing the project.
2725
+ */
2726
+ matchProjectFromSampleQueryName(sampleQueryName) {
2727
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2728
+ .project;
2729
+ }
2730
+ /**
2731
+ * Parse the location from SampleQuery resource.
2732
+ *
2733
+ * @param {string} sampleQueryName
2734
+ * A fully-qualified path representing SampleQuery resource.
2735
+ * @returns {string} A string representing the location.
2736
+ */
2737
+ matchLocationFromSampleQueryName(sampleQueryName) {
2738
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2739
+ .location;
2740
+ }
2741
+ /**
2742
+ * Parse the sample_query_set from SampleQuery resource.
2743
+ *
2744
+ * @param {string} sampleQueryName
2745
+ * A fully-qualified path representing SampleQuery resource.
2746
+ * @returns {string} A string representing the sample_query_set.
2747
+ */
2748
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2749
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2750
+ .sample_query_set;
2751
+ }
2752
+ /**
2753
+ * Parse the sample_query from SampleQuery resource.
2754
+ *
2755
+ * @param {string} sampleQueryName
2756
+ * A fully-qualified path representing SampleQuery resource.
2757
+ * @returns {string} A string representing the sample_query.
2758
+ */
2759
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2760
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2761
+ .sample_query;
2762
+ }
2763
+ /**
2764
+ * Return a fully-qualified sampleQuerySet resource name string.
2765
+ *
2766
+ * @param {string} project
2767
+ * @param {string} location
2768
+ * @param {string} sample_query_set
2769
+ * @returns {string} Resource name string.
2770
+ */
2771
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2772
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2773
+ project: project,
2774
+ location: location,
2775
+ sample_query_set: sampleQuerySet,
2776
+ });
2777
+ }
2778
+ /**
2779
+ * Parse the project from SampleQuerySet resource.
2780
+ *
2781
+ * @param {string} sampleQuerySetName
2782
+ * A fully-qualified path representing SampleQuerySet resource.
2783
+ * @returns {string} A string representing the project.
2784
+ */
2785
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2786
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2787
+ }
2788
+ /**
2789
+ * Parse the location from SampleQuerySet resource.
2790
+ *
2791
+ * @param {string} sampleQuerySetName
2792
+ * A fully-qualified path representing SampleQuerySet resource.
2793
+ * @returns {string} A string representing the location.
2794
+ */
2795
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
2796
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
2797
+ }
2798
+ /**
2799
+ * Parse the sample_query_set from SampleQuerySet resource.
2800
+ *
2801
+ * @param {string} sampleQuerySetName
2802
+ * A fully-qualified path representing SampleQuerySet resource.
2803
+ * @returns {string} A string representing the sample_query_set.
2804
+ */
2805
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
2806
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
2807
+ }
2651
2808
  /**
2652
2809
  * Terminate the gRPC channel and close the client.
2653
2810
  *