@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
@@ -887,6 +887,39 @@ export declare class ConversationalSearchServiceClient {
887
887
  * @returns {string} A string representing the engine.
888
888
  */
889
889
  matchEngineFromEngineName(engineName: string): string | number;
890
+ /**
891
+ * Return a fully-qualified evaluation resource name string.
892
+ *
893
+ * @param {string} project
894
+ * @param {string} location
895
+ * @param {string} evaluation
896
+ * @returns {string} Resource name string.
897
+ */
898
+ evaluationPath(project: string, location: string, evaluation: string): string;
899
+ /**
900
+ * Parse the project from Evaluation resource.
901
+ *
902
+ * @param {string} evaluationName
903
+ * A fully-qualified path representing Evaluation resource.
904
+ * @returns {string} A string representing the project.
905
+ */
906
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
907
+ /**
908
+ * Parse the location from Evaluation resource.
909
+ *
910
+ * @param {string} evaluationName
911
+ * A fully-qualified path representing Evaluation resource.
912
+ * @returns {string} A string representing the location.
913
+ */
914
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
915
+ /**
916
+ * Parse the evaluation from Evaluation resource.
917
+ *
918
+ * @param {string} evaluationName
919
+ * A fully-qualified path representing Evaluation resource.
920
+ * @returns {string} A string representing the evaluation.
921
+ */
922
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
890
923
  /**
891
924
  * Return a fully-qualified project resource name string.
892
925
  *
@@ -1004,6 +1037,75 @@ export declare class ConversationalSearchServiceClient {
1004
1037
  * @returns {string} A string representing the document.
1005
1038
  */
1006
1039
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
1040
+ /**
1041
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
1042
+ *
1043
+ * @param {string} project
1044
+ * @param {string} location
1045
+ * @param {string} collection
1046
+ * @param {string} data_store
1047
+ * @param {string} branch
1048
+ * @param {string} document
1049
+ * @param {string} chunk
1050
+ * @returns {string} Resource name string.
1051
+ */
1052
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string, chunk: string): string;
1053
+ /**
1054
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1055
+ *
1056
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1057
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1058
+ * @returns {string} A string representing the project.
1059
+ */
1060
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1061
+ /**
1062
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1063
+ *
1064
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1065
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1066
+ * @returns {string} A string representing the location.
1067
+ */
1068
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1069
+ /**
1070
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1071
+ *
1072
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1073
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1074
+ * @returns {string} A string representing the collection.
1075
+ */
1076
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1077
+ /**
1078
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1079
+ *
1080
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1081
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1082
+ * @returns {string} A string representing the data_store.
1083
+ */
1084
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1085
+ /**
1086
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1087
+ *
1088
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1089
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1090
+ * @returns {string} A string representing the branch.
1091
+ */
1092
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1093
+ /**
1094
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1095
+ *
1096
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1097
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1098
+ * @returns {string} A string representing the document.
1099
+ */
1100
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1101
+ /**
1102
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1103
+ *
1104
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1105
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1106
+ * @returns {string} A string representing the chunk.
1107
+ */
1108
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName: string): string | number;
1007
1109
  /**
1008
1110
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
1009
1111
  *
@@ -1853,6 +1955,66 @@ export declare class ConversationalSearchServiceClient {
1853
1955
  * @returns {string} A string representing the document.
1854
1956
  */
