@google-cloud/discoveryengine 1.10.0 → 1.12.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 (129) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +33 -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/answer.proto +14 -0
  11. package/build/protos/google/cloud/discoveryengine/v1beta/chunk.proto +119 -0
  12. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
  13. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +31 -0
  14. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +29 -2
  16. package/build/protos/google/cloud/discoveryengine/v1beta/custom_tuning_model.proto +7 -1
  17. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +23 -0
  18. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +10 -0
  19. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  20. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
  21. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
  22. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
  23. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +191 -0
  24. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +111 -0
  25. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
  26. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
  27. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +370 -8
  30. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
  31. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +24 -0
  32. package/build/protos/protos.d.ts +32735 -21073
  33. package/build/protos/protos.js +80768 -53241
  34. package/build/protos/protos.json +5309 -2481
  35. package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
  36. package/build/src/v1alpha/acl_config_service_client.js +157 -0
  37. package/build/src/v1alpha/chunk_service_client.d.ts +108 -0
  38. package/build/src/v1alpha/chunk_service_client.js +157 -0
  39. package/build/src/v1alpha/completion_service_client.d.ts +108 -0
  40. package/build/src/v1alpha/completion_service_client.js +157 -0
  41. package/build/src/v1alpha/control_service_client.d.ts +108 -0
  42. package/build/src/v1alpha/control_service_client.js +157 -0
  43. package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -0
  44. package/build/src/v1alpha/conversational_search_service_client.js +157 -0
  45. package/build/src/v1alpha/data_store_service_client.d.ts +108 -0
  46. package/build/src/v1alpha/data_store_service_client.js +157 -0
  47. package/build/src/v1alpha/document_service_client.d.ts +108 -0
  48. package/build/src/v1alpha/document_service_client.js +157 -0
  49. package/build/src/v1alpha/engine_service_client.d.ts +108 -0
  50. package/build/src/v1alpha/engine_service_client.js +157 -0
  51. package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
  52. package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
  53. package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
  54. package/build/src/v1alpha/evaluation_service_client.js +3288 -0
  55. package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
  56. package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
  57. package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
  58. package/build/src/v1alpha/index.d.ts +3 -0
  59. package/build/src/v1alpha/index.js +7 -1
  60. package/build/src/v1alpha/project_service_client.d.ts +108 -0
  61. package/build/src/v1alpha/project_service_client.js +157 -0
  62. package/build/src/v1alpha/rank_service_client.d.ts +108 -0
  63. package/build/src/v1alpha/rank_service_client.js +157 -0
  64. package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
  65. package/build/src/v1alpha/recommendation_service_client.js +157 -0
  66. package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
  67. package/build/src/v1alpha/sample_query_service_client.js +3186 -0
  68. package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
  69. package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
  70. package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
  71. package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
  72. package/build/src/v1alpha/schema_service_client.d.ts +108 -0
  73. package/build/src/v1alpha/schema_service_client.js +157 -0
  74. package/build/src/v1alpha/search_service_client.d.ts +108 -0
  75. package/build/src/v1alpha/search_service_client.js +157 -0
  76. package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
  77. package/build/src/v1alpha/search_tuning_service_client.js +157 -0
  78. package/build/src/v1alpha/serving_config_service_client.d.ts +108 -0
  79. package/build/src/v1alpha/serving_config_service_client.js +157 -0
  80. package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -0
  81. package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
  82. package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
  83. package/build/src/v1alpha/user_event_service_client.js +157 -0
  84. package/build/src/v1beta/completion_service_client.d.ts +328 -0
  85. package/build/src/v1beta/completion_service_client.js +423 -0
  86. package/build/src/v1beta/completion_service_client_config.json +10 -0
  87. package/build/src/v1beta/control_service_client.d.ts +237 -0
  88. package/build/src/v1beta/control_service_client.js +333 -0
  89. package/build/src/v1beta/conversational_search_service_client.d.ts +255 -0
  90. package/build/src/v1beta/conversational_search_service_client.js +333 -0
  91. package/build/src/v1beta/data_store_service_client.d.ts +246 -0
  92. package/build/src/v1beta/data_store_service_client.js +339 -0
  93. package/build/src/v1beta/document_service_client.d.ts +239 -0
  94. package/build/src/v1beta/document_service_client.js +339 -0
  95. package/build/src/v1beta/engine_service_client.d.ts +237 -0
  96. package/build/src/v1beta/engine_service_client.js +339 -0
  97. package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
  98. package/build/src/v1beta/evaluation_service_client.js +3252 -0
  99. package/build/src/v1beta/evaluation_service_client_config.json +58 -0
  100. package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
  101. package/build/src/v1beta/grounded_generation_service_client.js +333 -0
  102. package/build/src/v1beta/index.d.ts +3 -0
  103. package/build/src/v1beta/index.js +7 -1
  104. package/build/src/v1beta/project_service_client.d.ts +237 -0
  105. package/build/src/v1beta/project_service_client.js +339 -0
  106. package/build/src/v1beta/rank_service_client.d.ts +237 -0
  107. package/build/src/v1beta/rank_service_client.js +333 -0
  108. package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
  109. package/build/src/v1beta/recommendation_service_client.js +333 -0
  110. package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
  111. package/build/src/v1beta/sample_query_service_client.js +3150 -0
  112. package/build/src/v1beta/sample_query_service_client_config.json +68 -0
  113. package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
  114. package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
  115. package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
  116. package/build/src/v1beta/schema_service_client.d.ts +237 -0
  117. package/build/src/v1beta/schema_service_client.js +339 -0
  118. package/build/src/v1beta/search_service_client.d.ts +414 -12
  119. package/build/src/v1beta/search_service_client.js +451 -8
  120. package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
  121. package/build/src/v1beta/search_tuning_service_client.js +339 -0
  122. package/build/src/v1beta/serving_config_service_client.d.ts +237 -0
  123. package/build/src/v1beta/serving_config_service_client.js +333 -0
  124. package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -0
  125. package/build/src/v1beta/site_search_engine_service_client.js +339 -0
  126. package/build/src/v1beta/user_event_service_client.d.ts +312 -0
  127. package/build/src/v1beta/user_event_service_client.js +381 -0
  128. package/build/src/v1beta/user_event_service_client_config.json +5 -0
  129. package/package.json +1 -1
