@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
@@ -883,6 +883,39 @@ export declare class DocumentServiceClient {
883
883
  * @returns {string} A string representing the engine.
884
884
  */
885
885
  matchEngineFromEngineName(engineName: string): string | number;
886
+ /**
887
+ * Return a fully-qualified evaluation resource name string.
888
+ *
889
+ * @param {string} project
890
+ * @param {string} location
891
+ * @param {string} evaluation
892
+ * @returns {string} Resource name string.
893
+ */
894
+ evaluationPath(project: string, location: string, evaluation: string): string;
895
+ /**
896
+ * Parse the project from Evaluation resource.
897
+ *
898
+ * @param {string} evaluationName
899
+ * A fully-qualified path representing Evaluation resource.
900
+ * @returns {string} A string representing the project.
901
+ */
902
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
903
+ /**
904
+ * Parse the location from Evaluation resource.
905
+ *
906
+ * @param {string} evaluationName
907
+ * A fully-qualified path representing Evaluation resource.
908
+ * @returns {string} A string representing the location.
909
+ */
910
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
911
+ /**
912
+ * Parse the evaluation from Evaluation resource.
913
+ *
914
+ * @param {string} evaluationName
915
+ * A fully-qualified path representing Evaluation resource.
916
+ * @returns {string} A string representing the evaluation.
917
+ */
918
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
886
919
  /**
887
920
  * Return a fully-qualified project resource name string.
888
921
  *
@@ -2482,6 +2515,81 @@ export declare class DocumentServiceClient {
2482
2515
  * @returns {string} A string representing the target_site.
2483
2516
  */
2484
2517
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2518
+ /**
2519
+ * Return a fully-qualified sampleQuery resource name string.
2520
+ *
2521
+ * @param {string} project
2522
+ * @param {string} location
2523
+ * @param {string} sample_query_set
2524
+ * @param {string} sample_query
2525
+ * @returns {string} Resource name string.
2526
+ */
2527
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2528
+ /**
2529
+ * Parse the project from SampleQuery resource.
2530
+ *
2531
+ * @param {string} sampleQueryName
2532
+ * A fully-qualified path representing SampleQuery resource.
2533
+ * @returns {string} A string representing the project.
2534
+ */
2535
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2536
+ /**
2537
+ * Parse the location from SampleQuery resource.
2538
+ *
2539
+ * @param {string} sampleQueryName
2540
+ * A fully-qualified path representing SampleQuery resource.
2541
+ * @returns {string} A string representing the location.
2542
+ */
2543
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2544
+ /**
2545
+ * Parse the sample_query_set from SampleQuery resource.
2546
+ *
2547
+ * @param {string} sampleQueryName
2548
+ * A fully-qualified path representing SampleQuery resource.
2549
+ * @returns {string} A string representing the sample_query_set.
2550
+ */
2551
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2552
+ /**
2553
+ * Parse the sample_query from SampleQuery resource.
2554
+ *
2555
+ * @param {string} sampleQueryName
2556
+ * A fully-qualified path representing SampleQuery resource.
2557
+ * @returns {string} A string representing the sample_query.
2558
+ */
2559
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2560
+ /**
2561
+ * Return a fully-qualified sampleQuerySet resource name string.
2562
+ *
2563
+ * @param {string} project
2564
+ * @param {string} location
2565
+ * @param {string} sample_query_set
2566
+ * @returns {string} Resource name string.
2567
+ */
2568
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2569
+ /**
2570
+ * Parse the project from SampleQuerySet resource.
2571
+ *
2572
+ * @param {string} sampleQuerySetName
2573
+ * A fully-qualified path representing SampleQuerySet resource.
2574
+ * @returns {string} A string representing the project.
2575
+ */
2576
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2577
+ /**
2578
+ * Parse the location from SampleQuerySet resource.
2579
+ *
2580
+ * @param {string} sampleQuerySetName
2581
+ * A fully-qualified path representing SampleQuerySet resource.
2582
+ * @returns {string} A string representing the location.
2583
+ */
2584
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2585
+ /**
2586
+ * Parse the sample_query_set from SampleQuerySet resource.
2587
+ *
2588
+ * @param {string} sampleQuerySetName
2589
+ * A fully-qualified path representing SampleQuerySet resource.
2590
+ * @returns {string} A string representing the sample_query_set.
2591
+ */
2592
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2485
2593
  /**
2486
2594
  * Terminate the gRPC channel and close the client.
2487
2595
  *
@@ -153,6 +153,7 @@ class DocumentServiceClient {
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
  projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
@@ -187,6 +188,8 @@ class DocumentServiceClient {
187
188
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
188
189
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
189
190
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
191
+ sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
192
+ sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
190
193
  };
191
194
  // Some of the methods on this service return "paged" results,
192
195
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -1038,6 +1041,54 @@ class DocumentServiceClient {
1038
1041
  matchEngineFromEngineName(engineName) {
1039
1042
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
1040
1043
  }
1044
+ /**
1045
+ * Return a fully-qualified evaluation resource name string.
1046
+ *
1047
+ * @param {string} project
1048
+ * @param {string} location
1049
+ * @param {string} evaluation
1050
+ * @returns {string} Resource name string.
1051
+ */
1052
+ evaluationPath(project, location, evaluation) {
1053
+ return this.pathTemplates.evaluationPathTemplate.render({
1054
+ project: project,
1055
+ location: location,
1056
+ evaluation: evaluation,
1057
+ });
1058
+ }
1059
+ /**
1060
+ * Parse the project from Evaluation resource.
1061
+ *
1062
+ * @param {string} evaluationName
1063
+ * A fully-qualified path representing Evaluation resource.
1064
+ * @returns {string} A string representing the project.
1065
+ */
1066
+ matchProjectFromEvaluationName(evaluationName) {
1067
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1068
+ .project;
1069
+ }
1070
+ /**
1071
+ * Parse the location from Evaluation resource.
1072
+ *
1073
+ * @param {string} evaluationName
1074
+ * A fully-qualified path representing Evaluation resource.
1075
+ * @returns {string} A string representing the location.
1076
+ */
1077
+ matchLocationFromEvaluationName(evaluationName) {
1078
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1079
+ .location;
1080
+ }
1081
+ /**
1082
+ * Parse the evaluation from Evaluation resource.
1083
+ *
1084
+ * @param {string} evaluationName
1085
+ * A fully-qualified path representing Evaluation resource.
1086
+ * @returns {string} A string representing the evaluation.
1087
+ */
1088
+ matchEvaluationFromEvaluationName(evaluationName) {
1089
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1090
+ .evaluation;
1091
+ }
1041
1092
  /**
1042
1093
  * Return a fully-qualified project resource name string.
1043
1094
  *
@@ -3204,6 +3255,112 @@ class DocumentServiceClient {
3204
3255
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
3205
3256
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
3206
3257
  }
3258
+ /**
3259
+ * Return a fully-qualified sampleQuery resource name string.
3260
+ *
3261
+ * @param {string} project
3262
+ * @param {string} location
3263
+ * @param {string} sample_query_set
3264
+ * @param {string} sample_query
3265
+ * @returns {string} Resource name string.
3266
+ */
3267
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
3268
+ return this.pathTemplates.sampleQueryPathTemplate.render({
3269
+ project: project,
3270
+ location: location,
3271
+ sample_query_set: sampleQuerySet,
3272
+ sample_query: sampleQuery,
3273
+ });
3274
+ }
3275
+ /**
3276
+ * Parse the project from SampleQuery resource.
3277
+ *
3278
+ * @param {string} sampleQueryName
3279
+ * A fully-qualified path representing SampleQuery resource.
3280
+ * @returns {string} A string representing the project.
3281
+ */
3282
+ matchProjectFromSampleQueryName(sampleQueryName) {
3283
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3284
+ .project;
3285
+ }
3286
+ /**
3287
+ * Parse the location from SampleQuery resource.
3288
+ *
3289
+ * @param {string} sampleQueryName
3290
+ * A fully-qualified path representing SampleQuery resource.
3291
+ * @returns {string} A string representing the location.
3292
+ */
3293
+ matchLocationFromSampleQueryName(sampleQueryName) {
3294
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3295
+ .location;
3296
+ }
3297
+ /**
3298
+ * Parse the sample_query_set from SampleQuery resource.
3299
+ *
3300
+ * @param {string} sampleQueryName
3301
+ * A fully-qualified path representing SampleQuery resource.
3302
+ * @returns {string} A string representing the sample_query_set.
3303
+ */
3304
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
3305
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3306
+ .sample_query_set;
3307
+ }
3308
+ /**
3309
+ * Parse the sample_query from SampleQuery resource.
3310
+ *
3311
+ * @param {string} sampleQueryName
3312
+ * A fully-qualified path representing SampleQuery resource.
3313
+ * @returns {string} A string representing the sample_query.
3314
+ */
3315
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
3316
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3317
+ .sample_query;
3318
+ }
3319
+ /**
3320
+ * Return a fully-qualified sampleQuerySet resource name string.
3321
+ *
3322
+ * @param {string} project
3323
+ * @param {string} location
3324
+ * @param {string} sample_query_set
3325
+ * @returns {string} Resource name string.
3326
+ */
3327
+ sampleQuerySetPath(project, location, sampleQuerySet) {
3328
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
3329
+ project: project,
3330
+ location: location,
3331
+ sample_query_set: sampleQuerySet,
3332
+ });
3333
+ }
3334
+ /**
3335
+ * Parse the project from SampleQuerySet resource.
3336
+ *
3337
+ * @param {string} sampleQuerySetName
3338
+ * A fully-qualified path representing SampleQuerySet resource.
3339
+ * @returns {string} A string representing the project.
3340
+ */
3341
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
3342
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
3343
+ }
3344
+ /**
3345
+ * Parse the location from SampleQuerySet resource.
3346
+ *
3347
+ * @param {string} sampleQuerySetName
3348
+ * A fully-qualified path representing SampleQuerySet resource.
3349
+ * @returns {string} A string representing the location.
3350
+ */
3351
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
3352
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
3353
+ }
3354
+ /**
3355
+ * Parse the sample_query_set from SampleQuerySet resource.
3356
+ *
3357
+ * @param {string} sampleQuerySetName
3358
+ * A fully-qualified path representing SampleQuerySet resource.
3359
+ * @returns {string} A string representing the sample_query_set.
3360
+ */
3361
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
3362
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
3363
+ }
3207
3364
  /**
3208
3365
  * Terminate the gRPC channel and close the client.
3209
3366
  *
@@ -730,6 +730,39 @@ export declare class EngineServiceClient {
730
730
  * @returns {string} A string representing the engine.
731
731
  */
