@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
@@ -990,6 +990,39 @@ export declare class SiteSearchEngineServiceClient {
990
990
  * @returns {string} A string representing the engine.
991
991
  */
992
992
  matchEngineFromEngineName(engineName: string): string | number;
993
+ /**
994
+ * Return a fully-qualified evaluation resource name string.
995
+ *
996
+ * @param {string} project
997
+ * @param {string} location
998
+ * @param {string} evaluation
999
+ * @returns {string} Resource name string.
1000
+ */
1001
+ evaluationPath(project: string, location: string, evaluation: string): string;
1002
+ /**
1003
+ * Parse the project from Evaluation resource.
1004
+ *
1005
+ * @param {string} evaluationName
1006
+ * A fully-qualified path representing Evaluation resource.
1007
+ * @returns {string} A string representing the project.
1008
+ */
1009
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
1010
+ /**
1011
+ * Parse the location from Evaluation resource.
1012
+ *
1013
+ * @param {string} evaluationName
1014
+ * A fully-qualified path representing Evaluation resource.
1015
+ * @returns {string} A string representing the location.
1016
+ */
1017
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
1018
+ /**
1019
+ * Parse the evaluation from Evaluation resource.
1020
+ *
1021
+ * @param {string} evaluationName
1022
+ * A fully-qualified path representing Evaluation resource.
1023
+ * @returns {string} A string representing the evaluation.
1024
+ */
1025
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
993
1026
  /**
994
1027
  * Return a fully-qualified project resource name string.
995
1028
  *
@@ -2496,6 +2529,81 @@ export declare class SiteSearchEngineServiceClient {
2496
2529
  * @returns {string} A string representing the target_site.
2497
2530
  */
2498
2531
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2532
+ /**
2533
+ * Return a fully-qualified sampleQuery resource name string.
2534
+ *
2535
+ * @param {string} project
2536
+ * @param {string} location
2537
+ * @param {string} sample_query_set
2538
+ * @param {string} sample_query
2539
+ * @returns {string} Resource name string.
2540
+ */
2541
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2542
+ /**
2543
+ * Parse the project from SampleQuery resource.
2544
+ *
2545
+ * @param {string} sampleQueryName
2546
+ * A fully-qualified path representing SampleQuery resource.
2547
+ * @returns {string} A string representing the project.
2548
+ */
2549
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2550
+ /**
2551
+ * Parse the location from SampleQuery resource.
2552
+ *
2553
+ * @param {string} sampleQueryName
2554
+ * A fully-qualified path representing SampleQuery resource.
2555
+ * @returns {string} A string representing the location.
2556
+ */
2557
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2558
+ /**
2559
+ * Parse the sample_query_set from SampleQuery resource.
2560
+ *
2561
+ * @param {string} sampleQueryName
2562
+ * A fully-qualified path representing SampleQuery resource.
2563
+ * @returns {string} A string representing the sample_query_set.
2564
+ */
2565
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2566
+ /**
2567
+ * Parse the sample_query from SampleQuery resource.
2568
+ *
2569
+ * @param {string} sampleQueryName
2570
+ * A fully-qualified path representing SampleQuery resource.
2571
+ * @returns {string} A string representing the sample_query.
2572
+ */
2573
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2574
+ /**
2575
+ * Return a fully-qualified sampleQuerySet resource name string.
2576
+ *
2577
+ * @param {string} project
2578
+ * @param {string} location
2579
+ * @param {string} sample_query_set
2580
+ * @returns {string} Resource name string.
2581
+ */
2582
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2583
+ /**
2584
+ * Parse the project from SampleQuerySet resource.
2585
+ *
2586
+ * @param {string} sampleQuerySetName
2587
+ * A fully-qualified path representing SampleQuerySet resource.
2588
+ * @returns {string} A string representing the project.
2589
+ */
2590
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2591
+ /**
2592
+ * Parse the location from SampleQuerySet resource.
2593
+ *
2594
+ * @param {string} sampleQuerySetName
2595
+ * A fully-qualified path representing SampleQuerySet resource.
2596
+ * @returns {string} A string representing the location.
2597
+ */
2598
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2599
+ /**
2600
+ * Parse the sample_query_set from SampleQuerySet resource.
2601
+ *
2602
+ * @param {string} sampleQuerySetName
2603
+ * A fully-qualified path representing SampleQuerySet resource.
2604
+ * @returns {string} A string representing the sample_query_set.
2605
+ */
2606
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2499
2607
  /**
2500
2608
  * Terminate the gRPC channel and close the client.
2501
2609
  *
@@ -152,6 +152,7 @@ class SiteSearchEngineServiceClient {
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 SiteSearchEngineServiceClient {
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
  // Some of the methods on this service return "paged" results,
189
192
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -1325,6 +1328,54 @@ class SiteSearchEngineServiceClient {
1325
1328
  matchEngineFromEngineName(engineName) {
1326
1329
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
1327
1330
  }
1331
+ /**
1332
+ * Return a fully-qualified evaluation resource name string.
1333
+ *
1334
+ * @param {string} project
1335
+ * @param {string} location
1336
+ * @param {string} evaluation
1337
+ * @returns {string} Resource name string.
1338
+ */
1339
+ evaluationPath(project, location, evaluation) {
1340
+ return this.pathTemplates.evaluationPathTemplate.render({
1341
+ project: project,
1342
+ location: location,
1343
+ evaluation: evaluation,
1344
+ });
1345
+ }
1346
+ /**
1347
+ * Parse the project from Evaluation resource.
1348
+ *
1349
+ * @param {string} evaluationName
1350
+ * A fully-qualified path representing Evaluation resource.
1351
+ * @returns {string} A string representing the project.
1352
+ */
1353
+ matchProjectFromEvaluationName(evaluationName) {
1354
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1355
+ .project;
1356
+ }
1357
+ /**
1358
+ * Parse the location from Evaluation resource.
1359
+ *
1360
+ * @param {string} evaluationName
1361
+ * A fully-qualified path representing Evaluation resource.
1362
+ * @returns {string} A string representing the location.
1363
+ */
1364
+ matchLocationFromEvaluationName(evaluationName) {
1365
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1366
+ .location;
1367
+ }
1368
+ /**
1369
+ * Parse the evaluation from Evaluation resource.
1370
+ *
1371
+ * @param {string} evaluationName
1372
+ * A fully-qualified path representing Evaluation resource.
1373
+ * @returns {string} A string representing the evaluation.
1374
+ */
1375
+ matchEvaluationFromEvaluationName(evaluationName) {
1376
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1377
+ .evaluation;
1378
+ }
1328
1379
  /**
1329
1380
  * Return a fully-qualified project resource name string.
1330
1381
  *
@@ -3365,6 +3416,112 @@ class SiteSearchEngineServiceClient {
3365
3416
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
3366
3417
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
3367
3418
  }
3419
+ /**
3420
+ * Return a fully-qualified sampleQuery resource name string.
3421
+ *
3422
+ * @param {string} project
3423
+ * @param {string} location
3424
+ * @param {string} sample_query_set
3425
+ * @param {string} sample_query
3426
+ * @returns {string} Resource name string.
3427
+ */
3428
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
3429
+ return this.pathTemplates.sampleQueryPathTemplate.render({
3430
+ project: project,
3431
+ location: location,
3432
+ sample_query_set: sampleQuerySet,
3433
+ sample_query: sampleQuery,
3434
+ });
3435
+ }
3436
+ /**
3437
+ * Parse the project from SampleQuery resource.
3438
+ *
3439
+ * @param {string} sampleQueryName
3440
+ * A fully-qualified path representing SampleQuery resource.
3441
+ * @returns {string} A string representing the project.
3442
+ */
3443
+ matchProjectFromSampleQueryName(sampleQueryName) {
3444
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3445
+ .project;
3446
+ }
3447
+ /**
3448
+ * Parse the location from SampleQuery resource.
3449
+ *
3450
+ * @param {string} sampleQueryName
3451
+ * A fully-qualified path representing SampleQuery resource.
3452
+ * @returns {string} A string representing the location.
3453
+ */
3454
+ matchLocationFromSampleQueryName(sampleQueryName) {
3455
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3456
+ .location;
3457
+ }
3458
+ /**
3459
+ * Parse the sample_query_set from SampleQuery resource.
3460
+ *
3461
+ * @param {string} sampleQueryName
3462
+ * A fully-qualified path representing SampleQuery resource.
3463
+ * @returns {string} A string representing the sample_query_set.
3464
+ */
3465
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
3466
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3467
+ .sample_query_set;
3468
+ }
3469
+ /**
3470
+ * Parse the sample_query from SampleQuery resource.
3471
+ *
3472
+ * @param {string} sampleQueryName
3473
+ * A fully-qualified path representing SampleQuery resource.
3474
+ * @returns {string} A string representing the sample_query.
3475
+ */
3476
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
3477
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3478
+ .sample_query;
3479
+ }
3480
+ /**
3481
+ * Return a fully-qualified sampleQuerySet resource name string.
3482
+ *
3483
+ * @param {string} project
3484
+ * @param {string} location
3485
+ * @param {string} sample_query_set
3486
+ * @returns {string} Resource name string.
3487
+ */
3488
+ sampleQuerySetPath(project, location, sampleQuerySet) {
3489
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
3490
+ project: project,
3491
+ location: location,
3492
+ sample_query_set: sampleQuerySet,
3493
+ });
3494
+ }
3495
+ /**
3496
+ * Parse the project from SampleQuerySet resource.
3497
+ *
3498
+ * @param {string} sampleQuerySetName
3499
+ * A fully-qualified path representing SampleQuerySet resource.
3500
+ * @returns {string} A string representing the project.
3501
+ */
3502
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
3503
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
3504
+ }
3505
+ /**
3506
+ * Parse the location from SampleQuerySet resource.
3507
+ *
3508
+ * @param {string} sampleQuerySetName
3509
+ * A fully-qualified path representing SampleQuerySet resource.
3510
+ * @returns {string} A string representing the location.
3511
+ */
3512
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
3513
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
3514
+ }
3515
+ /**
3516
+ * Parse the sample_query_set from SampleQuerySet resource.
3517
+ *
3518
+ * @param {string} sampleQuerySetName
3519
+ * A fully-qualified path representing SampleQuerySet resource.
3520
+ * @returns {string} A string representing the sample_query_set.
3521
+ */
3522
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
3523
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
3524
+ }
3368
3525
  /**
3369
3526
  * Terminate the gRPC channel and close the client.
3370
3527
  *
@@ -557,6 +557,39 @@ export declare class UserEventServiceClient {
557
557
  * @returns {string} A string representing the engine.
558
558
  */
