@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
@@ -266,6 +266,39 @@ export declare class RankServiceClient {
266
266
  * @returns {string} A string representing the engine.
267
267
  */
268
268
  matchEngineFromEngineName(engineName: string): string | number;
269
+ /**
270
+ * Return a fully-qualified evaluation resource name string.
271
+ *
272
+ * @param {string} project
273
+ * @param {string} location
274
+ * @param {string} evaluation
275
+ * @returns {string} Resource name string.
276
+ */
277
+ evaluationPath(project: string, location: string, evaluation: string): string;
278
+ /**
279
+ * Parse the project from Evaluation resource.
280
+ *
281
+ * @param {string} evaluationName
282
+ * A fully-qualified path representing Evaluation resource.
283
+ * @returns {string} A string representing the project.
284
+ */
285
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
286
+ /**
287
+ * Parse the location from Evaluation resource.
288
+ *
289
+ * @param {string} evaluationName
290
+ * A fully-qualified path representing Evaluation resource.
291
+ * @returns {string} A string representing the location.
292
+ */
293
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
294
+ /**
295
+ * Parse the evaluation from Evaluation resource.
296
+ *
297
+ * @param {string} evaluationName
298
+ * A fully-qualified path representing Evaluation resource.
299
+ * @returns {string} A string representing the evaluation.
300
+ */
301
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
269
302
  /**
270
303
  * Return a fully-qualified project resource name string.
271
304
  *
@@ -383,6 +416,75 @@ export declare class RankServiceClient {
383
416
  * @returns {string} A string representing the document.
384
417
  */
385
418
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
419
+ /**
420
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
421
+ *
422
+ * @param {string} project
423
+ * @param {string} location
424
+ * @param {string} collection
425
+ * @param {string} data_store
426
+ * @param {string} branch
427
+ * @param {string} document
428
+ * @param {string} chunk
429
+ * @returns {string} Resource name string.
430
+ */
431
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;
432
+ /**
433
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
434
+ *
435
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
436
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
437
+ * @returns {string} A string representing the project.
438
+ */
439
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
440
+ /**
441
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
442
+ *
443
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
444
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
445
+ * @returns {string} A string representing the location.
446
+ */
447
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
448
+ /**
449
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
450
+ *
451
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
452
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
453
+ * @returns {string} A string representing the collection.
454
+ */
455
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
456
+ /**
457
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
458
+ *
459
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
460
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
461
+ * @returns {string} A string representing the data_store.
462
+ */
463
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
464
+ /**
465
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
466
+ *
467
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
468
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
469
+ * @returns {string} A string representing the branch.
470
+ */
471
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
472
+ /**
473
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
474
+ *
475
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
476
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
477
+ * @returns {string} A string representing the document.
478
+ */
479
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
480
+ /**
481
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
482
+ *
483
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
484
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
485
+ * @returns {string} A string representing the chunk.
486
+ */
487
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
386
488
  /**
387
489
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
388
490
  *
@@ -1232,6 +1334,66 @@ export declare class RankServiceClient {
1232
1334
  * @returns {string} A string representing the document.
1233
1335
  */
1234
1336
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1337
+ /**
1338
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
1339
+ *
1340
+ * @param {string} project
1341
+ * @param {string} location
1342
+ * @param {string} data_store
1343
+ * @param {string} branch
1344
+ * @param {string} document
1345
+ * @param {string} chunk
1346
+ * @returns {string} Resource name string.
1347
+ */
1348
+ projectLocationDataStoreBranchDocumentChunkPath(project: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;
1349
+ /**
1350
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
1351
+ *
1352
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1353
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1354
+ * @returns {string} A string representing the project.
1355
+ */
1356
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1357
+ /**
1358
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
1359
+ *
1360
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1361
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1362
+ * @returns {string} A string representing the location.
1363
+ */
1364
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1365
+ /**
1366
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
1367
+ *
1368
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1369
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1370
+ * @returns {string} A string representing the data_store.
1371
+ */
1372
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1373
+ /**
1374
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
1375
+ *
1376
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1377
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1378
+ * @returns {string} A string representing the branch.
1379
+ */
1380
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1381
+ /**
1382
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
1383
+ *
1384
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1385
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1386
+ * @returns {string} A string representing the document.
1387
+ */
1388
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1389
+ /**
1390
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
1391
+ *
1392
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1393
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1394
+ * @returns {string} A string representing the chunk.
1395
+ */
1396
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1235
1397
  /**
1236
1398
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
1237
1399
  *
@@ -1676,6 +1838,81 @@ export declare class RankServiceClient {
1676
1838
  * @returns {string} A string representing the ranking_config.
1677
1839
  */
1678
1840
  matchRankingConfigFromRankingConfigName(rankingConfigName: string): string | number;
1841
+ /**
1842
+ * Return a fully-qualified sampleQuery resource name string.
1843
+ *
1844
+ * @param {string} project
1845
+ * @param {string} location
1846
+ * @param {string} sample_query_set
1847
+ * @param {string} sample_query
1848
+ * @returns {string} Resource name string.
1849
+ */
1850
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
1851
+ /**
1852
+ * Parse the project from SampleQuery resource.
1853
+ *
1854
+ * @param {string} sampleQueryName
1855
+ * A fully-qualified path representing SampleQuery resource.
1856
+ * @returns {string} A string representing the project.
1857
+ */
1858
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
1859
+ /**
1860
+ * Parse the location from SampleQuery resource.
1861
+ *
1862
+ * @param {string} sampleQueryName
1863
+ * A fully-qualified path representing SampleQuery resource.
1864
+ * @returns {string} A string representing the location.
1865
+ */
1866
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
1867
+ /**
1868
+ * Parse the sample_query_set from SampleQuery resource.
1869
+ *
1870
+ * @param {string} sampleQueryName
1871
+ * A fully-qualified path representing SampleQuery resource.
1872
+ * @returns {string} A string representing the sample_query_set.
1873
+ */
1874
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
1875
+ /**
1876
+ * Parse the sample_query from SampleQuery resource.
1877
+ *
1878
+ * @param {string} sampleQueryName
1879
+ * A fully-qualified path representing SampleQuery resource.
1880
+ * @returns {string} A string representing the sample_query.
1881
+ */
1882
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
1883
+ /**
1884
+ * Return a fully-qualified sampleQuerySet resource name string.
1885
+ *
1886
+ * @param {string} project
1887
+ * @param {string} location
1888
+ * @param {string} sample_query_set
1889
+ * @returns {string} Resource name string.
1890
+ */
1891
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
1892
+ /**
1893
+ * Parse the project from SampleQuerySet resource.
1894
+ *
1895
+ * @param {string} sampleQuerySetName
1896
+ * A fully-qualified path representing SampleQuerySet resource.
1897
+ * @returns {string} A string representing the project.
1898
+ */
1899
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1900
+ /**
1901
+ * Parse the location from SampleQuerySet resource.
1902
+ *
1903
+ * @param {string} sampleQuerySetName
1904
+ * A fully-qualified path representing SampleQuerySet resource.
1905
+ * @returns {string} A string representing the location.
1906
+ */
1907
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1908
+ /**
1909
+ * Parse the sample_query_set from SampleQuerySet resource.
1910
+ *
1911
+ * @param {string} sampleQuerySetName
1912
+ * A fully-qualified path representing SampleQuerySet resource.
1913
+ * @returns {string} A string representing the sample_query_set.
1914
+ */
1915
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1679
1916
  /**
1680
1917
  * Terminate the gRPC channel and close the client.
1681
1918
  *
@@ -150,9 +150,11 @@ class RankServiceClient {
150
150
  // Create useful helper objects for these.
151
151
  this.pathTemplates = {
152
152
  enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
153
+ evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
153
154
  projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
154
155
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
155
156
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
157
+ projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
156
158
  projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
157
159
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
158
160
  projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -170,6 +172,7 @@ class RankServiceClient {
170
172
  projectLocationCollectionEngineSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}'),
171
173
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
172
174
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
175
+ projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
173
176
  projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
174
177
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
175
178
  projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -181,6 +184,8 @@ class RankServiceClient {
181
184
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
182
185
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
183
186
  rankingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/rankingConfigs/{ranking_config}'),
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}'),
184
189
  };
185
190
  // Put together the default options sent with requests.
186
191
  this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1beta.RankService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -428,6 +433,54 @@ class RankServiceClient {
428
433
  matchEngineFromEngineName(engineName) {
429
434
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
430
435
  }
436
+ /**
437
+ * Return a fully-qualified evaluation resource name string.
438
+ *
439
+ * @param {string} project
440
+ * @param {string} location
441
+ * @param {string} evaluation
442
+ * @returns {string} Resource name string.
443
+ */
444
+ evaluationPath(project, location, evaluation) {
445
+ return this.pathTemplates.evaluationPathTemplate.render({
446
+ project: project,
447
+ location: location,
448
+ evaluation: evaluation,
449
+ });
450
+ }
451
+ /**
452
+ * Parse the project from Evaluation resource.
453
+ *
454
+ * @param {string} evaluationName
455
+ * A fully-qualified path representing Evaluation resource.
456
+ * @returns {string} A string representing the project.
457
+ */
458
+ matchProjectFromEvaluationName(evaluationName) {
459
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
460
+ .project;
461
+ }
462
+ /**
463
+ * Parse the location from Evaluation resource.
464
+ *
465
+ * @param {string} evaluationName
466
+ * A fully-qualified path representing Evaluation resource.
467
+ * @returns {string} A string representing the location.
468
+ */
469
+ matchLocationFromEvaluationName(evaluationName) {
470
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
471
+ .location;
472
+ }
473
+ /**
474
+ * Parse the evaluation from Evaluation resource.
475
+ *
476
+ * @param {string} evaluationName
477
+ * A fully-qualified path representing Evaluation resource.
478
+ * @returns {string} A string representing the evaluation.
479
+ */
480
+ matchEvaluationFromEvaluationName(evaluationName) {
481
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
482
+ .evaluation;
483
+ }
431
484
  /**
432
485
  * Return a fully-qualified project resource name string.
433
486
  *
@@ -587,6 +640,99 @@ class RankServiceClient {
587
640
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
588
641
  return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
589
642
  }
643
+ /**
644
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
645
+ *
646
+ * @param {string} project
647
+ * @param {string} location
648
+ * @param {string} collection
649
+ * @param {string} data_store
650
+ * @param {string} branch
651
+ * @param {string} document
652
+ * @param {string} chunk
653
+ * @returns {string} Resource name string.
654
+ */
655
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project, location, collection, dataStore, branch, document, chunk) {
656
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.render({
657
+ project: project,
658
+ location: location,
659
+ collection: collection,
660
+ data_store: dataStore,
661
+ branch: branch,
662
+ document: document,
663
+ chunk: chunk,
664
+ });
665
+ }
666
+ /**
667
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
668
+ *
669
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
670
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
671
+ * @returns {string} A string representing the project.
672
+ */
673
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
674
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).project;
675
+ }
676
+ /**
677
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
678
+ *
679
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
680
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
681
+ * @returns {string} A string representing the location.
682
+ */
683
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
684
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).location;
685
+ }
686
+ /**
687
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
688
+ *
689
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
690
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
691
+ * @returns {string} A string representing the collection.
692
+ */
693
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
694
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).collection;
695
+ }
696
+ /**
697
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
698
+ *
699
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
700
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
701
+ * @returns {string} A string representing the data_store.
702
+ */
703
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
704
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).data_store;
705
+ }
706
+ /**
707
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
708
+ *
709
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
710
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
711
+ * @returns {string} A string representing the branch.
712
+ */
713
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
714
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).branch;
715
+ }
716
+ /**
717
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
718
+ *
719
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
720
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
721
+ * @returns {string} A string representing the document.
722
+ */
723
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
724
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).document;
725
+ }
726
+ /**
727
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
728
+ *
729
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
730
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
731
+ * @returns {string} A string representing the chunk.
732
+ */
733
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
734
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).chunk;
735
+ }
590
736
  /**
591
737
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
592
738
  *
@@ -1736,6 +1882,87 @@ class RankServiceClient {
1736
1882
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1737
1883
  return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
1738
1884
  }
1885
+ /**
1886
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
1887
+ *
1888
+ * @param {string} project
1889
+ * @param {string} location
1890
+ * @param {string} data_store
1891
+ * @param {string} branch
1892
+ * @param {string} document
1893
+ * @param {string} chunk
1894
+ * @returns {string} Resource name string.
1895
+ */
1896
+ projectLocationDataStoreBranchDocumentChunkPath(project, location, dataStore, branch, document, chunk) {
1897
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.render({
1898
+ project: project,
1899
+ location: location,
1900
+ data_store: dataStore,
1901
+ branch: branch,
1902
+ document: document,
1903
+ chunk: chunk,
1904
+ });
1905
+ }
1906
+ /**
1907
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
1908
+ *
1909
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1910
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1911
+ * @returns {string} A string representing the project.
1912
+ */
1913
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1914
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).project;
1915
+ }
1916
+ /**
1917
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
1918
+ *
1919
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1920
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1921
+ * @returns {string} A string representing the location.
1922
+ */
1923
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1924
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).location;
1925
+ }
1926
+ /**
1927
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
1928
+ *
1929
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1930
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1931
+ * @returns {string} A string representing the data_store.
1932
+ */
1933
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1934
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).data_store;
1935
+ }
1936
+ /**
1937
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
1938
+ *
1939
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1940
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1941
+ * @returns {string} A string representing the branch.
1942
+ */
1943
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1944
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).branch;
1945
+ }
1946
+ /**
1947
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
1948
+ *
1949
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1950
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1951
+ * @returns {string} A string representing the document.
1952
+ */
1953
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1954
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).document;
1955
+ }
1956
+ /**
1957
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
1958
+ *
1959
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1960
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1961
+ * @returns {string} A string representing the chunk.
1962
+ */
1963
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
1964
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).chunk;
1965
+ }
1739
1966
  /**
1740
1967
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
1741
1968
  *
@@ -2342,6 +2569,112 @@ class RankServiceClient {
2342
2569
  return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName)
2343
2570
  .ranking_config;
2344
2571
  }
2572
+ /**
2573
+ * Return a fully-qualified sampleQuery resource name string.
2574
+ *
2575
+ * @param {string} project
2576
+ * @param {string} location
2577
+ * @param {string} sample_query_set
2578
+ * @param {string} sample_query
2579
+ * @returns {string} Resource name string.
2580
+ */
2581
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2582
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2583
+ project: project,
2584
+ location: location,
2585
+ sample_query_set: sampleQuerySet,
2586
+ sample_query: sampleQuery,
2587
+ });
2588
+ }
2589
+ /**
2590
+ * Parse the project from SampleQuery resource.
2591
+ *
2592
+ * @param {string} sampleQueryName
2593
+ * A fully-qualified path representing SampleQuery resource.
2594
+ * @returns {string} A string representing the project.
2595
+ */
2596
+ matchProjectFromSampleQueryName(sampleQueryName) {
2597
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2598
+ .project;
2599
+ }
2600
+ /**
2601
+ * Parse the location from SampleQuery resource.
2602
+ *
2603
+ * @param {string} sampleQueryName
2604
+ * A fully-qualified path representing SampleQuery resource.
2605
+ * @returns {string} A string representing the location.
2606
+ */
2607
+ matchLocationFromSampleQueryName(sampleQueryName) {
2608
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2609
+ .location;
2610
+ }
2611
+ /**
2612
+ * Parse the sample_query_set from SampleQuery resource.
2613
+ *
2614
+ * @param {string} sampleQueryName
2615
+ * A fully-qualified path representing SampleQuery resource.
2616
+ * @returns {string} A string representing the sample_query_set.
2617
+ */
2618
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2619
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2620
+ .sample_query_set;
2621
+ }
2622
+ /**
2623
+ * Parse the sample_query from SampleQuery resource.
2624
+ *
2625
+ * @param {string} sampleQueryName
2626
+ * A fully-qualified path representing SampleQuery resource.
2627
+ * @returns {string} A string representing the sample_query.
2628
+ */
2629
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2630
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2631
+ .sample_query;
2632
+ }
2633
+ /**
2634
+ * Return a fully-qualified sampleQuerySet resource name string.
2635
+ *
2636
+ * @param {string} project
2637
+ * @param {string} location
2638
+ * @param {string} sample_query_set
2639
+ * @returns {string} Resource name string.
2640
+ */
2641
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2642
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2643
+ project: project,
2644
+ location: location,
2645
+ sample_query_set: sampleQuerySet,
2646
+ });
2647
+ }
2648
+ /**
2649
+ * Parse the project from SampleQuerySet resource.
2650
+ *
2651
+ * @param {string} sampleQuerySetName
2652
+ * A fully-qualified path representing SampleQuerySet resource.
2653
+ * @returns {string} A string representing the project.
2654
+ */
2655
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2656
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2657
+ }
2658
+ /**
2659
+ * Parse the location from SampleQuerySet resource.
2660
+ *
2661
+ * @param {string} sampleQuerySetName
2662
+ * A fully-qualified path representing SampleQuerySet resource.
2663
+ * @returns {string} A string representing the location.
2664
+ */
2665
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
2666
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
2667
+ }
2668
+ /**
2669
+ * Parse the sample_query_set from SampleQuerySet resource.
2670
+ *
2671
+ * @param {string} sampleQuerySetName
2672
+ * A fully-qualified path representing SampleQuerySet resource.
2673
+ * @returns {string} A string representing the sample_query_set.
2674
+ */
2675
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
2676
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
2677
+ }
2345
2678
  /**
2346
2679
  * Terminate the gRPC channel and close the client.
2347
2680
  *