1855
1957
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
1958
+ /**
1959
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
1960
+ *
1961
+ * @param {string} project
1962
+ * @param {string} location
1963
+ * @param {string} data_store
1964
+ * @param {string} branch
1965
+ * @param {string} document
1966
+ * @param {string} chunk
1967
+ * @returns {string} Resource name string.
1968
+ */
1969
+ projectLocationDataStoreBranchDocumentChunkPath(project: string, location: string, dataStore: string, branch: string, document: string, chunk: string): string;
1970
+ /**
1971
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
1972
+ *
1973
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1974
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1975
+ * @returns {string} A string representing the project.
1976
+ */
1977
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1978
+ /**
1979
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
1980
+ *
1981
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1982
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1983
+ * @returns {string} A string representing the location.
1984
+ */
1985
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1986
+ /**
1987
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
1988
+ *
1989
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1990
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1991
+ * @returns {string} A string representing the data_store.
1992
+ */
1993
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1994
+ /**
1995
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
1996
+ *
1997
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
1998
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
1999
+ * @returns {string} A string representing the branch.
2000
+ */
2001
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
2002
+ /**
2003
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
2004
+ *
2005
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2006
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2007
+ * @returns {string} A string representing the document.
2008
+ */
2009
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
2010
+ /**
2011
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
2012
+ *
2013
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2014
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2015
+ * @returns {string} A string representing the chunk.
2016
+ */
2017
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName: string): string | number;
1856
2018
  /**
1857
2019
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
1858
2020
  *
@@ -2264,6 +2426,81 @@ export declare class ConversationalSearchServiceClient {
2264
2426
  * @returns {string} A string representing the target_site.
2265
2427
  */
