@google-cloud/discoveryengine 1.10.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 (119) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +30 -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/chunk.proto +119 -0
  11. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
  12. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +10 -2
  13. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  14. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
  15. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
  16. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
  17. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +83 -0
  18. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
  19. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
  20. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
  21. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
  22. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +67 -8
  23. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
  24. package/build/protos/protos.d.ts +28997 -20222
  25. package/build/protos/protos.js +74749 -54453
  26. package/build/protos/protos.json +6933 -4764
  27. package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
  28. package/build/src/v1alpha/acl_config_service_client.js +157 -0
  29. package/build/src/v1alpha/chunk_service_client.d.ts +108 -0
  30. package/build/src/v1alpha/chunk_service_client.js +157 -0
  31. package/build/src/v1alpha/completion_service_client.d.ts +108 -0
  32. package/build/src/v1alpha/completion_service_client.js +157 -0
  33. package/build/src/v1alpha/control_service_client.d.ts +108 -0
  34. package/build/src/v1alpha/control_service_client.js +157 -0
  35. package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -0
  36. package/build/src/v1alpha/conversational_search_service_client.js +157 -0
  37. package/build/src/v1alpha/data_store_service_client.d.ts +108 -0
  38. package/build/src/v1alpha/data_store_service_client.js +157 -0
  39. package/build/src/v1alpha/document_service_client.d.ts +108 -0
  40. package/build/src/v1alpha/document_service_client.js +157 -0
  41. package/build/src/v1alpha/engine_service_client.d.ts +108 -0
  42. package/build/src/v1alpha/engine_service_client.js +157 -0
  43. package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
  44. package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
  45. package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
  46. package/build/src/v1alpha/evaluation_service_client.js +3288 -0
  47. package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
  48. package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
  49. package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
  50. package/build/src/v1alpha/index.d.ts +3 -0
  51. package/build/src/v1alpha/index.js +7 -1
  52. package/build/src/v1alpha/project_service_client.d.ts +108 -0
  53. package/build/src/v1alpha/project_service_client.js +157 -0
  54. package/build/src/v1alpha/rank_service_client.d.ts +108 -0
  55. package/build/src/v1alpha/rank_service_client.js +157 -0
  56. package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
  57. package/build/src/v1alpha/recommendation_service_client.js +157 -0
  58. package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
  59. package/build/src/v1alpha/sample_query_service_client.js +3186 -0
  60. package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
  61. package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
  62. package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
  63. package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
  64. package/build/src/v1alpha/schema_service_client.d.ts +108 -0
  65. package/build/src/v1alpha/schema_service_client.js +157 -0
  66. package/build/src/v1alpha/search_service_client.d.ts +108 -0
  67. package/build/src/v1alpha/search_service_client.js +157 -0
  68. package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
  69. package/build/src/v1alpha/search_tuning_service_client.js +157 -0
  70. package/build/src/v1alpha/serving_config_service_client.d.ts +108 -0
  71. package/build/src/v1alpha/serving_config_service_client.js +157 -0
  72. package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -0
  73. package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
  74. package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
  75. package/build/src/v1alpha/user_event_service_client.js +157 -0
  76. package/build/src/v1beta/completion_service_client.d.ts +237 -0
  77. package/build/src/v1beta/completion_service_client.js +339 -0
  78. package/build/src/v1beta/control_service_client.d.ts +237 -0
  79. package/build/src/v1beta/control_service_client.js +333 -0
  80. package/build/src/v1beta/conversational_search_service_client.d.ts +237 -0
  81. package/build/src/v1beta/conversational_search_service_client.js +333 -0
  82. package/build/src/v1beta/data_store_service_client.d.ts +237 -0
  83. package/build/src/v1beta/data_store_service_client.js +339 -0
  84. package/build/src/v1beta/document_service_client.d.ts +237 -0
  85. package/build/src/v1beta/document_service_client.js +339 -0
  86. package/build/src/v1beta/engine_service_client.d.ts +237 -0
  87. package/build/src/v1beta/engine_service_client.js +339 -0
  88. package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
  89. package/build/src/v1beta/evaluation_service_client.js +3252 -0
  90. package/build/src/v1beta/evaluation_service_client_config.json +58 -0
  91. package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
  92. package/build/src/v1beta/grounded_generation_service_client.js +333 -0
  93. package/build/src/v1beta/index.d.ts +3 -0
  94. package/build/src/v1beta/index.js +7 -1
  95. package/build/src/v1beta/project_service_client.d.ts +237 -0
  96. package/build/src/v1beta/project_service_client.js +339 -0
  97. package/build/src/v1beta/rank_service_client.d.ts +237 -0
  98. package/build/src/v1beta/rank_service_client.js +333 -0
  99. package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
  100. package/build/src/v1beta/recommendation_service_client.js +333 -0
  101. package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
  102. package/build/src/v1beta/sample_query_service_client.js +3150 -0
  103. package/build/src/v1beta/sample_query_service_client_config.json +68 -0
  104. package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
  105. package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
  106. package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
  107. package/build/src/v1beta/schema_service_client.d.ts +237 -0
  108. package/build/src/v1beta/schema_service_client.js +339 -0
  109. package/build/src/v1beta/search_service_client.d.ts +267 -12
  110. package/build/src/v1beta/search_service_client.js +353 -8
  111. package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
  112. package/build/src/v1beta/search_tuning_service_client.js +339 -0
  113. package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
  114. package/build/src/v1beta/serving_config_service_client.js +333 -0
  115. package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -0
  116. package/build/src/v1beta/site_search_engine_service_client.js +339 -0
  117. package/build/src/v1beta/user_event_service_client.d.ts +237 -0
  118. package/build/src/v1beta/user_event_service_client.js +339 -0
  119. package/package.json +1 -1
