@google-cloud/discoveryengine 1.9.0 → 1.11.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 (160) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +32 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +13 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +119 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +0 -5
  6. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +31 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +38 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +35 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  10. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +37 -2
  11. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +108 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +200 -4
  14. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +3 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto +232 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation_service.proto +252 -0
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +83 -0
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto +86 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto +264 -0
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto +64 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto +258 -0
  22. package/build/protos/google/cloud/discoveryengine/v1beta/chunk.proto +119 -0
  23. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
  24. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +10 -2
  25. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  26. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
  27. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +83 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
  33. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +67 -8
  35. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
  36. package/build/protos/protos.d.ts +31310 -20211
  37. package/build/protos/protos.js +86710 -60571
  38. package/build/protos/protos.json +7720 -5011
  39. package/build/src/v1/completion_service_client.d.ts +220 -0
  40. package/build/src/v1/completion_service_client.js +260 -0
  41. package/build/src/v1/completion_service_client_config.json +10 -0
  42. package/build/src/v1/control_service_client.d.ts +129 -1
  43. package/build/src/v1/control_service_client.js +176 -0
  44. package/build/src/v1/conversational_search_service_client.d.ts +147 -1
  45. package/build/src/v1/conversational_search_service_client.js +176 -0
  46. package/build/src/v1/data_store_service_client.d.ts +129 -1
  47. package/build/src/v1/data_store_service_client.js +176 -0
  48. package/build/src/v1/document_service_client.d.ts +131 -1
  49. package/build/src/v1/document_service_client.js +176 -0
  50. package/build/src/v1/engine_service_client.d.ts +129 -1
  51. package/build/src/v1/engine_service_client.js +176 -0
  52. package/build/src/v1/grounded_generation_service_client.d.ts +129 -0
  53. package/build/src/v1/grounded_generation_service_client.js +176 -0
  54. package/build/src/v1/project_service_client.d.ts +129 -0
  55. package/build/src/v1/project_service_client.js +176 -0
  56. package/build/src/v1/rank_service_client.d.ts +129 -0
  57. package/build/src/v1/rank_service_client.js +176 -0
  58. package/build/src/v1/recommendation_service_client.d.ts +129 -0
  59. package/build/src/v1/recommendation_service_client.js +176 -0
  60. package/build/src/v1/schema_service_client.d.ts +129 -1
  61. package/build/src/v1/schema_service_client.js +176 -0
  62. package/build/src/v1/search_service_client.d.ts +252 -1
  63. package/build/src/v1/search_service_client.js +258 -0
  64. package/build/src/v1/site_search_engine_service_client.d.ts +129 -1
  65. package/build/src/v1/site_search_engine_service_client.js +176 -0
  66. package/build/src/v1/user_event_service_client.d.ts +129 -0
  67. package/build/src/v1/user_event_service_client.js +176 -0
  68. package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
  69. package/build/src/v1alpha/acl_config_service_client.js +157 -0
  70. package/build/src/v1alpha/chunk_service_client.d.ts +108 -1
  71. package/build/src/v1alpha/chunk_service_client.js +157 -0
  72. package/build/src/v1alpha/completion_service_client.d.ts +108 -0
  73. package/build/src/v1alpha/completion_service_client.js +157 -0
  74. package/build/src/v1alpha/control_service_client.d.ts +108 -1
  75. package/build/src/v1alpha/control_service_client.js +157 -0
  76. package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -1
  77. package/build/src/v1alpha/conversational_search_service_client.js +157 -0
  78. package/build/src/v1alpha/data_store_service_client.d.ts +108 -1
  79. package/build/src/v1alpha/data_store_service_client.js +157 -0
  80. package/build/src/v1alpha/document_service_client.d.ts +108 -1
  81. package/build/src/v1alpha/document_service_client.js +157 -0
  82. package/build/src/v1alpha/engine_service_client.d.ts +108 -1
  83. package/build/src/v1alpha/engine_service_client.js +157 -0
  84. package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
  85. package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
  86. package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
  87. package/build/src/v1alpha/evaluation_service_client.js +3288 -0
  88. package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
  89. package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
  90. package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
  91. package/build/src/v1alpha/index.d.ts +3 -0
  92. package/build/src/v1alpha/index.js +7 -1
  93. package/build/src/v1alpha/project_service_client.d.ts +108 -0
  94. package/build/src/v1alpha/project_service_client.js +157 -0
  95. package/build/src/v1alpha/rank_service_client.d.ts +108 -0
  96. package/build/src/v1alpha/rank_service_client.js +157 -0
  97. package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
  98. package/build/src/v1alpha/recommendation_service_client.js +157 -0
  99. package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
  100. package/build/src/v1alpha/sample_query_service_client.js +3186 -0
  101. package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
  102. package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
  103. package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
  104. package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
  105. package/build/src/v1alpha/schema_service_client.d.ts +108 -1
  106. package/build/src/v1alpha/schema_service_client.js +157 -0
  107. package/build/src/v1alpha/search_service_client.d.ts +108 -1
  108. package/build/src/v1alpha/search_service_client.js +157 -0
  109. package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
  110. package/build/src/v1alpha/search_tuning_service_client.js +157 -0
  111. package/build/src/v1alpha/serving_config_service_client.d.ts +108 -1
  112. package/build/src/v1alpha/serving_config_service_client.js +157 -0
  113. package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -1
  114. package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
  115. package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
  116. package/build/src/v1alpha/user_event_service_client.js +157 -0
  117. package/build/src/v1beta/completion_service_client.d.ts +237 -0
  118. package/build/src/v1beta/completion_service_client.js +339 -0
  119. package/build/src/v1beta/control_service_client.d.ts +237 -1
  120. package/build/src/v1beta/control_service_client.js +333 -0
  121. package/build/src/v1beta/conversational_search_service_client.d.ts +237 -1
  122. package/build/src/v1beta/conversational_search_service_client.js +333 -0
  123. package/build/src/v1beta/data_store_service_client.d.ts +237 -1
  124. package/build/src/v1beta/data_store_service_client.js +339 -0
  125. package/build/src/v1beta/document_service_client.d.ts +237 -1
  126. package/build/src/v1beta/document_service_client.js +339 -0
  127. package/build/src/v1beta/engine_service_client.d.ts +237 -1
  128. package/build/src/v1beta/engine_service_client.js +339 -0
  129. package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
  130. package/build/src/v1beta/evaluation_service_client.js +3252 -0
  131. package/build/src/v1beta/evaluation_service_client_config.json +58 -0
  132. package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
  133. package/build/src/v1beta/grounded_generation_service_client.js +333 -0
  134. package/build/src/v1beta/index.d.ts +3 -0
  135. package/build/src/v1beta/index.js +7 -1
  136. package/build/src/v1beta/project_service_client.d.ts +237 -0
  137. package/build/src/v1beta/project_service_client.js +339 -0
  138. package/build/src/v1beta/rank_service_client.d.ts +237 -0
  139. package/build/src/v1beta/rank_service_client.js +333 -0
  140. package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
  141. package/build/src/v1beta/recommendation_service_client.js +333 -0
  142. package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
  143. package/build/src/v1beta/sample_query_service_client.js +3150 -0
  144. package/build/src/v1beta/sample_query_service_client_config.json +68 -0
  145. package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
  146. package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
  147. package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
  148. package/build/src/v1beta/schema_service_client.d.ts +237 -1
  149. package/build/src/v1beta/schema_service_client.js +339 -0
  150. package/build/src/v1beta/search_service_client.d.ts +267 -13
  151. package/build/src/v1beta/search_service_client.js +353 -8
  152. package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
  153. package/build/src/v1beta/search_tuning_service_client.js +339 -0
  154. package/build/src/v1beta/serving_config_service_client.d.ts +237 -1
  155. package/build/src/v1beta/serving_config_service_client.js +333 -0
  156. package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -1
  157. package/build/src/v1beta/site_search_engine_service_client.js +339 -0
  158. package/build/src/v1beta/user_event_service_client.d.ts +237 -0
  159. package/build/src/v1beta/user_event_service_client.js +339 -0
  160. package/package.json +1 -1