2266
2428
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2429
+ /**
2430
+ * Return a fully-qualified sampleQuery resource name string.
2431
+ *
2432
+ * @param {string} project
2433
+ * @param {string} location
2434
+ * @param {string} sample_query_set
2435
+ * @param {string} sample_query
2436
+ * @returns {string} Resource name string.
2437
+ */
2438
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2439
+ /**
2440
+ * Parse the project from SampleQuery resource.
2441
+ *
2442
+ * @param {string} sampleQueryName
2443
+ * A fully-qualified path representing SampleQuery resource.
2444
+ * @returns {string} A string representing the project.
2445
+ */
2446
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2447
+ /**
2448
+ * Parse the location from SampleQuery resource.
2449
+ *
2450
+ * @param {string} sampleQueryName
2451
+ * A fully-qualified path representing SampleQuery resource.
2452
+ * @returns {string} A string representing the location.
2453
+ */
2454
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2455
+ /**
2456
+ * Parse the sample_query_set from SampleQuery resource.
2457
+ *
2458
+ * @param {string} sampleQueryName
2459
+ * A fully-qualified path representing SampleQuery resource.
2460
+ * @returns {string} A string representing the sample_query_set.
2461
+ */
2462
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2463
+ /**
2464
+ * Parse the sample_query from SampleQuery resource.
2465
+ *
2466
+ * @param {string} sampleQueryName
2467
+ * A fully-qualified path representing SampleQuery resource.
2468
+ * @returns {string} A string representing the sample_query.
2469
+ */
2470
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2471
+ /**
2472
+ * Return a fully-qualified sampleQuerySet resource name string.
2473
+ *
2474
+ * @param {string} project
2475
+ * @param {string} location
2476
+ * @param {string} sample_query_set
2477
+ * @returns {string} Resource name string.
2478
+ */
2479
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2480
+ /**
2481
+ * Parse the project from SampleQuerySet resource.
2482
+ *
2483
+ * @param {string} sampleQuerySetName
2484
+ * A fully-qualified path representing SampleQuerySet resource.
2485
+ * @returns {string} A string representing the project.
2486
+ */
2487
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2488
+ /**
2489
+ * Parse the location from SampleQuerySet resource.
2490
+ *
2491
+ * @param {string} sampleQuerySetName
2492
+ * A fully-qualified path representing SampleQuerySet resource.
2493
+ * @returns {string} A string representing the location.
2494
+ */
2495
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2496
+ /**
2497
+ * Parse the sample_query_set from SampleQuerySet resource.
2498
+ *
2499
+ * @param {string} sampleQuerySetName
2500
+ * A fully-qualified path representing SampleQuerySet resource.
2501
+ * @returns {string} A string representing the sample_query_set.
2502
+ */
2503
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2267
2504
  /**
2268
2505
  * Terminate the gRPC channel and close the client.
2269
2506
  *
@@ -151,9 +151,11 @@ class ConversationalSearchServiceClient {
151
151
  // Create useful helper objects for these.
152
152
  this.pathTemplates = {
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}'),
158
+ projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
157
159
  projectLocationCollectionDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/controls/{control}'),
158
160
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
159
161
  projectLocationCollectionDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -171,6 +173,7 @@ class ConversationalSearchServiceClient {
171
173
  projectLocationCollectionEngineSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/answers/{answer}'),
172
174
  projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
173
175
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
176
+ projectLocationDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
174
177
  projectLocationDataStoreControlPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/controls/{control}'),
175
178
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
176
179
  projectLocationDataStoreCustomTuningModelPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}'),
@@ -181,6 +184,8 @@ class ConversationalSearchServiceClient {
181
184
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
182
185
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
183
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}'),
184
189
  };
185
190
  // Some of the methods on this service return "paged" results,
186
191
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -932,6 +937,54 @@ class ConversationalSearchServiceClient {
932
937
  matchEngineFromEngineName(engineName) {
933
938
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
934
939
  }
940
+ /**
941
+ * Return a fully-qualified evaluation resource name string.
942
+ *
943
+ * @param {string} project
944
+ * @param {string} location
945
+ * @param {string} evaluation
946
+ * @returns {string} Resource name string.
947
+ */
948
+ evaluationPath(project, location, evaluation) {
949
+ return this.pathTemplates.evaluationPathTemplate.render({
950
+ project: project,
951
+ location: location,
952
+ evaluation: evaluation,
953
+ });
954
+ }
955
+ /**
956
+ * Parse the project from Evaluation resource.
957
+ *
958
+ * @param {string} evaluationName
959
+ * A fully-qualified path representing Evaluation resource.
960
+ * @returns {string} A string representing the project.
961
+ */
962
+ matchProjectFromEvaluationName(evaluationName) {
963
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
964
+ .project;
965
+ }
966
+ /**
967
+ * Parse the location from Evaluation resource.
968
+ *
969
+ * @param {string} evaluationName
970
+ * A fully-qualified path representing Evaluation resource.
971
+ * @returns {string} A string representing the location.
972
+ */
973
+ matchLocationFromEvaluationName(evaluationName) {
974
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
975
+ .location;
976
+ }
977
+ /**
978
+ * Parse the evaluation from Evaluation resource.
979
+ *
980
+ * @param {string} evaluationName
981
+ * A fully-qualified path representing Evaluation resource.
982
+ * @returns {string} A string representing the evaluation.
983
+ */
984
+ matchEvaluationFromEvaluationName(evaluationName) {
985
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
986
+ .evaluation;
987
+ }
935
988
  /**
936
989
  * Return a fully-qualified project resource name string.
937
990
  *
@@ -1091,6 +1144,99 @@ class ConversationalSearchServiceClient {
1091
1144
  matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1092
1145
  return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
1093
1146
  }
1147
+ /**
1148
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocumentChunk resource name string.
1149
+ *
1150
+ * @param {string} project
1151
+ * @param {string} location
1152
+ * @param {string} collection
1153
+ * @param {string} data_store
1154
+ * @param {string} branch
1155
+ * @param {string} document
1156
+ * @param {string} chunk
1157
+ * @returns {string} Resource name string.
1158
+ */
1159
+ projectLocationCollectionDataStoreBranchDocumentChunkPath(project, location, collection, dataStore, branch, document, chunk) {
1160
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.render({
1161
+ project: project,
1162
+ location: location,
1163
+ collection: collection,
1164
+ data_store: dataStore,
1165
+ branch: branch,
1166
+ document: document,
1167
+ chunk: chunk,
1168
+ });
1169
+ }
1170
+ /**
1171
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1172
+ *
1173
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1174
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1175
+ * @returns {string} A string representing the project.
1176
+ */
1177
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1178
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).project;
1179
+ }
1180
+ /**
1181
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1182
+ *
1183
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1184
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1185
+ * @returns {string} A string representing the location.
1186
+ */
1187
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1188
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).location;
1189
+ }
1190
+ /**
1191
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1192
+ *
1193
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1194
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1195
+ * @returns {string} A string representing the collection.
1196
+ */
1197
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1198
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).collection;
1199
+ }
1200
+ /**
1201
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1202
+ *
1203
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1204
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1205
+ * @returns {string} A string representing the data_store.
1206
+ */
1207
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1208
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).data_store;
1209
+ }
1210
+ /**
1211
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1212
+ *
1213
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1214
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1215
+ * @returns {string} A string representing the branch.
1216
+ */
1217
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1218
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).branch;
1219
+ }
1220
+ /**
1221
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1222
+ *
1223
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1224
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1225
+ * @returns {string} A string representing the document.
1226
+ */
1227
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1228
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).document;
1229
+ }
1230
+ /**
1231
+ * Parse the chunk from ProjectLocationCollectionDataStoreBranchDocumentChunk resource.
1232
+ *
1233
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentChunkName
1234
+ * A fully-qualified path representing project_location_collection_data_store_branch_document_chunk resource.
1235
+ * @returns {string} A string representing the chunk.
1236
+ */
1237
+ matchChunkFromProjectLocationCollectionDataStoreBranchDocumentChunkName(projectLocationCollectionDataStoreBranchDocumentChunkName) {
1238
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentChunkName).chunk;
1239
+ }
1094
1240
  /**
1095
1241
  * Return a fully-qualified projectLocationCollectionDataStoreControl resource name string.
1096
1242
  *
@@ -2240,6 +2386,87 @@ class ConversationalSearchServiceClient {
2240
2386
  matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
2241
2387
  return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
2242
2388
  }
2389
+ /**
2390
+ * Return a fully-qualified projectLocationDataStoreBranchDocumentChunk resource name string.
2391
+ *
2392
+ * @param {string} project
2393
+ * @param {string} location
2394
+ * @param {string} data_store
2395
+ * @param {string} branch
2396
+ * @param {string} document
2397
+ * @param {string} chunk
2398
+ * @returns {string} Resource name string.
2399
+ */
2400
+ projectLocationDataStoreBranchDocumentChunkPath(project, location, dataStore, branch, document, chunk) {
2401
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.render({
2402
+ project: project,
2403
+ location: location,
2404
+ data_store: dataStore,
2405
+ branch: branch,
2406
+ document: document,
2407
+ chunk: chunk,
2408
+ });
2409
+ }
2410
+ /**
2411
+ * Parse the project from ProjectLocationDataStoreBranchDocumentChunk resource.
2412
+ *
2413
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2414
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2415
+ * @returns {string} A string representing the project.
2416
+ */
2417
+ matchProjectFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2418
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).project;
2419
+ }
2420
+ /**
2421
+ * Parse the location from ProjectLocationDataStoreBranchDocumentChunk resource.
2422
+ *
2423
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2424
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2425
+ * @returns {string} A string representing the location.
2426
+ */
2427
+ matchLocationFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2428
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).location;
2429
+ }
2430
+ /**
2431
+ * Parse the data_store from ProjectLocationDataStoreBranchDocumentChunk resource.
2432
+ *
2433
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2434
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2435
+ * @returns {string} A string representing the data_store.
2436
+ */
2437
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2438
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).data_store;
2439
+ }
2440
+ /**
2441
+ * Parse the branch from ProjectLocationDataStoreBranchDocumentChunk resource.
2442
+ *
2443
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2444
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2445
+ * @returns {string} A string representing the branch.
2446
+ */
2447
+ matchBranchFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2448
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).branch;
2449
+ }
2450
+ /**
2451
+ * Parse the document from ProjectLocationDataStoreBranchDocumentChunk resource.
2452
+ *
2453
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2454
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2455
+ * @returns {string} A string representing the document.
2456
+ */
2457
+ matchDocumentFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2458
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).document;
2459
+ }
2460
+ /**
2461
+ * Parse the chunk from ProjectLocationDataStoreBranchDocumentChunk resource.
2462
+ *
2463
+ * @param {string} projectLocationDataStoreBranchDocumentChunkName
2464
+ * A fully-qualified path representing project_location_data_store_branch_document_chunk resource.
2465
+ * @returns {string} A string representing the chunk.
2466
+ */
2467
+ matchChunkFromProjectLocationDataStoreBranchDocumentChunkName(projectLocationDataStoreBranchDocumentChunkName) {
2468
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentChunkPathTemplate.match(projectLocationDataStoreBranchDocumentChunkName).chunk;
2469
+ }
2243
2470
  /**
2244
2471
  * Return a fully-qualified projectLocationDataStoreControl resource name string.
2245
2472
  *
@@ -2798,6 +3025,112 @@ class ConversationalSearchServiceClient {
2798
3025
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
2799
3026
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
2800
3027
  }
3028
+ /**
3029
+ * Return a fully-qualified sampleQuery resource name string.
3030
+ *
3031
+ * @param {string} project
3032
+ * @param {string} location
3033
+ * @param {string} sample_query_set
3034
+ * @param {string} sample_query
3035
+ * @returns {string} Resource name string.
3036
+ */
3037
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
3038
+ return this.pathTemplates.sampleQueryPathTemplate.render({
3039
+ project: project,
3040
+ location: location,
3041
+ sample_query_set: sampleQuerySet,
3042
+ sample_query: sampleQuery,
3043
+ });
3044
+ }
3045
+ /**
3046
+ * Parse the project from SampleQuery resource.
3047
+ *
3048
+ * @param {string} sampleQueryName
3049
+ * A fully-qualified path representing SampleQuery resource.
3050
+ * @returns {string} A string representing the project.
3051
+ */
3052
+ matchProjectFromSampleQueryName(sampleQueryName) {
3053
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3054
+ .project;
3055
+ }
3056
+ /**
3057
+ * Parse the location from SampleQuery resource.
3058
+ *
3059
+ * @param {string} sampleQueryName
3060
+ * A fully-qualified path representing SampleQuery resource.
3061
+ * @returns {string} A string representing the location.
3062
+ */
3063
+ matchLocationFromSampleQueryName(sampleQueryName) {
3064
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3065
+ .location;
3066
+ }
3067
+ /**
3068
+ * Parse the sample_query_set from SampleQuery resource.
3069
+ *
3070
+ * @param {string} sampleQueryName
3071
+ * A fully-qualified path representing SampleQuery resource.
3072
+ * @returns {string} A string representing the sample_query_set.
3073
+ */
3074
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
3075
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3076
+ .sample_query_set;
3077
+ }
3078
+ /**
3079
+ * Parse the sample_query from SampleQuery resource.
3080
+ *
3081
+ * @param {string} sampleQueryName
3082
+ * A fully-qualified path representing SampleQuery resource.
3083
+ * @returns {string} A string representing the sample_query.
3084
+ */
3085
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
3086
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3087
+ .sample_query;
3088
+ }
3089
+ /**
3090
+ * Return a fully-qualified sampleQuerySet resource name string.
3091
+ *
3092
+ * @param {string} project
3093
+ * @param {string} location
3094
+ * @param {string} sample_query_set
3095
+ * @returns {string} Resource name string.
3096
+ */
3097
+ sampleQuerySetPath(project, location, sampleQuerySet) {
3098
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
3099
+ project: project,
3100
+ location: location,
3101
+ sample_query_set: sampleQuerySet,
3102
+ });
3103
+ }
3104
+ /**
3105
+ * Parse the project from SampleQuerySet resource.
3106
+ *
3107
+ * @param {string} sampleQuerySetName
3108
+ * A fully-qualified path representing SampleQuerySet resource.
3109
+ * @returns {string} A string representing the project.
3110
+ */
3111
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
3112
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
3113
+ }
3114
+ /**
3115
+ * Parse the location from SampleQuerySet resource.
3116
+ *
3117
+ * @param {string} sampleQuerySetName
3118
+ * A fully-qualified path representing SampleQuerySet resource.
3119
+ * @returns {string} A string representing the location.
3120
+ */
3121
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
3122
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
3123
+ }
3124
+ /**
3125
+ * Parse the sample_query_set from SampleQuerySet resource.
3126
+ *
3127
+ * @param {string} sampleQuerySetName
3128
+ * A fully-qualified path representing SampleQuerySet resource.
3129
+ * @returns {string} A string representing the sample_query_set.
3130
+ */
3131
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
3132
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
3133
+ }
2801
3134
  /**
2802
3135
  * Terminate the gRPC channel and close the client.
2803
3136
  *