@@ -152,6 +152,7 @@ class ProjectServiceClient {
152
152
  this.pathTemplates = {
153
153
  aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
154
154
  enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
155
+ evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
155
156
  projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
156
157
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
157
158
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
@@ -184,6 +185,8 @@ class ProjectServiceClient {
184
185
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
185
186
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
186
187
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
188
+ sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
189
+ sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
187
190
  };
188
191
  const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
189
192
  // This API contains "long-running operations", which return a
@@ -778,6 +781,54 @@ class ProjectServiceClient {
778
781
  matchEngineFromEngineName(engineName) {
779
782
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
780
783
  }
784
+ /**
785
+ * Return a fully-qualified evaluation resource name string.
786
+ *
787
+ * @param {string} project
788
+ * @param {string} location
789
+ * @param {string} evaluation
790
+ * @returns {string} Resource name string.
791
+ */
792
+ evaluationPath(project, location, evaluation) {
793
+ return this.pathTemplates.evaluationPathTemplate.render({
794
+ project: project,
795
+ location: location,
796
+ evaluation: evaluation,
797
+ });
798
+ }
799
+ /**
800
+ * Parse the project from Evaluation resource.
801
+ *
802
+ * @param {string} evaluationName
803
+ * A fully-qualified path representing Evaluation resource.
804
+ * @returns {string} A string representing the project.
805
+ */
806
+ matchProjectFromEvaluationName(evaluationName) {
807
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
808
+ .project;
809
+ }
810
+ /**
811
+ * Parse the location from Evaluation resource.
812
+ *
813
+ * @param {string} evaluationName
814
+ * A fully-qualified path representing Evaluation resource.
815
+ * @returns {string} A string representing the location.
816
+ */
817
+ matchLocationFromEvaluationName(evaluationName) {
818
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
819
+ .location;
820
+ }
821
+ /**
822
+ * Parse the evaluation from Evaluation resource.
823
+ *
824
+ * @param {string} evaluationName
825
+ * A fully-qualified path representing Evaluation resource.
826
+ * @returns {string} A string representing the evaluation.
827
+ */
828
+ matchEvaluationFromEvaluationName(evaluationName) {
829
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
830
+ .evaluation;
831
+ }
781
832
  /**
782
833
  * Return a fully-qualified project resource name string.
783
834
  *
@@ -2818,6 +2869,112 @@ class ProjectServiceClient {
2818
2869
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2819
2870
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2820
2871
  }
2872
+ /**
2873
+ * Return a fully-qualified sampleQuery resource name string.
2874
+ *
2875
+ * @param {string} project
2876
+ * @param {string} location
2877
+ * @param {string} sample_query_set
2878
+ * @param {string} sample_query
2879
+ * @returns {string} Resource name string.
2880
+ */
2881
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2882
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2883
+ project: project,
2884
+ location: location,
2885
+ sample_query_set: sampleQuerySet,
2886
+ sample_query: sampleQuery,
2887
+ });
2888
+ }
2889
+ /**
2890
+ * Parse the project from SampleQuery resource.
2891
+ *
2892
+ * @param {string} sampleQueryName
2893
+ * A fully-qualified path representing SampleQuery resource.
2894
+ * @returns {string} A string representing the project.
2895
+ */
2896
+ matchProjectFromSampleQueryName(sampleQueryName) {
2897
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2898
+ .project;
2899
+ }
2900
+ /**
2901
+ * Parse the location from SampleQuery resource.
2902
+ *
2903
+ * @param {string} sampleQueryName
2904
+ * A fully-qualified path representing SampleQuery resource.
2905
+ * @returns {string} A string representing the location.
2906
+ */
2907
+ matchLocationFromSampleQueryName(sampleQueryName) {
2908
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2909
+ .location;
2910
+ }
2911
+ /**
2912
+ * Parse the sample_query_set from SampleQuery resource.
2913
+ *
2914
+ * @param {string} sampleQueryName
2915
+ * A fully-qualified path representing SampleQuery resource.
2916
+ * @returns {string} A string representing the sample_query_set.
2917
+ */
2918
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2919
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2920
+ .sample_query_set;
2921
+ }
2922
+ /**
2923
+ * Parse the sample_query from SampleQuery resource.
2924
+ *
2925
+ * @param {string} sampleQueryName
2926
+ * A fully-qualified path representing SampleQuery resource.
2927
+ * @returns {string} A string representing the sample_query.
2928
+ */
2929
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2930
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2931
+ .sample_query;
2932
+ }
2933
+ /**
2934
+ * Return a fully-qualified sampleQuerySet resource name string.
2935
+ *
2936
+ * @param {string} project
2937
+ * @param {string} location
2938
+ * @param {string} sample_query_set
2939
+ * @returns {string} Resource name string.
2940
+ */
2941
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2942
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2943
+ project: project,
2944
+ location: location,
2945
+ sample_query_set: sampleQuerySet,
2946
+ });
2947
+ }
2948
+ /**
2949
+ * Parse the project from SampleQuerySet resource.
2950
+ *
2951
+ * @param {string} sampleQuerySetName
2952
+ * A fully-qualified path representing SampleQuerySet resource.
2953
+ * @returns {string} A string representing the project.
2954
+ */
2955
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2956
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2957
+ }
2958
+ /**
2959
+ * Parse the location from SampleQuerySet resource.
2960
+ *
2961
+ * @param {string} sampleQuerySetName
2962
+ * A fully-qualified path representing SampleQuerySet resource.
2963
+ * @returns {string} A string representing the location.
2964
+ */
2965
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
2966
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
2967
+ }
2968
+ /**
2969
+ * Parse the sample_query_set from SampleQuerySet resource.
2970
+ *
2971
+ * @param {string} sampleQuerySetName
2972
+ * A fully-qualified path representing SampleQuerySet resource.
2973
+ * @returns {string} A string representing the sample_query_set.
2974
+ */
2975
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
2976
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
2977
+ }
2821
2978
  /**
2822
2979
  * Terminate the gRPC channel and close the client.
2823
2980
  *
@@ -290,6 +290,39 @@ export declare class RankServiceClient {
290
290
  * @returns {string} A string representing the engine.
291
291
  */