559
559
  matchEngineFromEngineName(engineName: string): string | number;
560
+ /**
561
+ * Return a fully-qualified evaluation resource name string.
562
+ *
563
+ * @param {string} project
564
+ * @param {string} location
565
+ * @param {string} evaluation
566
+ * @returns {string} Resource name string.
567
+ */
568
+ evaluationPath(project: string, location: string, evaluation: string): string;
569
+ /**
570
+ * Parse the project from Evaluation resource.
571
+ *
572
+ * @param {string} evaluationName
573
+ * A fully-qualified path representing Evaluation resource.
574
+ * @returns {string} A string representing the project.
575
+ */
576
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
577
+ /**
578
+ * Parse the location from Evaluation resource.
579
+ *
580
+ * @param {string} evaluationName
581
+ * A fully-qualified path representing Evaluation resource.
582
+ * @returns {string} A string representing the location.
583
+ */
584
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
585
+ /**
586
+ * Parse the evaluation from Evaluation resource.
587
+ *
588
+ * @param {string} evaluationName
589
+ * A fully-qualified path representing Evaluation resource.
590
+ * @returns {string} A string representing the evaluation.
591
+ */
592
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
560
593
  /**
561
594
  * Return a fully-qualified project resource name string.
562
595
  *
@@ -2063,6 +2096,81 @@ export declare class UserEventServiceClient {
2063
2096
  * @returns {string} A string representing the target_site.
2064
2097
  */