732
732
  matchEngineFromEngineName(engineName: string): string | number;
733
+ /**
734
+ * Return a fully-qualified evaluation resource name string.
735
+ *
736
+ * @param {string} project
737
+ * @param {string} location
738
+ * @param {string} evaluation
739
+ * @returns {string} Resource name string.
740
+ */
741
+ evaluationPath(project: string, location: string, evaluation: string): string;
742
+ /**
743
+ * Parse the project from Evaluation resource.
744
+ *
745
+ * @param {string} evaluationName
746
+ * A fully-qualified path representing Evaluation resource.
747
+ * @returns {string} A string representing the project.
748
+ */
749
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
750
+ /**
751
+ * Parse the location from Evaluation resource.
752
+ *
753
+ * @param {string} evaluationName
754
+ * A fully-qualified path representing Evaluation resource.
755
+ * @returns {string} A string representing the location.
756
+ */
757
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
758
+ /**
759
+ * Parse the evaluation from Evaluation resource.
760
+ *
761
+ * @param {string} evaluationName
762
+ * A fully-qualified path representing Evaluation resource.
763
+ * @returns {string} A string representing the evaluation.
764
+ */
765
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
733
766
  /**
734
767
  * Return a fully-qualified project resource name string.
735
768
  *
@@ -2236,6 +2269,81 @@ export declare class EngineServiceClient {
2236
2269
  * @returns {string} A string representing the target_site.
2237
2270
  */