292
292
  matchEngineFromEngineName(engineName: string): string | number;
293
+ /**
294
+ * Return a fully-qualified evaluation resource name string.
295
+ *
296
+ * @param {string} project
297
+ * @param {string} location
298
+ * @param {string} evaluation
299
+ * @returns {string} Resource name string.
300
+ */
301
+ evaluationPath(project: string, location: string, evaluation: string): string;
302
+ /**
303
+ * Parse the project from Evaluation resource.
304
+ *
305
+ * @param {string} evaluationName
306
+ * A fully-qualified path representing Evaluation resource.
307
+ * @returns {string} A string representing the project.
308
+ */
309
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
310
+ /**
311
+ * Parse the location from Evaluation resource.
312
+ *
313
+ * @param {string} evaluationName
314
+ * A fully-qualified path representing Evaluation resource.
315
+ * @returns {string} A string representing the location.
316
+ */
317
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
318
+ /**
319
+ * Parse the evaluation from Evaluation resource.
320
+ *
321
+ * @param {string} evaluationName
322
+ * A fully-qualified path representing Evaluation resource.
323
+ * @returns {string} A string representing the evaluation.
324
+ */
325
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
293
326
  /**
294
327
  * Return a fully-qualified project resource name string.
295
328
  *
@@ -1829,6 +1862,81 @@ export declare class RankServiceClient {
1829
1862
  * @returns {string} A string representing the ranking_config.
1830
1863
  */