@@ -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
  *
@@ -509,6 +509,39 @@ export declare class CompletionServiceClient {
509
509
  * @returns {string} A string representing the engine.
510
510
  */
511
511
  matchEngineFromEngineName(engineName: string): string | number;
512
+ /**
513
+ * Return a fully-qualified evaluation resource name string.
514
+ *
515
+ * @param {string} project
516
+ * @param {string} location
517
+ * @param {string} evaluation
518
+ * @returns {string} Resource name string.
519
+ */
520
+ evaluationPath(project: string, location: string, evaluation: string): string;
521
+ /**
522
+ * Parse the project from Evaluation resource.
523
+ *
524
+ * @param {string} evaluationName
525
+ * A fully-qualified path representing Evaluation resource.
526
+ * @returns {string} A string representing the project.
527
+ */
528
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
529
+ /**
530
+ * Parse the location from Evaluation resource.
531
+ *
532
+ * @param {string} evaluationName
533
+ * A fully-qualified path representing Evaluation resource.
534
+ * @returns {string} A string representing the location.
535
+ */
536
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
537
+ /**
538
+ * Parse the evaluation from Evaluation resource.
539
+ *
540
+ * @param {string} evaluationName
541
+ * A fully-qualified path representing Evaluation resource.
542
+ * @returns {string} A string representing the evaluation.
543
+ */
544
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
512
545
  /**
513
546
  * Return a fully-qualified project resource name string.
514
547
  *
@@ -2015,6 +2048,81 @@ export declare class CompletionServiceClient {
2015
2048
  * @returns {string} A string representing the target_site.
2016
2049
  */
2017
2050
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2051
+ /**
2052
+ * Return a fully-qualified sampleQuery resource name string.
2053
+ *
2054
+ * @param {string} project
2055
+ * @param {string} location
2056
+ * @param {string} sample_query_set
2057
+ * @param {string} sample_query
2058
+ * @returns {string} Resource name string.
2059
+ */
2060
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2061
+ /**
2062
+ * Parse the project from SampleQuery resource.
2063
+ *
2064
+ * @param {string} sampleQueryName
2065
+ * A fully-qualified path representing SampleQuery resource.
2066
+ * @returns {string} A string representing the project.
2067
+ */
2068
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2069
+ /**
2070
+ * Parse the location from SampleQuery resource.
2071
+ *
2072
+ * @param {string} sampleQueryName
2073
+ * A fully-qualified path representing SampleQuery resource.
2074
+ * @returns {string} A string representing the location.
2075
+ */
2076
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2077
+ /**
2078
+ * Parse the sample_query_set from SampleQuery resource.
2079
+ *
2080
+ * @param {string} sampleQueryName
2081
+ * A fully-qualified path representing SampleQuery resource.
2082
+ * @returns {string} A string representing the sample_query_set.
2083
+ */
2084
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2085
+ /**
2086
+ * Parse the sample_query from SampleQuery resource.
2087
+ *
2088
+ * @param {string} sampleQueryName
2089
+ * A fully-qualified path representing SampleQuery resource.
2090
+ * @returns {string} A string representing the sample_query.
2091
+ */
2092
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2093
+ /**
2094
+ * Return a fully-qualified sampleQuerySet resource name string.
2095
+ *
2096
+ * @param {string} project
2097
+ * @param {string} location
2098
+ * @param {string} sample_query_set
2099
+ * @returns {string} Resource name string.
2100
+ */
2101
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2102
+ /**
2103
+ * Parse the project from SampleQuerySet resource.
2104
+ *
2105
+ * @param {string} sampleQuerySetName
2106
+ * A fully-qualified path representing SampleQuerySet resource.
2107
+ * @returns {string} A string representing the project.
2108
+ */
2109
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2110
+ /**
2111
+ * Parse the location from SampleQuerySet resource.
2112
+ *
2113
+ * @param {string} sampleQuerySetName
2114
+ * A fully-qualified path representing SampleQuerySet resource.
2115
+ * @returns {string} A string representing the location.
2116
+ */
2117
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2118
+ /**
2119
+ * Parse the sample_query_set from SampleQuerySet resource.
2120
+ *
2121
+ * @param {string} sampleQuerySetName
2122
+ * A fully-qualified path representing SampleQuerySet resource.
2123
+ * @returns {string} A string representing the sample_query_set.
2124
+ */
2125
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2018
2126
  /**
2019
2127
  * Terminate the gRPC channel and close the client.
2020
2128
  *
@@ -151,6 +151,7 @@ class CompletionServiceClient {
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 CompletionServiceClient {
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
  const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
188
191
  // This API contains "long-running operations", which return a
@@ -797,6 +800,54 @@ class CompletionServiceClient {
797
800
  matchEngineFromEngineName(engineName) {
798
801
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
799
802
  }
803
+ /**
804
+ * Return a fully-qualified evaluation resource name string.
805
+ *
806
+ * @param {string} project
807
+ * @param {string} location
808
+ * @param {string} evaluation
809
+ * @returns {string} Resource name string.
810
+ */
811
+ evaluationPath(project, location, evaluation) {
812
+ return this.pathTemplates.evaluationPathTemplate.render({
813
+ project: project,
814
+ location: location,
815
+ evaluation: evaluation,
816
+ });
817
+ }
818
+ /**
819
+ * Parse the project from Evaluation resource.
820
+ *
821
+ * @param {string} evaluationName
822
+ * A fully-qualified path representing Evaluation resource.
823
+ * @returns {string} A string representing the project.
824
+ */
825
+ matchProjectFromEvaluationName(evaluationName) {
826
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
827
+ .project;
828
+ }
829
+ /**
830
+ * Parse the location from Evaluation resource.
831
+ *
832
+ * @param {string} evaluationName
833
+ * A fully-qualified path representing Evaluation resource.
834
+ * @returns {string} A string representing the location.
835
+ */
836
+ matchLocationFromEvaluationName(evaluationName) {
837
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
838
+ .location;
839
+ }
840
+ /**
841
+ * Parse the evaluation from Evaluation resource.
842
+ *
843
+ * @param {string} evaluationName
844
+ * A fully-qualified path representing Evaluation resource.
845
+ * @returns {string} A string representing the evaluation.
846
+ */
847
+ matchEvaluationFromEvaluationName(evaluationName) {
848
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
849
+ .evaluation;
850
+ }
800
851
  /**
801
852
  * Return a fully-qualified project resource name string.
802
853
  *
@@ -2837,6 +2888,112 @@ class CompletionServiceClient {
2837
2888
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2838
2889
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2839
2890
  }
2891
+ /**
2892
+ * Return a fully-qualified sampleQuery resource name string.
2893
+ *
2894
+ * @param {string} project
2895
+ * @param {string} location
2896
+ * @param {string} sample_query_set
2897
+ * @param {string} sample_query
2898
+ * @returns {string} Resource name string.
2899
+ */
2900
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2901
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2902
+ project: project,
2903
+ location: location,
2904
+ sample_query_set: sampleQuerySet,
2905
+ sample_query: sampleQuery,
2906
+ });
2907
+ }
2908
+ /**
2909
+ * Parse the project from SampleQuery resource.
2910
+ *
2911
+ * @param {string} sampleQueryName
2912
+ * A fully-qualified path representing SampleQuery resource.
2913
+ * @returns {string} A string representing the project.
2914
+ */
2915
+ matchProjectFromSampleQueryName(sampleQueryName) {
2916
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2917
+ .project;
2918
+ }
2919
+ /**
2920
+ * Parse the location from SampleQuery resource.
2921
+ *
2922
+ * @param {string} sampleQueryName
2923
+ * A fully-qualified path representing SampleQuery resource.
2924
+ * @returns {string} A string representing the location.
2925
+ */
2926
+ matchLocationFromSampleQueryName(sampleQueryName) {
2927
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2928
+ .location;
2929
+ }
2930
+ /**
2931
+ * Parse the sample_query_set from SampleQuery resource.
2932
+ *
2933
+ * @param {string} sampleQueryName
2934
+ * A fully-qualified path representing SampleQuery resource.
2935
+ * @returns {string} A string representing the sample_query_set.
2936
+ */
2937
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2938
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2939
+ .sample_query_set;
2940
+ }
2941
+ /**
2942
+ * Parse the sample_query from SampleQuery resource.
2943
+ *
2944
+ * @param {string} sampleQueryName
2945
+ * A fully-qualified path representing SampleQuery resource.
2946
+ * @returns {string} A string representing the sample_query.
2947
+ */
2948
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2949
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2950
+ .sample_query;
2951
+ }
2952
+ /**
2953
+ * Return a fully-qualified sampleQuerySet resource name string.
2954
+ *
2955
+ * @param {string} project
2956
+ * @param {string} location
2957
+ * @param {string} sample_query_set
2958
+ * @returns {string} Resource name string.
2959
+ */
2960
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2961
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2962
+ project: project,
2963
+ location: location,
2964
+ sample_query_set: sampleQuerySet,
2965
+ });
2966
+ }
2967
+ /**
2968
+ * Parse the project from SampleQuerySet resource.
2969
+ *
2970
+ * @param {string} sampleQuerySetName
2971
+ * A fully-qualified path representing SampleQuerySet resource.
2972
+ * @returns {string} A string representing the project.
2973
+ */
2974
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2975
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2976
+ }
2977
+ /**
2978
+ * Parse the location from SampleQuerySet resource.
2979
+ *
2980
+ * @param {string} sampleQuerySetName
2981
+ * A fully-qualified path representing SampleQuerySet resource.
2982
+ * @returns {string} A string representing the location.
2983
+ */
2984
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
2985
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
2986
+ }
2987
+ /**
2988
+ * Parse the sample_query_set from SampleQuerySet resource.
2989
+ *
2990
+ * @param {string} sampleQuerySetName
2991
+ * A fully-qualified path representing SampleQuerySet resource.
2992
+ * @returns {string} A string representing the sample_query_set.
2993
+ */
2994
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
2995
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
2996
+ }
2840
2997
  /**
2841
2998
  * Terminate the gRPC channel and close the client.
2842
2999
  *
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  import type * as gax from 'google-gax';
3
2
  import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
4
3
  import { Transform } from 'stream';
@@ -473,6 +472,39 @@ export declare class ControlServiceClient {
473
472
  * @returns {string} A string representing the engine.
474
473
  */