2238
2271
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2272
+ /**
2273
+ * Return a fully-qualified sampleQuery resource name string.
2274
+ *
2275
+ * @param {string} project
2276
+ * @param {string} location
2277
+ * @param {string} sample_query_set
2278
+ * @param {string} sample_query
2279
+ * @returns {string} Resource name string.
2280
+ */
2281
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2282
+ /**
2283
+ * Parse the project from SampleQuery resource.
2284
+ *
2285
+ * @param {string} sampleQueryName
2286
+ * A fully-qualified path representing SampleQuery resource.
2287
+ * @returns {string} A string representing the project.
2288
+ */
2289
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2290
+ /**
2291
+ * Parse the location from SampleQuery resource.
2292
+ *
2293
+ * @param {string} sampleQueryName
2294
+ * A fully-qualified path representing SampleQuery resource.
2295
+ * @returns {string} A string representing the location.
2296
+ */
2297
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2298
+ /**
2299
+ * Parse the sample_query_set from SampleQuery resource.
2300
+ *
2301
+ * @param {string} sampleQueryName
2302
+ * A fully-qualified path representing SampleQuery resource.
2303
+ * @returns {string} A string representing the sample_query_set.
2304
+ */
2305
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2306
+ /**
2307
+ * Parse the sample_query from SampleQuery resource.
2308
+ *
2309
+ * @param {string} sampleQueryName
2310
+ * A fully-qualified path representing SampleQuery resource.
2311
+ * @returns {string} A string representing the sample_query.
2312
+ */
2313
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2314
+ /**
2315
+ * Return a fully-qualified sampleQuerySet resource name string.
2316
+ *
2317
+ * @param {string} project
2318
+ * @param {string} location
2319
+ * @param {string} sample_query_set
2320
+ * @returns {string} Resource name string.
2321
+ */
2322
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2323
+ /**
2324
+ * Parse the project from SampleQuerySet resource.
2325
+ *
2326
+ * @param {string} sampleQuerySetName
2327
+ * A fully-qualified path representing SampleQuerySet resource.
2328
+ * @returns {string} A string representing the project.
2329
+ */
2330
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2331
+ /**
2332
+ * Parse the location from SampleQuerySet resource.
2333
+ *
2334
+ * @param {string} sampleQuerySetName
2335
+ * A fully-qualified path representing SampleQuerySet resource.
2336
+ * @returns {string} A string representing the location.
2337
+ */
2338
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2339
+ /**
2340
+ * Parse the sample_query_set from SampleQuerySet resource.
2341
+ *
2342
+ * @param {string} sampleQuerySetName
2343
+ * A fully-qualified path representing SampleQuerySet resource.
2344
+ * @returns {string} A string representing the sample_query_set.
2345
+ */
2346
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2239
2347
  /**
2240
2348
  * Terminate the gRPC channel and close the client.
2241
2349
  *
@@ -153,6 +153,7 @@ class EngineServiceClient {
153
153
  aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
154
154
  collectionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}'),
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 EngineServiceClient {
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
@@ -1068,6 +1071,54 @@ class EngineServiceClient {
1068
1071
  matchEngineFromEngineName(engineName) {
1069
1072
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
1070
1073
  }
1074
+ /**
1075
+ * Return a fully-qualified evaluation resource name string.
1076
+ *
1077
+ * @param {string} project
1078
+ * @param {string} location
1079
+ * @param {string} evaluation
1080
+ * @returns {string} Resource name string.
1081
+ */
1082
+ evaluationPath(project, location, evaluation) {
1083
+ return this.pathTemplates.evaluationPathTemplate.render({
1084
+ project: project,
1085
+ location: location,
1086
+ evaluation: evaluation,
1087
+ });
1088
+ }
1089
+ /**
1090
+ * Parse the project from Evaluation resource.
1091
+ *
1092
+ * @param {string} evaluationName
1093
+ * A fully-qualified path representing Evaluation resource.
1094
+ * @returns {string} A string representing the project.
1095
+ */
1096
+ matchProjectFromEvaluationName(evaluationName) {
1097
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1098
+ .project;
1099
+ }
1100
+ /**
1101
+ * Parse the location from Evaluation resource.
1102
+ *
1103
+ * @param {string} evaluationName
1104
+ * A fully-qualified path representing Evaluation resource.
1105
+ * @returns {string} A string representing the location.
1106
+ */
1107
+ matchLocationFromEvaluationName(evaluationName) {
1108
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1109
+ .location;
1110
+ }
1111
+ /**
1112
+ * Parse the evaluation from Evaluation resource.
1113
+ *
1114
+ * @param {string} evaluationName
1115
+ * A fully-qualified path representing Evaluation resource.
1116
+ * @returns {string} A string representing the evaluation.
1117
+ */
1118
+ matchEvaluationFromEvaluationName(evaluationName) {
1119
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1120
+ .evaluation;
1121
+ }
1071
1122
  /**
1072
1123
  * Return a fully-qualified project resource name string.
1073
1124
  *
@@ -3108,6 +3159,112 @@ class EngineServiceClient {
3108
3159
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
3109
3160
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
3110
3161
  }
3162
+ /**
3163
+ * Return a fully-qualified sampleQuery resource name string.
3164
+ *
3165
+ * @param {string} project
3166
+ * @param {string} location
3167
+ * @param {string} sample_query_set
3168
+ * @param {string} sample_query
3169
+ * @returns {string} Resource name string.
3170
+ */
3171
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
3172
+ return this.pathTemplates.sampleQueryPathTemplate.render({
3173
+ project: project,
3174
+ location: location,
3175
+ sample_query_set: sampleQuerySet,
3176
+ sample_query: sampleQuery,
3177
+ });
3178
+ }
3179
+ /**
3180
+ * Parse the project from SampleQuery resource.
3181
+ *
3182
+ * @param {string} sampleQueryName
3183
+ * A fully-qualified path representing SampleQuery resource.
3184
+ * @returns {string} A string representing the project.
3185
+ */
3186
+ matchProjectFromSampleQueryName(sampleQueryName) {
3187
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3188
+ .project;
3189
+ }
3190
+ /**
3191
+ * Parse the location from SampleQuery resource.
3192
+ *
3193
+ * @param {string} sampleQueryName
3194
+ * A fully-qualified path representing SampleQuery resource.
3195
+ * @returns {string} A string representing the location.
3196
+ */
3197
+ matchLocationFromSampleQueryName(sampleQueryName) {
3198
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3199
+ .location;
3200
+ }
3201
+ /**
3202
+ * Parse the sample_query_set from SampleQuery resource.
3203
+ *
3204
+ * @param {string} sampleQueryName
3205
+ * A fully-qualified path representing SampleQuery resource.
3206
+ * @returns {string} A string representing the sample_query_set.
3207
+ */
3208
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
3209
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3210
+ .sample_query_set;
3211
+ }
3212
+ /**
3213
+ * Parse the sample_query from SampleQuery resource.
3214
+ *
3215
+ * @param {string} sampleQueryName
3216
+ * A fully-qualified path representing SampleQuery resource.
3217
+ * @returns {string} A string representing the sample_query.
3218
+ */
3219
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
3220
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3221
+ .sample_query;
3222
+ }
3223
+ /**
3224
+ * Return a fully-qualified sampleQuerySet resource name string.
3225
+ *
3226
+ * @param {string} project
3227
+ * @param {string} location
3228
+ * @param {string} sample_query_set
3229
+ * @returns {string} Resource name string.
3230
+ */
3231
+ sampleQuerySetPath(project, location, sampleQuerySet) {
3232
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
3233
+ project: project,
3234
+ location: location,
3235
+ sample_query_set: sampleQuerySet,
3236
+ });
3237
+ }
3238
+ /**
3239
+ * Parse the project from SampleQuerySet resource.
3240
+ *
3241
+ * @param {string} sampleQuerySetName
3242
+ * A fully-qualified path representing SampleQuerySet resource.
3243
+ * @returns {string} A string representing the project.
3244
+ */
3245
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
3246
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
3247
+ }
3248
+ /**
3249
+ * Parse the location from SampleQuerySet resource.
3250
+ *
3251
+ * @param {string} sampleQuerySetName
3252
+ * A fully-qualified path representing SampleQuerySet resource.
3253
+ * @returns {string} A string representing the location.
3254
+ */
3255
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
3256
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
3257
+ }
3258
+ /**
3259
+ * Parse the sample_query_set from SampleQuerySet resource.
3260
+ *
3261
+ * @param {string} sampleQuerySetName
3262
+ * A fully-qualified path representing SampleQuerySet resource.
3263
+ * @returns {string} A string representing the sample_query_set.
3264
+ */
3265
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
3266
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
3267
+ }
3111
3268
  /**
3112
3269
  * Terminate the gRPC channel and close the client.
3113
3270
  *