1831
1864
  matchRankingConfigFromRankingConfigName(rankingConfigName: string): string | number;
1865
+ /**
1866
+ * Return a fully-qualified sampleQuery resource name string.
1867
+ *
1868
+ * @param {string} project
1869
+ * @param {string} location
1870
+ * @param {string} sample_query_set
1871
+ * @param {string} sample_query
1872
+ * @returns {string} Resource name string.
1873
+ */
1874
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
1875
+ /**
1876
+ * Parse the project from SampleQuery resource.
1877
+ *
1878
+ * @param {string} sampleQueryName
1879
+ * A fully-qualified path representing SampleQuery resource.
1880
+ * @returns {string} A string representing the project.
1881
+ */
1882
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
1883
+ /**
1884
+ * Parse the location from SampleQuery resource.
1885
+ *
1886
+ * @param {string} sampleQueryName
1887
+ * A fully-qualified path representing SampleQuery resource.
1888
+ * @returns {string} A string representing the location.
1889
+ */
1890
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
1891
+ /**
1892
+ * Parse the sample_query_set from SampleQuery resource.
1893
+ *
1894
+ * @param {string} sampleQueryName
1895
+ * A fully-qualified path representing SampleQuery resource.
1896
+ * @returns {string} A string representing the sample_query_set.
1897
+ */
1898
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
1899
+ /**
1900
+ * Parse the sample_query from SampleQuery resource.
1901
+ *
1902
+ * @param {string} sampleQueryName
1903
+ * A fully-qualified path representing SampleQuery resource.
1904
+ * @returns {string} A string representing the sample_query.
1905
+ */
1906
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
1907
+ /**
1908
+ * Return a fully-qualified sampleQuerySet resource name string.
1909
+ *
1910
+ * @param {string} project
1911
+ * @param {string} location
1912
+ * @param {string} sample_query_set
1913
+ * @returns {string} Resource name string.
1914
+ */
1915
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
1916
+ /**
1917
+ * Parse the project from SampleQuerySet resource.
1918
+ *
1919
+ * @param {string} sampleQuerySetName
1920
+ * A fully-qualified path representing SampleQuerySet resource.
1921
+ * @returns {string} A string representing the project.
1922
+ */
1923
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1924
+ /**
1925
+ * Parse the location from SampleQuerySet resource.
1926
+ *
1927
+ * @param {string} sampleQuerySetName
1928
+ * A fully-qualified path representing SampleQuerySet resource.
1929
+ * @returns {string} A string representing the location.
1930
+ */
1931
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1932
+ /**
1933
+ * Parse the sample_query_set from SampleQuerySet resource.
1934
+ *
1935
+ * @param {string} sampleQuerySetName
1936
+ * A fully-qualified path representing SampleQuerySet resource.
1937
+ * @returns {string} A string representing the sample_query_set.
1938
+ */
1939
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1832
1940
  /**
1833
1941
  * Terminate the gRPC channel and close the client.
1834
1942
  *
@@ -151,6 +151,7 @@ class RankServiceClient {
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}'),
@@ -184,6 +185,8 @@ class RankServiceClient {
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}'),
186
187
  rankingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/rankingConfigs/{ranking_config}'),
188
+ sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
189
+ sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
187
190
  };
188
191
  // Put together the default options sent with requests.
189
192
  this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.RankService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -467,6 +470,54 @@ class RankServiceClient {
467
470
  matchEngineFromEngineName(engineName) {
468
471
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
469
472
  }
473
+ /**
474
+ * Return a fully-qualified evaluation resource name string.
475
+ *
476
+ * @param {string} project
477
+ * @param {string} location
478
+ * @param {string} evaluation
479
+ * @returns {string} Resource name string.
480
+ */
481
+ evaluationPath(project, location, evaluation) {
482
+ return this.pathTemplates.evaluationPathTemplate.render({
483
+ project: project,
484
+ location: location,
485
+ evaluation: evaluation,
486
+ });
487
+ }
488
+ /**
489
+ * Parse the project from Evaluation resource.
490
+ *
491
+ * @param {string} evaluationName
492
+ * A fully-qualified path representing Evaluation resource.
493
+ * @returns {string} A string representing the project.
494
+ */
495
+ matchProjectFromEvaluationName(evaluationName) {
496
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
497
+ .project;
498
+ }
499
+ /**
500
+ * Parse the location from Evaluation resource.
501
+ *
502
+ * @param {string} evaluationName
503
+ * A fully-qualified path representing Evaluation resource.
504
+ * @returns {string} A string representing the location.
505
+ */
506
+ matchLocationFromEvaluationName(evaluationName) {
507
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
508
+ .location;
509
+ }
510
+ /**
511
+ * Parse the evaluation from Evaluation resource.
512
+ *
513
+ * @param {string} evaluationName
514
+ * A fully-qualified path representing Evaluation resource.
515
+ * @returns {string} A string representing the evaluation.
516
+ */
517
+ matchEvaluationFromEvaluationName(evaluationName) {
518
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
519
+ .evaluation;
520
+ }
470
521
  /**
471
522
  * Return a fully-qualified project resource name string.
472
523
  *
@@ -2555,6 +2606,112 @@ class RankServiceClient {
2555
2606
  return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName)
2556
2607
  .ranking_config;
2557
2608
  }
2609
+ /**
2610
+ * Return a fully-qualified sampleQuery resource name string.
2611
+ *
2612
+ * @param {string} project
2613
+ * @param {string} location
2614
+ * @param {string} sample_query_set
2615
+ * @param {string} sample_query
2616
+ * @returns {string} Resource name string.
2617
+ */
2618
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2619
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2620
+ project: project,
2621
+ location: location,
2622
+ sample_query_set: sampleQuerySet,
2623
+ sample_query: sampleQuery,
2624
+ });
2625
+ }
2626
+ /**
2627
+ * Parse the project from SampleQuery resource.
2628
+ *
2629
+ * @param {string} sampleQueryName
2630
+ * A fully-qualified path representing SampleQuery resource.
2631
+ * @returns {string} A string representing the project.
2632
+ */
2633
+ matchProjectFromSampleQueryName(sampleQueryName) {
2634
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2635
+ .project;
2636
+ }
2637
+ /**
2638
+ * Parse the location from SampleQuery resource.
2639
+ *
2640
+ * @param {string} sampleQueryName
2641
+ * A fully-qualified path representing SampleQuery resource.
2642
+ * @returns {string} A string representing the location.
2643
+ */
2644
+ matchLocationFromSampleQueryName(sampleQueryName) {
2645
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2646
+ .location;
2647
+ }
2648
+ /**
2649
+ * Parse the sample_query_set from SampleQuery resource.
2650
+ *
2651
+ * @param {string} sampleQueryName
2652
+ * A fully-qualified path representing SampleQuery resource.
2653
+ * @returns {string} A string representing the sample_query_set.
2654
+ */
2655
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2656
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2657
+ .sample_query_set;
2658
+ }
2659
+ /**
2660
+ * Parse the sample_query from SampleQuery resource.
2661
+ *
2662
+ * @param {string} sampleQueryName
2663
+ * A fully-qualified path representing SampleQuery resource.
2664
+ * @returns {string} A string representing the sample_query.
2665
+ */
2666
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2667
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2668
+ .sample_query;
2669
+ }
2670
+ /**
2671
+ * Return a fully-qualified sampleQuerySet resource name string.
2672
+ *
2673
+ * @param {string} project
2674
+ * @param {string} location
2675
+ * @param {string} sample_query_set
2676
+ * @returns {string} Resource name string.
2677
+ */
2678
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2679
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2680
+ project: project,
2681
+ location: location,
2682
+ sample_query_set: sampleQuerySet,
2683
+ });
2684
+ }
2685
+ /**
2686
+ * Parse the project from SampleQuerySet resource.
2687
+ *
2688
+ * @param {string} sampleQuerySetName
2689
+ * A fully-qualified path representing SampleQuerySet resource.
2690
+ * @returns {string} A string representing the project.
2691
+ */
2692
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2693
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2694
+ }
2695
+ /**
2696
+ * Parse the location from SampleQuerySet resource.
2697
+ *
2698
+ * @param {string} sampleQuerySetName
2699
+ * A fully-qualified path representing SampleQuerySet resource.
2700
+ * @returns {string} A string representing the location.
2701
+ */
2702
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
2703
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
2704
+ }
2705
+ /**
2706
+ * Parse the sample_query_set from SampleQuerySet resource.
2707
+ *
2708
+ * @param {string} sampleQuerySetName
2709
+ * A fully-qualified path representing SampleQuerySet resource.
2710
+ * @returns {string} A string representing the sample_query_set.
2711
+ */
2712
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
2713
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
2714
+ }
2558
2715
  /**
2559
2716
  * Terminate the gRPC channel and close the client.
2560
2717
  *
@@ -368,6 +368,39 @@ export declare class RecommendationServiceClient {
368
368
  * @returns {string} A string representing the engine.
369
369
  */