2065
2098
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2099
+ /**
2100
+ * Return a fully-qualified sampleQuery resource name string.
2101
+ *
2102
+ * @param {string} project
2103
+ * @param {string} location
2104
+ * @param {string} sample_query_set
2105
+ * @param {string} sample_query
2106
+ * @returns {string} Resource name string.
2107
+ */
2108
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2109
+ /**
2110
+ * Parse the project from SampleQuery resource.
2111
+ *
2112
+ * @param {string} sampleQueryName
2113
+ * A fully-qualified path representing SampleQuery resource.
2114
+ * @returns {string} A string representing the project.
2115
+ */
2116
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2117
+ /**
2118
+ * Parse the location from SampleQuery resource.
2119
+ *
2120
+ * @param {string} sampleQueryName
2121
+ * A fully-qualified path representing SampleQuery resource.
2122
+ * @returns {string} A string representing the location.
2123
+ */
2124
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2125
+ /**
2126
+ * Parse the sample_query_set from SampleQuery resource.
2127
+ *
2128
+ * @param {string} sampleQueryName
2129
+ * A fully-qualified path representing SampleQuery resource.
2130
+ * @returns {string} A string representing the sample_query_set.
2131
+ */
2132
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2133
+ /**
2134
+ * Parse the sample_query from SampleQuery resource.
2135
+ *
2136
+ * @param {string} sampleQueryName
2137
+ * A fully-qualified path representing SampleQuery resource.
2138
+ * @returns {string} A string representing the sample_query.
2139
+ */
2140
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2141
+ /**
2142
+ * Return a fully-qualified sampleQuerySet resource name string.
2143
+ *
2144
+ * @param {string} project
2145
+ * @param {string} location
2146
+ * @param {string} sample_query_set
2147
+ * @returns {string} Resource name string.
2148
+ */
2149
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2150
+ /**
2151
+ * Parse the project from SampleQuerySet resource.
2152
+ *
2153
+ * @param {string} sampleQuerySetName
2154
+ * A fully-qualified path representing SampleQuerySet resource.
2155
+ * @returns {string} A string representing the project.
2156
+ */
2157
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2158
+ /**
2159
+ * Parse the location from SampleQuerySet resource.
2160
+ *
2161
+ * @param {string} sampleQuerySetName
2162
+ * A fully-qualified path representing SampleQuerySet resource.
2163
+ * @returns {string} A string representing the location.
2164
+ */
2165
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2166
+ /**
2167
+ * Parse the sample_query_set from SampleQuerySet resource.
2168
+ *
2169
+ * @param {string} sampleQuerySetName
2170
+ * A fully-qualified path representing SampleQuerySet resource.
2171
+ * @returns {string} A string representing the sample_query_set.
2172
+ */
2173
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2066
2174
  /**
2067
2175
  * Terminate the gRPC channel and close the client.
2068
2176
  *
@@ -151,6 +151,7 @@ class UserEventServiceClient {
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 UserEventServiceClient {
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
@@ -819,6 +822,54 @@ class UserEventServiceClient {
819
822
  matchEngineFromEngineName(engineName) {
820
823
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
821
824
  }
825
+ /**
826
+ * Return a fully-qualified evaluation resource name string.
827
+ *
828
+ * @param {string} project
829
+ * @param {string} location
830
+ * @param {string} evaluation
831
+ * @returns {string} Resource name string.
832
+ */
833
+ evaluationPath(project, location, evaluation) {
834
+ return this.pathTemplates.evaluationPathTemplate.render({
835
+ project: project,
836
+ location: location,
837
+ evaluation: evaluation,
838
+ });
839
+ }
840
+ /**
841
+ * Parse the project from Evaluation resource.
842
+ *
843
+ * @param {string} evaluationName
844
+ * A fully-qualified path representing Evaluation resource.
845
+ * @returns {string} A string representing the project.
846
+ */
847
+ matchProjectFromEvaluationName(evaluationName) {
848
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
849
+ .project;
850
+ }
851
+ /**
852
+ * Parse the location from Evaluation resource.
853
+ *
854
+ * @param {string} evaluationName
855
+ * A fully-qualified path representing Evaluation resource.
856
+ * @returns {string} A string representing the location.
857
+ */
858
+ matchLocationFromEvaluationName(evaluationName) {
859
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
860
+ .location;
861
+ }
862
+ /**
863
+ * Parse the evaluation from Evaluation resource.
864
+ *
865
+ * @param {string} evaluationName
866
+ * A fully-qualified path representing Evaluation resource.
867
+ * @returns {string} A string representing the evaluation.
868
+ */
869
+ matchEvaluationFromEvaluationName(evaluationName) {
870
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
871
+ .evaluation;
872
+ }
822
873
  /**
823
874
  * Return a fully-qualified project resource name string.
824
875
  *
@@ -2859,6 +2910,112 @@ class UserEventServiceClient {
2859
2910
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2860
2911
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2861
2912
  }
2913
+ /**
2914
+ * Return a fully-qualified sampleQuery resource name string.
2915
+ *
2916
+ * @param {string} project
2917
+ * @param {string} location
2918
+ * @param {string} sample_query_set
2919
+ * @param {string} sample_query
2920
+ * @returns {string} Resource name string.
2921
+ */
2922
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2923
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2924
+ project: project,
2925
+ location: location,
2926
+ sample_query_set: sampleQuerySet,
2927
+ sample_query: sampleQuery,
2928
+ });
2929
+ }
2930
+ /**
2931
+ * Parse the project from SampleQuery resource.
2932
+ *
2933
+ * @param {string} sampleQueryName
2934
+ * A fully-qualified path representing SampleQuery resource.
2935
+ * @returns {string} A string representing the project.
2936
+ */
2937
+ matchProjectFromSampleQueryName(sampleQueryName) {
2938
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2939
+ .project;
2940
+ }
2941
+ /**
2942
+ * Parse the location from SampleQuery resource.
2943
+ *
2944
+ * @param {string} sampleQueryName
2945
+ * A fully-qualified path representing SampleQuery resource.
2946
+ * @returns {string} A string representing the location.
2947
+ */
2948
+ matchLocationFromSampleQueryName(sampleQueryName) {
2949
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2950
+ .location;
2951
+ }
2952
+ /**
2953
+ * Parse the sample_query_set from SampleQuery resource.
2954
+ *
2955
+ * @param {string} sampleQueryName
2956
+ * A fully-qualified path representing SampleQuery resource.
2957
+ * @returns {string} A string representing the sample_query_set.
2958
+ */
2959
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2960
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2961
+ .sample_query_set;
2962
+ }
2963
+ /**
2964
+ * Parse the sample_query from SampleQuery resource.
2965
+ *
2966
+ * @param {string} sampleQueryName
2967
+ * A fully-qualified path representing SampleQuery resource.
2968
+ * @returns {string} A string representing the sample_query.
2969
+ */
2970
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2971
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2972
+ .sample_query;
2973
+ }
2974
+ /**
2975
+ * Return a fully-qualified sampleQuerySet resource name string.
2976
+ *
2977
+ * @param {string} project
2978
+ * @param {string} location
2979
+ * @param {string} sample_query_set
2980
+ * @returns {string} Resource name string.
2981
+ */
2982
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2983
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2984
+ project: project,
2985
+ location: location,
2986
+ sample_query_set: sampleQuerySet,
2987
+ });
2988
+ }
2989
+ /**
2990
+ * Parse the project from SampleQuerySet resource.
2991
+ *
2992
+ * @param {string} sampleQuerySetName
2993
+ * A fully-qualified path representing SampleQuerySet resource.
2994
+ * @returns {string} A string representing the project.
2995
+ */
2996
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2997
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2998
+ }
2999
+ /**
3000
+ * Parse the location from SampleQuerySet resource.
3001
+ *
3002
+ * @param {string} sampleQuerySetName
3003
+ * A fully-qualified path representing SampleQuerySet resource.
3004
+ * @returns {string} A string representing the location.
3005
+ */
3006
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
3007
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
3008
+ }
3009
+ /**
3010
+ * Parse the sample_query_set from SampleQuerySet resource.
3011
+ *
3012
+ * @param {string} sampleQuerySetName
3013
+ * A fully-qualified path representing SampleQuerySet resource.
3014
+ * @returns {string} A string representing the sample_query_set.
3015
+ */
3016
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
3017
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
3018
+ }
2862
3019
  /**
2863
3020
  * Terminate the gRPC channel and close the client.
2864
3021
  *