475
474
  matchEngineFromEngineName(engineName: string): string | number;
475
+ /**
476
+ * Return a fully-qualified evaluation resource name string.
477
+ *
478
+ * @param {string} project
479
+ * @param {string} location
480
+ * @param {string} evaluation
481
+ * @returns {string} Resource name string.
482
+ */
483
+ evaluationPath(project: string, location: string, evaluation: string): string;
484
+ /**
485
+ * Parse the project from Evaluation resource.
486
+ *
487
+ * @param {string} evaluationName
488
+ * A fully-qualified path representing Evaluation resource.
489
+ * @returns {string} A string representing the project.
490
+ */
491
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
492
+ /**
493
+ * Parse the location from Evaluation resource.
494
+ *
495
+ * @param {string} evaluationName
496
+ * A fully-qualified path representing Evaluation resource.
497
+ * @returns {string} A string representing the location.
498
+ */
499
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
500
+ /**
501
+ * Parse the evaluation from Evaluation resource.
502
+ *
503
+ * @param {string} evaluationName
504
+ * A fully-qualified path representing Evaluation resource.
505
+ * @returns {string} A string representing the evaluation.
506
+ */
507
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
476
508
  /**
477
509
  * Return a fully-qualified location resource name string.
478
510
  *
@@ -2003,6 +2035,81 @@ export declare class ControlServiceClient {
2003
2035
  * @returns {string} A string representing the target_site.
2004
2036
  */