370
370
  matchEngineFromEngineName(engineName: string): string | number;
371
+ /**
372
+ * Return a fully-qualified evaluation resource name string.
373
+ *
374
+ * @param {string} project
375
+ * @param {string} location
376
+ * @param {string} evaluation
377
+ * @returns {string} Resource name string.
378
+ */
379
+ evaluationPath(project: string, location: string, evaluation: string): string;
380
+ /**
381
+ * Parse the project from Evaluation resource.
382
+ *
383
+ * @param {string} evaluationName
384
+ * A fully-qualified path representing Evaluation resource.
385
+ * @returns {string} A string representing the project.
386
+ */
387
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
388
+ /**
389
+ * Parse the location from Evaluation resource.
390
+ *
391
+ * @param {string} evaluationName
392
+ * A fully-qualified path representing Evaluation resource.
393
+ * @returns {string} A string representing the location.
394
+ */
395
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
396
+ /**
397
+ * Parse the evaluation from Evaluation resource.
398
+ *
399
+ * @param {string} evaluationName
400
+ * A fully-qualified path representing Evaluation resource.
401
+ * @returns {string} A string representing the evaluation.
402
+ */
403
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
371
404
  /**
372
405
  * Return a fully-qualified project resource name string.
373
406
  *
@@ -1874,6 +1907,81 @@ export declare class RecommendationServiceClient {
1874
1907
  * @returns {string} A string representing the target_site.
1875
1908
  */