@@ -448,6 +448,39 @@ export declare class ControlServiceClient {
448
448
  * @returns {string} A string representing the engine.
449
449
  */
450
450
  matchEngineFromEngineName(engineName: string): string | number;
451
+ /**
452
+ * Return a fully-qualified evaluation resource name string.
453
+ *
454
+ * @param {string} project
455
+ * @param {string} location
456
+ * @param {string} evaluation
457
+ * @returns {string} Resource name string.
458
+ */
459
+ evaluationPath(project: string, location: string, evaluation: string): string;
460
+ /**
461
+ * Parse the project from Evaluation resource.
462
+ *
463
+ * @param {string} evaluationName
464
+ * A fully-qualified path representing Evaluation resource.
465
+ * @returns {string} A string representing the project.
466
+ */
467
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
468
+ /**
469
+ * Parse the location from Evaluation resource.
470
+ *
471
+ * @param {string} evaluationName
472
+ * A fully-qualified path representing Evaluation resource.
473
+ * @returns {string} A string representing the location.
474
+ */
475
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
476
+ /**
477
+ * Parse the evaluation from Evaluation resource.
478
+ *
479
+ * @param {string} evaluationName
480
+ * A fully-qualified path representing Evaluation resource.
481
+ * @returns {string} A string representing the evaluation.
482
+ */
483
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
451
484
  /**
452
485
  * Return a fully-qualified location resource name string.
453
486
  *
@@ -589,6 +622,75 @@ export declare class ControlServiceClient {
589
622
  * @returns {string} A string representing the document.
590
623
  */
591
624
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
625
+ /**
626
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
627
+ *
628
+ * @param {string} project
629
+ * @param {string} location
630
+ * @param {string} collection
631
+ * @param {string} data_store
632
+ * @param {string} branch
633
+ * @param {string} document
634
+ * @param {string} chunk
635
+ * @returns {string} Resource name string.
636
+ */
637
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;
638
+ /**
639
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
640
+ *
641
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
642
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
643
+ * @returns {string} A string representing the project.
644
+ */
645
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
646
+ /**
647
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
648
+ *
649
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
650
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
651
+ * @returns {string} A string representing the location.
652
+ */
653
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
654
+ /**
655
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
656
+ *
657
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
658
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
659
+ * @returns {string} A string representing the collection.
660
+ */
661
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
662
+ /**
663
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
664
+ *
665
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
666
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
667
+ * @returns {string} A string representing the data_store.
668
+ */
669
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
670
+ /**
671
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
672
+ *
673
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
674
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
675
+ * @returns {string} A string representing the branch.
676
+ */
677
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
678
+ /**
679
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
680
+ *
681
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
682
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
683
+ * @returns {string} A string representing the document.
684
+ */
685
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
686
+ /**
687
+ * Parse the chunk 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 chunk.
692
+ */
693
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
592
694
  /**
593
695
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
594
696
  *
@@ -1438,6 +1540,66 @@ export declare class ControlServiceClient {
1438
1540
  * @returns {string} A string representing the document.
1439
1541
  */
1440
1542
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1543
+ /**
1544
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
1545
+ *
1546
+ * @param {string} project
1547
+ * @param {string} location
1548
+ * @param {string} data_store
1549
+ * @param {string} branch
1550
+ * @param {string} document
1551
+ * @param {string} chunk
1552
+ * @returns {string} Resource name string.
1553
+ */
1554
+ projectLocationDataStoreBranchDocumentChunkPath(project: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;
1555
+ /**
1556
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
1557
+ *
1558
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1559
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1560
+ * @returns {string} A string representing the project.
1561
+ */
1562
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1563
+ /**
1564
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
1565
+ *
1566
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1567
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1568
+ * @returns {string} A string representing the location.
1569
+ */
1570
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1571
+ /**
1572
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
1573
+ *
1574
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1575
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1576
+ * @returns {string} A string representing the data_store.
1577
+ */
1578
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1579
+ /**
1580
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
1581
+ *
1582
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1583
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1584
+ * @returns {string} A string representing the branch.
1585
+ */
1586
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1587
+ /**
1588
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
1589
+ *
1590
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1591
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1592
+ * @returns {string} A string representing the document.
1593
+ */
1594
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1595
+ /**
1596
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
1597
+ *
1598
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1599
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1600
+ * @returns {string} A string representing the chunk.
1601
+ */
1602
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1441
1603
  /**
1442
1604
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
1443
1605
  *
@@ -1849,6 +2011,81 @@ export declare class ControlServiceClient {
1849
2011
  * @returns {string} A string representing the target_site.
1850
2012
  */
1851
2013
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2014
+ /**
2015
+ * Return a fully-qualified sampleQuery resource name string.
2016
+ *
2017
+ * @param {string} project
2018
+ * @param {string} location
2019
+ * @param {string} sample_query_set
2020
+ * @param {string} sample_query
2021
+ * @returns {string} Resource name string.
2022
+ */
2023
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2024
+ /**
2025
+ * Parse the project from SampleQuery resource.
2026
+ *
2027
+ * @param {string} sampleQueryName
2028
+ * A fully-qualified path representing SampleQuery resource.
2029
+ * @returns {string} A string representing the project.
2030
+ */
2031
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2032
+ /**
2033
+ * Parse the location from SampleQuery resource.
2034
+ *
2035
+ * @param {string} sampleQueryName
2036
+ * A fully-qualified path representing SampleQuery resource.
2037
+ * @returns {string} A string representing the location.
2038
+ */
2039
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2040
+ /**
2041
+ * Parse the sample_query_set from SampleQuery resource.
2042
+ *
2043
+ * @param {string} sampleQueryName
2044
+ * A fully-qualified path representing SampleQuery resource.
2045
+ * @returns {string} A string representing the sample_query_set.
2046
+ */
2047
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2048
+ /**
2049
+ * Parse the sample_query from SampleQuery resource.
2050
+ *
2051
+ * @param {string} sampleQueryName
2052
+ * A fully-qualified path representing SampleQuery resource.
2053
+ * @returns {string} A string representing the sample_query.
2054
+ */
2055
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2056
+ /**
2057
+ * Return a fully-qualified sampleQuerySet resource name string.
2058
+ *
2059
+ * @param {string} project
2060
+ * @param {string} location
2061
+ * @param {string} sample_query_set
2062
+ * @returns {string} Resource name string.
2063
+ */
2064
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2065
+ /**
2066
+ * Parse the project from SampleQuerySet resource.
2067
+ *
2068
+ * @param {string} sampleQuerySetName
2069
+ * A fully-qualified path representing SampleQuerySet resource.
2070
+ * @returns {string} A string representing the project.
2071
+ */
2072
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2073
+ /**
2074
+ * Parse the location from SampleQuerySet resource.
2075
+ *
2076
+ * @param {string} sampleQuerySetName
2077
+ * A fully-qualified path representing SampleQuerySet resource.
2078
+ * @returns {string} A string representing the location.
2079
+ */
2080
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2081
+ /**
2082
+ * Parse the sample_query_set from SampleQuerySet resource.
2083
+ *
2084
+ * @param {string} sampleQuerySetName
2085
+ * A fully-qualified path representing SampleQuerySet resource.
2086
+ * @returns {string} A string representing the sample_query_set.
2087
+ */
2088
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
1852
2089
  /**
1853
2090
  * Terminate the gRPC channel and close the client.
1854
2091
  *
@@ -153,10 +153,12 @@ class ControlServiceClient {
153
153
  // Create useful helper objects for these.
154
154
  this.pathTemplates = {
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
  locationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}'),
157
158
  projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
158
159
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
159
160
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
161
+ projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
160
162
  projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
161
163
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
162
164
  projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -174,6 +176,7 @@ class ControlServiceClient {
174
176
  projectLocationCollectionEngineSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}'),
175
177
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
176
178
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
179
+ projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
177
180
  projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
178
181
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
179
182
  projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -184,6 +187,8 @@ class ControlServiceClient {
184
187
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
185
188
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
186
189
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
190
+ sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
191
+ sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
187
192
  };
188
193
  // Some of the methods on this service return "paged" results,
189
194
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -625,6 +630,54 @@ class ControlServiceClient {
625
630
  matchEngineFromEngineName(engineName) {
626
631
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
627
632
  }
633
+ /**
634
+ * Return a fully-qualified evaluation resource name string.
635
+ *
636
+ * @param {string} project
637
+ * @param {string} location
638
+ * @param {string} evaluation
639
+ * @returns {string} Resource name string.
640
+ */
641
+ evaluationPath(project, location, evaluation) {
642
+ return this.pathTemplates.evaluationPathTemplate.render({
643
+ project: project,
644
+ location: location,
645
+ evaluation: evaluation,
646
+ });
647
+ }
648
+ /**
649
+ * Parse the project from Evaluation resource.
650
+ *
651
+ * @param {string} evaluationName
652
+ * A fully-qualified path representing Evaluation resource.
653
+ * @returns {string} A string representing the project.
654
+ */
655
+ matchProjectFromEvaluationName(evaluationName) {
656
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
657
+ .project;
658
+ }
659
+ /**
660
+ * Parse the location from Evaluation resource.
661
+ *
662
+ * @param {string} evaluationName
663
+ * A fully-qualified path representing Evaluation resource.
664
+ * @returns {string} A string representing the location.
665
+ */
666
+ matchLocationFromEvaluationName(evaluationName) {
667
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
668
+ .location;
669
+ }
670
+ /**
671
+ * Parse the evaluation from Evaluation resource.
672
+ *
673
+ * @param {string} evaluationName
674
+ * A fully-qualified path representing Evaluation resource.
675
+ * @returns {string} A string representing the evaluation.
676
+ */
677
+ matchEvaluationFromEvaluationName(evaluationName) {
678
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
679
+ .evaluation;
680
+ }
628
681
  /**
629
682
  * Return a fully-qualified location resource name string.
630
683
  *
@@ -817,6 +870,99 @@ class ControlServiceClient {
817
870
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
818
871
  return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
819
872
  }
873
+ /**
874
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
875
+ *
876
+ * @param {string} project
877
+ * @param {string} location
878
+ * @param {string} collection
879
+ * @param {string} data_store
880
+ * @param {string} branch
881
+ * @param {string} document
882
+ * @param {string} chunk
883
+ * @returns {string} Resource name string.
884
+ */
885
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project, location, collection, dataStore, branch, document, chunk) {
886
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.render({
887
+ project: project,
888
+ location: location,
889
+ collection: collection,
890
+ data_store: dataStore,
891
+ branch: branch,
892
+ document: document,
893
+ chunk: chunk,
894
+ });
895
+ }
896
+ /**
897
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
898
+ *
899
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
900
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
901
+ * @returns {string} A string representing the project.
902
+ */
903
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
904
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).project;
905
+ }
906
+ /**
907
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
908
+ *
909
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
910
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
911
+ * @returns {string} A string representing the location.
912
+ */
913
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
914
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).location;
915
+ }
916
+ /**
917
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
918
+ *
919
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
920
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
921
+ * @returns {string} A string representing the collection.
922
+ */
923
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
924
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).collection;
925
+ }
926
+ /**
927
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
928
+ *
929
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
930
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
931
+ * @returns {string} A string representing the data_store.
932
+ */
933
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
934
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).data_store;
935
+ }
936
+ /**
937
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
938
+ *
939
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
940
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
941
+ * @returns {string} A string representing the branch.
942
+ */
943
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
944
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).branch;
945
+ }
946
+ /**
947
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
948
+ *
949
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
950
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
951
+ * @returns {string} A string representing the document.
952
+ */
953
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
954
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).document;
955
+ }
956
+ /**
957
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
958
+ *
959
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
960
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
961
+ * @returns {string} A string representing the chunk.
962
+ */
963
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
964
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).chunk;
965
+ }
820
966
  /**
821
967
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
822
968
  *
@@ -1966,6 +2112,87 @@ class ControlServiceClient {
1966
2112
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1967
2113
  return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
1968
2114
  }
2115
+ /**
2116
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
2117
+ *
2118
+ * @param {string} project
2119
+ * @param {string} location
2120
+ * @param {string} data_store
2121
+ * @param {string} branch
2122
+ * @param {string} document
2123
+ * @param {string} chunk
2124
+ * @returns {string} Resource name string.
2125
+ */
2126
+ projectLocationDataStoreBranchDocumentChunkPath(project, location, dataStore, branch, document, chunk) {
2127
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.render({
2128
+ project: project,
2129
+ location: location,
2130
+ data_store: dataStore,
2131
+ branch: branch,
2132
+ document: document,
2133
+ chunk: chunk,
2134
+ });
2135
+ }
2136
+ /**
2137
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
2138
+ *
2139
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2140
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2141
+ * @returns {string} A string representing the project.
2142
+ */
2143
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2144
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).project;
2145
+ }
2146
+ /**
2147
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
2148
+ *
2149
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2150
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2151
+ * @returns {string} A string representing the location.
2152
+ */
2153
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2154
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).location;
2155
+ }
2156
+ /**
2157
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
2158
+ *
2159
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2160
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2161
+ * @returns {string} A string representing the data_store.
2162
+ */
2163
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2164
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).data_store;
2165
+ }
2166
+ /**
2167
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
2168
+ *
2169
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2170
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2171
+ * @returns {string} A string representing the branch.
2172
+ */
2173
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2174
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).branch;
2175
+ }
2176
+ /**
2177
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
2178
+ *
2179
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2180
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2181
+ * @returns {string} A string representing the document.
2182
+ */
2183
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2184
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).document;
2185
+ }
2186
+ /**
2187
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
2188
+ *
2189
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2190
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2191
+ * @returns {string} A string representing the chunk.
2192
+ */
2193
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2194
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).chunk;
2195
+ }
1969
2196
  /**
1970
2197
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
1971
2198
  *
@@ -2524,6 +2751,112 @@ class ControlServiceClient {
2524
2751
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2525
2752
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2526
2753
  }
2754
+ /**
2755
+ * Return a fully-qualified sampleQuery resource name string.
2756
+ *
2757
+ * @param {string} project
2758
+ * @param {string} location
2759
+ * @param {string} sample_query_set
2760
+ * @param {string} sample_query
2761
+ * @returns {string} Resource name string.
2762
+ */
2763
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
2764
+ return this.pathTemplates.sampleQueryPathTemplate.render({
2765
+ project: project,
2766
+ location: location,
2767
+ sample_query_set: sampleQuerySet,
2768
+ sample_query: sampleQuery,
2769
+ });
2770
+ }
2771
+ /**
2772
+ * Parse the project from SampleQuery resource.
2773
+ *
2774
+ * @param {string} sampleQueryName
2775
+ * A fully-qualified path representing SampleQuery resource.
2776
+ * @returns {string} A string representing the project.
2777
+ */
2778
+ matchProjectFromSampleQueryName(sampleQueryName) {
2779
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2780
+ .project;
2781
+ }
2782
+ /**
2783
+ * Parse the location from SampleQuery resource.
2784
+ *
2785
+ * @param {string} sampleQueryName
2786
+ * A fully-qualified path representing SampleQuery resource.
2787
+ * @returns {string} A string representing the location.
2788
+ */
2789
+ matchLocationFromSampleQueryName(sampleQueryName) {
2790
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2791
+ .location;
2792
+ }
2793
+ /**
2794
+ * Parse the sample_query_set from SampleQuery resource.
2795
+ *
2796
+ * @param {string} sampleQueryName
2797
+ * A fully-qualified path representing SampleQuery resource.
2798
+ * @returns {string} A string representing the sample_query_set.
2799
+ */
2800
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
2801
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2802
+ .sample_query_set;
2803
+ }
2804
+ /**
2805
+ * Parse the sample_query from SampleQuery resource.
2806
+ *
2807
+ * @param {string} sampleQueryName
2808
+ * A fully-qualified path representing SampleQuery resource.
2809
+ * @returns {string} A string representing the sample_query.
2810
+ */
2811
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
2812
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
2813
+ .sample_query;
2814
+ }
2815
+ /**
2816
+ * Return a fully-qualified sampleQuerySet resource name string.
2817
+ *
2818
+ * @param {string} project
2819
+ * @param {string} location
2820
+ * @param {string} sample_query_set
2821
+ * @returns {string} Resource name string.
2822
+ */
2823
+ sampleQuerySetPath(project, location, sampleQuerySet) {
2824
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
2825
+ project: project,
2826
+ location: location,
2827
+ sample_query_set: sampleQuerySet,
2828
+ });
2829
+ }
2830
+ /**
2831
+ * Parse the project from SampleQuerySet resource.
2832
+ *
2833
+ * @param {string} sampleQuerySetName
2834
+ * A fully-qualified path representing SampleQuerySet resource.
2835
+ * @returns {string} A string representing the project.
2836
+ */
2837
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
2838
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
2839
+ }
2840
+ /**
2841
+ * Parse the location from SampleQuerySet resource.
2842
+ *
2843
+ * @param {string} sampleQuerySetName
2844
+ * A fully-qualified path representing SampleQuerySet resource.
2845
+ * @returns {string} A string representing the location.
2846
+ */
2847
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
2848
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
2849
+ }
2850
+ /**
2851
+ * Parse the sample_query_set from SampleQuerySet resource.
2852
+ *
2853
+ * @param {string} sampleQuerySetName
2854
+ * A fully-qualified path representing SampleQuerySet resource.
2855
+ * @returns {string} A string representing the sample_query_set.
2856
+ */
2857
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
2858
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
2859
+ }
2527
2860
  /**
2528
2861
  * Terminate the gRPC channel and close the client.
2529
2862
  *