2005
2037
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2038
+ /**
2039
+ * Return a fully-qualified sampleQuery resource name string.
2040
+ *
2041
+ * @param {string} project
2042
+ * @param {string} location
2043
+ * @param {string} sample_query_set
2044
+ * @param {string} sample_query
2045
+ * @returns {string} Resource name string.
2046
+ */
2047
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2048
+ /**
2049
+ * Parse the project from SampleQuery resource.
2050
+ *
2051
+ * @param {string} sampleQueryName
2052
+ * A fully-qualified path representing SampleQuery resource.
2053
+ * @returns {string} A string representing the project.
2054
+ */
2055
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2056
+ /**
2057
+ * Parse the location from SampleQuery resource.
2058
+ *
2059
+ * @param {string} sampleQueryName
2060
+ * A fully-qualified path representing SampleQuery resource.
2061
+ * @returns {string} A string representing the location.
2062
+ */
2063
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2064
+ /**
2065
+ * Parse the sample_query_set from SampleQuery resource.
2066
+ *
2067
+ * @param {string} sampleQueryName
2068
+ * A fully-qualified path representing SampleQuery resource.
2069
+ * @returns {string} A string representing the sample_query_set.
2070
+ */
2071
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2072
+ /**
2073
+ * Parse the sample_query from SampleQuery resource.
2074
+ *
2075
+ * @param {string} sampleQueryName
2076
+ * A fully-qualified path representing SampleQuery resource.
2077
+ * @returns {string} A string representing the sample_query.
2078
+ */
2079
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2080
+ /**
2081
+ * Return a fully-qualified sampleQuerySet resource name string.
2082
+ *
2083
+ * @param {string} project
2084
+ * @param {string} location
2085
+ * @param {string} sample_query_set
2086
+ * @returns {string} Resource name string.
2087
+ */
2088
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2089
+ /**
2090
+ * Parse the project from SampleQuerySet resource.
2091
+ *
2092
+ * @param {string} sampleQuerySetName
2093
+ * A fully-qualified path representing SampleQuerySet resource.
2094
+ * @returns {string} A string representing the project.
2095
+ */
2096
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2097
+ /**
2098
+ * Parse the location from SampleQuerySet resource.
2099
+ *
2100
+ * @param {string} sampleQuerySetName
2101
+ * A fully-qualified path representing SampleQuerySet resource.
2102
+ * @returns {string} A string representing the location.
2103
+ */
2104
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2105
+ /**
2106
+ * Parse the sample_query_set from SampleQuerySet resource.
2107
+ *
2108
+ * @param {string} sampleQuerySetName
2109
+ * A fully-qualified path representing SampleQuerySet resource.
2110
+ * @returns {string} A string representing the sample_query_set.
2111
+ */
2112
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2006
2113
  /**
2007
2114
  * Terminate the gRPC channel and close the client.
2008
2115
  *