1876
1909
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1910
+ /**
1911
+ * Return a fully-qualified sampleQuery resource name string.
1912
+ *
1913
+ * @param {string} project
1914
+ * @param {string} location
1915
+ * @param {string} sample_query_set
1916
+ * @param {string} sample_query
1917
+ * @returns {string} Resource name string.
1918
+ */
1919
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
1920
+ /**
1921
+ * Parse the project from SampleQuery resource.
1922
+ *
1923
+ * @param {string} sampleQueryName
1924
+ * A fully-qualified path representing SampleQuery resource.
1925
+ * @returns {string} A string representing the project.
1926
+ */
1927
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
1928
+ /**
1929
+ * Parse the location from SampleQuery resource.
1930
+ *
1931
+ * @param {string} sampleQueryName
1932
+ * A fully-qualified path representing SampleQuery resource.
1933
+ * @returns {string} A string representing the location.
1934
+ */
1935
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
1936
+ /**
1937
+ * Parse the sample_query_set from SampleQuery resource.
1938
+ *
1939
+ * @param {string} sampleQueryName
1940
+ * A fully-qualified path representing SampleQuery resource.
1941
+ * @returns {string} A string representing the sample_query_set.
1942
+ */
1943
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
1944
+ /**
1945
+ * Parse the sample_query from SampleQuery resource.
1946
+ *
1947
+ * @param {string} sampleQueryName
1948
+ * A fully-qualified path representing SampleQuery resource.
1949
+ * @returns {string} A string representing the sample_query.
1950
+ */
1951
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
1952
+ /**
1953
+ * Return a fully-qualified sampleQuerySet resource name string.
1954
+ *
1955
+ * @param {string} project
1956
+ * @param {string} location
1957
+ * @param {string} sample_query_set
1958
+ * @returns {string} Resource name string.
1959
+ */
1960
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
1961
+ /**
1962
+ * Parse the project from SampleQuerySet resource.
1963
+ *
1964
+ * @param {string} sampleQuerySetName
1965
+ * A fully-qualified path representing SampleQuerySet resource.
1966
+ * @returns {string} A string representing the project.
1967
+ */
1968
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1969
+ /**
1970
+ * Parse the location from SampleQuerySet resource.
1971
+ *
1972
+ * @param {string} sampleQuerySetName
1973
+ * A fully-qualified path representing SampleQuerySet resource.
1974
+ * @returns {string} A string representing the location.
1975
+ */
1976
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1977
+ /**
1978
+ * Parse the sample_query_set from SampleQuerySet resource.
1979
+ *
1980
+ * @param {string} sampleQuerySetName
1981
+ * A fully-qualified path representing SampleQuerySet resource.
1982
+ * @returns {string} A string representing the sample_query_set.
1983
+ */
1984
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1877
1985
  /**
1878
1986
  * Terminate the gRPC channel and close the client.
1879
1987
  *