@google-cloud/discoveryengine 1.9.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 (160) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/README.md +32 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/answer.proto +13 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/chunk.proto +119 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/common.proto +0 -5
  6. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +31 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +38 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +35 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  10. package/build/protos/google/cloud/discoveryengine/v1/document_processing_config.proto +37 -2
  11. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +108 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +200 -4
  14. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +3 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation.proto +232 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/evaluation_service.proto +252 -0
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +83 -0
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query.proto +86 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_service.proto +264 -0
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set.proto +64 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/sample_query_set_service.proto +258 -0
  22. package/build/protos/google/cloud/discoveryengine/v1beta/chunk.proto +119 -0
  23. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +0 -5
  24. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +10 -2
  25. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  26. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +37 -2
  27. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation.proto +231 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/evaluation_service.proto +252 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +83 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query.proto +86 -0
  31. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_service.proto +264 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set.proto +64 -0
  33. package/build/protos/google/cloud/discoveryengine/v1beta/sample_query_set_service.proto +256 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +67 -8
  35. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +11 -5
  36. package/build/protos/protos.d.ts +31310 -20211
  37. package/build/protos/protos.js +86710 -60571
  38. package/build/protos/protos.json +7720 -5011
  39. package/build/src/v1/completion_service_client.d.ts +220 -0
  40. package/build/src/v1/completion_service_client.js +260 -0
  41. package/build/src/v1/completion_service_client_config.json +10 -0
  42. package/build/src/v1/control_service_client.d.ts +129 -1
  43. package/build/src/v1/control_service_client.js +176 -0
  44. package/build/src/v1/conversational_search_service_client.d.ts +147 -1
  45. package/build/src/v1/conversational_search_service_client.js +176 -0
  46. package/build/src/v1/data_store_service_client.d.ts +129 -1
  47. package/build/src/v1/data_store_service_client.js +176 -0
  48. package/build/src/v1/document_service_client.d.ts +131 -1
  49. package/build/src/v1/document_service_client.js +176 -0
  50. package/build/src/v1/engine_service_client.d.ts +129 -1
  51. package/build/src/v1/engine_service_client.js +176 -0
  52. package/build/src/v1/grounded_generation_service_client.d.ts +129 -0
  53. package/build/src/v1/grounded_generation_service_client.js +176 -0
  54. package/build/src/v1/project_service_client.d.ts +129 -0
  55. package/build/src/v1/project_service_client.js +176 -0
  56. package/build/src/v1/rank_service_client.d.ts +129 -0
  57. package/build/src/v1/rank_service_client.js +176 -0
  58. package/build/src/v1/recommendation_service_client.d.ts +129 -0
  59. package/build/src/v1/recommendation_service_client.js +176 -0
  60. package/build/src/v1/schema_service_client.d.ts +129 -1
  61. package/build/src/v1/schema_service_client.js +176 -0
  62. package/build/src/v1/search_service_client.d.ts +252 -1
  63. package/build/src/v1/search_service_client.js +258 -0
  64. package/build/src/v1/site_search_engine_service_client.d.ts +129 -1
  65. package/build/src/v1/site_search_engine_service_client.js +176 -0
  66. package/build/src/v1/user_event_service_client.d.ts +129 -0
  67. package/build/src/v1/user_event_service_client.js +176 -0
  68. package/build/src/v1alpha/acl_config_service_client.d.ts +108 -0
  69. package/build/src/v1alpha/acl_config_service_client.js +157 -0
  70. package/build/src/v1alpha/chunk_service_client.d.ts +108 -1
  71. package/build/src/v1alpha/chunk_service_client.js +157 -0
  72. package/build/src/v1alpha/completion_service_client.d.ts +108 -0
  73. package/build/src/v1alpha/completion_service_client.js +157 -0
  74. package/build/src/v1alpha/control_service_client.d.ts +108 -1
  75. package/build/src/v1alpha/control_service_client.js +157 -0
  76. package/build/src/v1alpha/conversational_search_service_client.d.ts +108 -1
  77. package/build/src/v1alpha/conversational_search_service_client.js +157 -0
  78. package/build/src/v1alpha/data_store_service_client.d.ts +108 -1
  79. package/build/src/v1alpha/data_store_service_client.js +157 -0
  80. package/build/src/v1alpha/document_service_client.d.ts +108 -1
  81. package/build/src/v1alpha/document_service_client.js +157 -0
  82. package/build/src/v1alpha/engine_service_client.d.ts +108 -1
  83. package/build/src/v1alpha/engine_service_client.js +157 -0
  84. package/build/src/v1alpha/estimate_billing_service_client.d.ts +108 -0
  85. package/build/src/v1alpha/estimate_billing_service_client.js +157 -0
  86. package/build/src/v1alpha/evaluation_service_client.d.ts +2349 -0
  87. package/build/src/v1alpha/evaluation_service_client.js +3288 -0
  88. package/build/src/v1alpha/evaluation_service_client_config.json +58 -0
  89. package/build/src/v1alpha/grounded_generation_service_client.d.ts +108 -0
  90. package/build/src/v1alpha/grounded_generation_service_client.js +157 -0
  91. package/build/src/v1alpha/index.d.ts +3 -0
  92. package/build/src/v1alpha/index.js +7 -1
  93. package/build/src/v1alpha/project_service_client.d.ts +108 -0
  94. package/build/src/v1alpha/project_service_client.js +157 -0
  95. package/build/src/v1alpha/rank_service_client.d.ts +108 -0
  96. package/build/src/v1alpha/rank_service_client.js +157 -0
  97. package/build/src/v1alpha/recommendation_service_client.d.ts +108 -0
  98. package/build/src/v1alpha/recommendation_service_client.js +157 -0
  99. package/build/src/v1alpha/sample_query_service_client.d.ts +2317 -0
  100. package/build/src/v1alpha/sample_query_service_client.js +3186 -0
  101. package/build/src/v1alpha/sample_query_service_client_config.json +68 -0
  102. package/build/src/v1alpha/sample_query_set_service_client.d.ts +2176 -0
  103. package/build/src/v1alpha/sample_query_set_service_client.js +2931 -0
  104. package/build/src/v1alpha/sample_query_set_service_client_config.json +63 -0
  105. package/build/src/v1alpha/schema_service_client.d.ts +108 -1
  106. package/build/src/v1alpha/schema_service_client.js +157 -0
  107. package/build/src/v1alpha/search_service_client.d.ts +108 -1
  108. package/build/src/v1alpha/search_service_client.js +157 -0
  109. package/build/src/v1alpha/search_tuning_service_client.d.ts +108 -0
  110. package/build/src/v1alpha/search_tuning_service_client.js +157 -0
  111. package/build/src/v1alpha/serving_config_service_client.d.ts +108 -1
  112. package/build/src/v1alpha/serving_config_service_client.js +157 -0
  113. package/build/src/v1alpha/site_search_engine_service_client.d.ts +108 -1
  114. package/build/src/v1alpha/site_search_engine_service_client.js +157 -0
  115. package/build/src/v1alpha/user_event_service_client.d.ts +108 -0
  116. package/build/src/v1alpha/user_event_service_client.js +157 -0
  117. package/build/src/v1beta/completion_service_client.d.ts +237 -0
  118. package/build/src/v1beta/completion_service_client.js +339 -0
  119. package/build/src/v1beta/control_service_client.d.ts +237 -1
  120. package/build/src/v1beta/control_service_client.js +333 -0
  121. package/build/src/v1beta/conversational_search_service_client.d.ts +237 -1
  122. package/build/src/v1beta/conversational_search_service_client.js +333 -0
  123. package/build/src/v1beta/data_store_service_client.d.ts +237 -1
  124. package/build/src/v1beta/data_store_service_client.js +339 -0
  125. package/build/src/v1beta/document_service_client.d.ts +237 -1
  126. package/build/src/v1beta/document_service_client.js +339 -0
  127. package/build/src/v1beta/engine_service_client.d.ts +237 -1
  128. package/build/src/v1beta/engine_service_client.js +339 -0
  129. package/build/src/v1beta/evaluation_service_client.d.ts +2325 -0
  130. package/build/src/v1beta/evaluation_service_client.js +3252 -0
  131. package/build/src/v1beta/evaluation_service_client_config.json +58 -0
  132. package/build/src/v1beta/grounded_generation_service_client.d.ts +237 -0
  133. package/build/src/v1beta/grounded_generation_service_client.js +333 -0
  134. package/build/src/v1beta/index.d.ts +3 -0
  135. package/build/src/v1beta/index.js +7 -1
  136. package/build/src/v1beta/project_service_client.d.ts +237 -0
  137. package/build/src/v1beta/project_service_client.js +339 -0
  138. package/build/src/v1beta/rank_service_client.d.ts +237 -0
  139. package/build/src/v1beta/rank_service_client.js +333 -0
  140. package/build/src/v1beta/recommendation_service_client.d.ts +237 -0
  141. package/build/src/v1beta/recommendation_service_client.js +333 -0
  142. package/build/src/v1beta/sample_query_service_client.d.ts +2293 -0
  143. package/build/src/v1beta/sample_query_service_client.js +3150 -0
  144. package/build/src/v1beta/sample_query_service_client_config.json +68 -0
  145. package/build/src/v1beta/sample_query_set_service_client.d.ts +2150 -0
  146. package/build/src/v1beta/sample_query_set_service_client.js +2895 -0
  147. package/build/src/v1beta/sample_query_set_service_client_config.json +63 -0
  148. package/build/src/v1beta/schema_service_client.d.ts +237 -1
  149. package/build/src/v1beta/schema_service_client.js +339 -0
  150. package/build/src/v1beta/search_service_client.d.ts +267 -13
  151. package/build/src/v1beta/search_service_client.js +353 -8
  152. package/build/src/v1beta/search_tuning_service_client.d.ts +237 -0
  153. package/build/src/v1beta/search_tuning_service_client.js +339 -0
  154. package/build/src/v1beta/serving_config_service_client.d.ts +237 -1
  155. package/build/src/v1beta/serving_config_service_client.js +333 -0
  156. package/build/src/v1beta/site_search_engine_service_client.d.ts +237 -1
  157. package/build/src/v1beta/site_search_engine_service_client.js +339 -0
  158. package/build/src/v1beta/user_event_service_client.d.ts +237 -0
  159. package/build/src/v1beta/user_event_service_client.js +339 -0
  160. package/package.json +1 -1
@@ -0,0 +1,63 @@
1
+ {
2
+ "interfaces": {
3
+ "google.cloud.discoveryengine.v1alpha.SampleQuerySetService": {
4
+ "retry_codes": {
5
+ "non_idempotent": [],
6
+ "idempotent": [
7
+ "DEADLINE_EXCEEDED",
8
+ "UNAVAILABLE"
9
+ ],
10
+ "unavailable": [
11
+ "UNAVAILABLE"
12
+ ]
13
+ },
14
+ "retry_params": {
15
+ "default": {
16
+ "initial_retry_delay_millis": 100,
17
+ "retry_delay_multiplier": 1.3,
18
+ "max_retry_delay_millis": 60000,
19
+ "initial_rpc_timeout_millis": 60000,
20
+ "rpc_timeout_multiplier": 1,
21
+ "max_rpc_timeout_millis": 60000,
22
+ "total_timeout_millis": 600000
23
+ },
24
+ "ce5b960a6ed052e690863808e4f0deff3dc7d49f": {
25
+ "initial_retry_delay_millis": 1000,
26
+ "retry_delay_multiplier": 1.3,
27
+ "max_retry_delay_millis": 10000,
28
+ "initial_rpc_timeout_millis": 60000,
29
+ "rpc_timeout_multiplier": 1,
30
+ "max_rpc_timeout_millis": 60000,
31
+ "total_timeout_millis": 600000
32
+ }
33
+ },
34
+ "methods": {
35
+ "GetSampleQuerySet": {
36
+ "timeout_millis": 30000,
37
+ "retry_codes_name": "unavailable",
38
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
39
+ },
40
+ "ListSampleQuerySets": {
41
+ "timeout_millis": 30000,
42
+ "retry_codes_name": "unavailable",
43
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
44
+ },
45
+ "CreateSampleQuerySet": {
46
+ "timeout_millis": 30000,
47
+ "retry_codes_name": "unavailable",
48
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
49
+ },
50
+ "UpdateSampleQuerySet": {
51
+ "timeout_millis": 30000,
52
+ "retry_codes_name": "unavailable",
53
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
54
+ },
55
+ "DeleteSampleQuerySet": {
56
+ "timeout_millis": 30000,
57
+ "retry_codes_name": "unavailable",
58
+ "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
59
+ }
60
+ }
61
+ }
62
+ }
63
+ }
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  import type * as gax from 'google-gax';
3
2
  import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
4
3
  import { Transform } from 'stream';
@@ -628,6 +627,39 @@ export declare class SchemaServiceClient {
628
627
  * @returns {string} A string representing the engine.
629
628
  */
630
629
  matchEngineFromEngineName(engineName: string): string | number;
630
+ /**
631
+ * Return a fully-qualified evaluation resource name string.
632
+ *
633
+ * @param {string} project
634
+ * @param {string} location
635
+ * @param {string} evaluation
636
+ * @returns {string} Resource name string.
637
+ */
638
+ evaluationPath(project: string, location: string, evaluation: string): string;
639
+ /**
640
+ * Parse the project from Evaluation resource.
641
+ *
642
+ * @param {string} evaluationName
643
+ * A fully-qualified path representing Evaluation resource.
644
+ * @returns {string} A string representing the project.
645
+ */
646
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
647
+ /**
648
+ * Parse the location from Evaluation resource.
649
+ *
650
+ * @param {string} evaluationName
651
+ * A fully-qualified path representing Evaluation resource.
652
+ * @returns {string} A string representing the location.
653
+ */
654
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
655
+ /**
656
+ * Parse the evaluation from Evaluation resource.
657
+ *
658
+ * @param {string} evaluationName
659
+ * A fully-qualified path representing Evaluation resource.
660
+ * @returns {string} A string representing the evaluation.
661
+ */
662
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
631
663
  /**
632
664
  * Return a fully-qualified project resource name string.
633
665
  *
@@ -2134,6 +2166,81 @@ export declare class SchemaServiceClient {
2134
2166
  * @returns {string} A string representing the target_site.
2135
2167
  */
2136
2168
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2169
+ /**
2170
+ * Return a fully-qualified sampleQuery resource name string.
2171
+ *
2172
+ * @param {string} project
2173
+ * @param {string} location
2174
+ * @param {string} sample_query_set
2175
+ * @param {string} sample_query
2176
+ * @returns {string} Resource name string.
2177
+ */
2178
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2179
+ /**
2180
+ * Parse the project from SampleQuery resource.
2181
+ *
2182
+ * @param {string} sampleQueryName
2183
+ * A fully-qualified path representing SampleQuery resource.
2184
+ * @returns {string} A string representing the project.
2185
+ */
2186
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2187
+ /**
2188
+ * Parse the location from SampleQuery resource.
2189
+ *
2190
+ * @param {string} sampleQueryName
2191
+ * A fully-qualified path representing SampleQuery resource.
2192
+ * @returns {string} A string representing the location.
2193
+ */
2194
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2195
+ /**
2196
+ * Parse the sample_query_set from SampleQuery resource.
2197
+ *
2198
+ * @param {string} sampleQueryName
2199
+ * A fully-qualified path representing SampleQuery resource.
2200
+ * @returns {string} A string representing the sample_query_set.
2201
+ */
2202
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2203
+ /**
2204
+ * Parse the sample_query from SampleQuery resource.
2205
+ *
2206
+ * @param {string} sampleQueryName
2207
+ * A fully-qualified path representing SampleQuery resource.
2208
+ * @returns {string} A string representing the sample_query.
2209
+ */
2210
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2211
+ /**
2212
+ * Return a fully-qualified sampleQuerySet resource name string.
2213
+ *
2214
+ * @param {string} project
2215
+ * @param {string} location
2216
+ * @param {string} sample_query_set
2217
+ * @returns {string} Resource name string.
2218
+ */
2219
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2220
+ /**
2221
+ * Parse the project from SampleQuerySet resource.
2222
+ *
2223
+ * @param {string} sampleQuerySetName
2224
+ * A fully-qualified path representing SampleQuerySet resource.
2225
+ * @returns {string} A string representing the project.
2226
+ */
2227
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2228
+ /**
2229
+ * Parse the location from SampleQuerySet resource.
2230
+ *
2231
+ * @param {string} sampleQuerySetName
2232
+ * A fully-qualified path representing SampleQuerySet resource.
2233
+ * @returns {string} A string representing the location.
2234
+ */
2235
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2236
+ /**
2237
+ * Parse the sample_query_set from SampleQuerySet resource.
2238
+ *
2239
+ * @param {string} sampleQuerySetName
2240
+ * A fully-qualified path representing SampleQuerySet resource.
2241
+ * @returns {string} A string representing the sample_query_set.
2242
+ */
2243
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2137
2244
  /**
2138
2245
  * Terminate the gRPC channel and close the client.
2139
2246
  *
@@ -151,6 +151,7 @@ class SchemaServiceClient {
151
151
  this.pathTemplates = {
152
152
  aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
153
153
  enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
154
+ evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
154
155
  projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
155
156
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
156
157
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
@@ -183,6 +184,8 @@ class SchemaServiceClient {
183
184
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
184
185
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
185
186
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
187
+ sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
188
+ sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
186
189
  };
187
190
  // Some of the methods on this service return "paged" results,
188
191
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -972,6 +975,54 @@ class SchemaServiceClient {
972
975
  matchEngineFromEngineName(engineName) {
973
976
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
974
977
  }
978
+ /**
979
+ * Return a fully-qualified evaluation resource name string.
980
+ *
981
+ * @param {string} project
982
+ * @param {string} location
983
+ * @param {string} evaluation
984
+ * @returns {string} Resource name string.
985
+ */
986
+ evaluationPath(project, location, evaluation) {
987
+ return this.pathTemplates.evaluationPathTemplate.render({
988
+ project: project,
989
+ location: location,
990
+ evaluation: evaluation,
991
+ });
992
+ }
993
+ /**
994
+ * Parse the project from Evaluation resource.
995
+ *
996
+ * @param {string} evaluationName
997
+ * A fully-qualified path representing Evaluation resource.
998
+ * @returns {string} A string representing the project.
999
+ */
1000
+ matchProjectFromEvaluationName(evaluationName) {
1001
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1002
+ .project;
1003
+ }
1004
+ /**
1005
+ * Parse the location from Evaluation resource.
1006
+ *
1007
+ * @param {string} evaluationName
1008
+ * A fully-qualified path representing Evaluation resource.
1009
+ * @returns {string} A string representing the location.
1010
+ */
1011
+ matchLocationFromEvaluationName(evaluationName) {
1012
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1013
+ .location;
1014
+ }
1015
+ /**
1016
+ * Parse the evaluation from Evaluation resource.
1017
+ *
1018
+ * @param {string} evaluationName
1019
+ * A fully-qualified path representing Evaluation resource.
1020
+ * @returns {string} A string representing the evaluation.
1021
+ */
1022
+ matchEvaluationFromEvaluationName(evaluationName) {
1023
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
1024
+ .evaluation;
1025
+ }
975
1026
  /**
976
1027
  * Return a fully-qualified project resource name string.
977
1028
  *
@@ -3012,6 +3063,112 @@ class SchemaServiceClient {
3012
3063
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
3013
3064
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
3014
3065
  }
3066
+ /**
3067
+ * Return a fully-qualified sampleQuery resource name string.
3068
+ *
3069
+ * @param {string} project
3070
+ * @param {string} location
3071
+ * @param {string} sample_query_set
3072
+ * @param {string} sample_query
3073
+ * @returns {string} Resource name string.
3074
+ */
3075
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
3076
+ return this.pathTemplates.sampleQueryPathTemplate.render({
3077
+ project: project,
3078
+ location: location,
3079
+ sample_query_set: sampleQuerySet,
3080
+ sample_query: sampleQuery,
3081
+ });
3082
+ }
3083
+ /**
3084
+ * Parse the project from SampleQuery resource.
3085
+ *
3086
+ * @param {string} sampleQueryName
3087
+ * A fully-qualified path representing SampleQuery resource.
3088
+ * @returns {string} A string representing the project.
3089
+ */
3090
+ matchProjectFromSampleQueryName(sampleQueryName) {
3091
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3092
+ .project;
3093
+ }
3094
+ /**
3095
+ * Parse the location from SampleQuery resource.
3096
+ *
3097
+ * @param {string} sampleQueryName
3098
+ * A fully-qualified path representing SampleQuery resource.
3099
+ * @returns {string} A string representing the location.
3100
+ */
3101
+ matchLocationFromSampleQueryName(sampleQueryName) {
3102
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3103
+ .location;
3104
+ }
3105
+ /**
3106
+ * Parse the sample_query_set from SampleQuery resource.
3107
+ *
3108
+ * @param {string} sampleQueryName
3109
+ * A fully-qualified path representing SampleQuery resource.
3110
+ * @returns {string} A string representing the sample_query_set.
3111
+ */
3112
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
3113
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3114
+ .sample_query_set;
3115
+ }
3116
+ /**
3117
+ * Parse the sample_query from SampleQuery resource.
3118
+ *
3119
+ * @param {string} sampleQueryName
3120
+ * A fully-qualified path representing SampleQuery resource.
3121
+ * @returns {string} A string representing the sample_query.
3122
+ */
3123
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
3124
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3125
+ .sample_query;
3126
+ }
3127
+ /**
3128
+ * Return a fully-qualified sampleQuerySet resource name string.
3129
+ *
3130
+ * @param {string} project
3131
+ * @param {string} location
3132
+ * @param {string} sample_query_set
3133
+ * @returns {string} Resource name string.
3134
+ */
3135
+ sampleQuerySetPath(project, location, sampleQuerySet) {
3136
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
3137
+ project: project,
3138
+ location: location,
3139
+ sample_query_set: sampleQuerySet,
3140
+ });
3141
+ }
3142
+ /**
3143
+ * Parse the project from SampleQuerySet resource.
3144
+ *
3145
+ * @param {string} sampleQuerySetName
3146
+ * A fully-qualified path representing SampleQuerySet resource.
3147
+ * @returns {string} A string representing the project.
3148
+ */
3149
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
3150
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
3151
+ }
3152
+ /**
3153
+ * Parse the location from SampleQuerySet resource.
3154
+ *
3155
+ * @param {string} sampleQuerySetName
3156
+ * A fully-qualified path representing SampleQuerySet resource.
3157
+ * @returns {string} A string representing the location.
3158
+ */
3159
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
3160
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
3161
+ }
3162
+ /**
3163
+ * Parse the sample_query_set from SampleQuerySet resource.
3164
+ *
3165
+ * @param {string} sampleQuerySetName
3166
+ * A fully-qualified path representing SampleQuerySet resource.
3167
+ * @returns {string} A string representing the sample_query_set.
3168
+ */
3169
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
3170
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
3171
+ }
3015
3172
  /**
3016
3173
  * Terminate the gRPC channel and close the client.
3017
3174
  *
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  import type * as gax from 'google-gax';
3
2
  import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
4
3
  import { Transform } from 'stream';
@@ -886,6 +885,39 @@ export declare class SearchServiceClient {
886
885
  * @returns {string} A string representing the engine.
887
886
  */
888
887
  matchEngineFromEngineName(engineName: string): string | number;
888
+ /**
889
+ * Return a fully-qualified evaluation resource name string.
890
+ *
891
+ * @param {string} project
892
+ * @param {string} location
893
+ * @param {string} evaluation
894
+ * @returns {string} Resource name string.
895
+ */
896
+ evaluationPath(project: string, location: string, evaluation: string): string;
897
+ /**
898
+ * Parse the project from Evaluation resource.
899
+ *
900
+ * @param {string} evaluationName
901
+ * A fully-qualified path representing Evaluation resource.
902
+ * @returns {string} A string representing the project.
903
+ */
904
+ matchProjectFromEvaluationName(evaluationName: string): string | number;
905
+ /**
906
+ * Parse the location from Evaluation resource.
907
+ *
908
+ * @param {string} evaluationName
909
+ * A fully-qualified path representing Evaluation resource.
910
+ * @returns {string} A string representing the location.
911
+ */
912
+ matchLocationFromEvaluationName(evaluationName: string): string | number;
913
+ /**
914
+ * Parse the evaluation from Evaluation resource.
915
+ *
916
+ * @param {string} evaluationName
917
+ * A fully-qualified path representing Evaluation resource.
918
+ * @returns {string} A string representing the evaluation.
919
+ */
920
+ matchEvaluationFromEvaluationName(evaluationName: string): string | number;
889
921
  /**
890
922
  * Return a fully-qualified project resource name string.
891
923
  *
@@ -2485,6 +2517,81 @@ export declare class SearchServiceClient {
2485
2517
  * @returns {string} A string representing the target_site.
2486
2518
  */
2487
2519
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
2520
+ /**
2521
+ * Return a fully-qualified sampleQuery resource name string.
2522
+ *
2523
+ * @param {string} project
2524
+ * @param {string} location
2525
+ * @param {string} sample_query_set
2526
+ * @param {string} sample_query
2527
+ * @returns {string} Resource name string.
2528
+ */
2529
+ sampleQueryPath(project: string, location: string, sampleQuerySet: string, sampleQuery: string): string;
2530
+ /**
2531
+ * Parse the project from SampleQuery resource.
2532
+ *
2533
+ * @param {string} sampleQueryName
2534
+ * A fully-qualified path representing SampleQuery resource.
2535
+ * @returns {string} A string representing the project.
2536
+ */
2537
+ matchProjectFromSampleQueryName(sampleQueryName: string): string | number;
2538
+ /**
2539
+ * Parse the location from SampleQuery resource.
2540
+ *
2541
+ * @param {string} sampleQueryName
2542
+ * A fully-qualified path representing SampleQuery resource.
2543
+ * @returns {string} A string representing the location.
2544
+ */
2545
+ matchLocationFromSampleQueryName(sampleQueryName: string): string | number;
2546
+ /**
2547
+ * Parse the sample_query_set from SampleQuery resource.
2548
+ *
2549
+ * @param {string} sampleQueryName
2550
+ * A fully-qualified path representing SampleQuery resource.
2551
+ * @returns {string} A string representing the sample_query_set.
2552
+ */
2553
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName: string): string | number;
2554
+ /**
2555
+ * Parse the sample_query from SampleQuery resource.
2556
+ *
2557
+ * @param {string} sampleQueryName
2558
+ * A fully-qualified path representing SampleQuery resource.
2559
+ * @returns {string} A string representing the sample_query.
2560
+ */
2561
+ matchSampleQueryFromSampleQueryName(sampleQueryName: string): string | number;
2562
+ /**
2563
+ * Return a fully-qualified sampleQuerySet resource name string.
2564
+ *
2565
+ * @param {string} project
2566
+ * @param {string} location
2567
+ * @param {string} sample_query_set
2568
+ * @returns {string} Resource name string.
2569
+ */
2570
+ sampleQuerySetPath(project: string, location: string, sampleQuerySet: string): string;
2571
+ /**
2572
+ * Parse the project from SampleQuerySet resource.
2573
+ *
2574
+ * @param {string} sampleQuerySetName
2575
+ * A fully-qualified path representing SampleQuerySet resource.
2576
+ * @returns {string} A string representing the project.
2577
+ */
2578
+ matchProjectFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2579
+ /**
2580
+ * Parse the location from SampleQuerySet resource.
2581
+ *
2582
+ * @param {string} sampleQuerySetName
2583
+ * A fully-qualified path representing SampleQuerySet resource.
2584
+ * @returns {string} A string representing the location.
2585
+ */
2586
+ matchLocationFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2587
+ /**
2588
+ * Parse the sample_query_set from SampleQuerySet resource.
2589
+ *
2590
+ * @param {string} sampleQuerySetName
2591
+ * A fully-qualified path representing SampleQuerySet resource.
2592
+ * @returns {string} A string representing the sample_query_set.
2593
+ */
2594
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName: string): string | number;
2488
2595
  /**
2489
2596
  * Terminate the gRPC channel and close the client.
2490
2597
  *
@@ -151,6 +151,7 @@ class SearchServiceClient {
151
151
  this.pathTemplates = {
152
152
  aclConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/aclConfig'),
153
153
  enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
154
+ evaluationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/evaluations/{evaluation}'),
154
155
  projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
155
156
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
156
157
  projectLocationCollectionDataStoreBranchPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}'),
@@ -185,6 +186,8 @@ class SearchServiceClient {
185
186
  projectLocationDataStoreSessionAnswerPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/sessions/{session}/answers/{answer}'),
186
187
  projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
187
188
  projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
189
+ sampleQueryPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}'),
190
+ sampleQuerySetPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}'),
188
191
  };
189
192
  // Some of the methods on this service return "paged" results,
190
193
  // (e.g. 50 results at a time, with tokens to get subsequent
@@ -933,6 +936,54 @@ class SearchServiceClient {
933
936
  matchEngineFromEngineName(engineName) {
934
937
  return this.pathTemplates.enginePathTemplate.match(engineName).engine;
935
938
  }
939
+ /**
940
+ * Return a fully-qualified evaluation resource name string.
941
+ *
942
+ * @param {string} project
943
+ * @param {string} location
944
+ * @param {string} evaluation
945
+ * @returns {string} Resource name string.
946
+ */
947
+ evaluationPath(project, location, evaluation) {
948
+ return this.pathTemplates.evaluationPathTemplate.render({
949
+ project: project,
950
+ location: location,
951
+ evaluation: evaluation,
952
+ });
953
+ }
954
+ /**
955
+ * Parse the project from Evaluation resource.
956
+ *
957
+ * @param {string} evaluationName
958
+ * A fully-qualified path representing Evaluation resource.
959
+ * @returns {string} A string representing the project.
960
+ */
961
+ matchProjectFromEvaluationName(evaluationName) {
962
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
963
+ .project;
964
+ }
965
+ /**
966
+ * Parse the location from Evaluation resource.
967
+ *
968
+ * @param {string} evaluationName
969
+ * A fully-qualified path representing Evaluation resource.
970
+ * @returns {string} A string representing the location.
971
+ */
972
+ matchLocationFromEvaluationName(evaluationName) {
973
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
974
+ .location;
975
+ }
976
+ /**
977
+ * Parse the evaluation from Evaluation resource.
978
+ *
979
+ * @param {string} evaluationName
980
+ * A fully-qualified path representing Evaluation resource.
981
+ * @returns {string} A string representing the evaluation.
982
+ */
983
+ matchEvaluationFromEvaluationName(evaluationName) {
984
+ return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
985
+ .evaluation;
986
+ }
936
987
  /**
937
988
  * Return a fully-qualified project resource name string.
938
989
  *
@@ -3099,6 +3150,112 @@ class SearchServiceClient {
3099
3150
  matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
3100
3151
  return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
3101
3152
  }
3153
+ /**
3154
+ * Return a fully-qualified sampleQuery resource name string.
3155
+ *
3156
+ * @param {string} project
3157
+ * @param {string} location
3158
+ * @param {string} sample_query_set
3159
+ * @param {string} sample_query
3160
+ * @returns {string} Resource name string.
3161
+ */
3162
+ sampleQueryPath(project, location, sampleQuerySet, sampleQuery) {
3163
+ return this.pathTemplates.sampleQueryPathTemplate.render({
3164
+ project: project,
3165
+ location: location,
3166
+ sample_query_set: sampleQuerySet,
3167
+ sample_query: sampleQuery,
3168
+ });
3169
+ }
3170
+ /**
3171
+ * Parse the project from SampleQuery resource.
3172
+ *
3173
+ * @param {string} sampleQueryName
3174
+ * A fully-qualified path representing SampleQuery resource.
3175
+ * @returns {string} A string representing the project.
3176
+ */
3177
+ matchProjectFromSampleQueryName(sampleQueryName) {
3178
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3179
+ .project;
3180
+ }
3181
+ /**
3182
+ * Parse the location from SampleQuery resource.
3183
+ *
3184
+ * @param {string} sampleQueryName
3185
+ * A fully-qualified path representing SampleQuery resource.
3186
+ * @returns {string} A string representing the location.
3187
+ */
3188
+ matchLocationFromSampleQueryName(sampleQueryName) {
3189
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3190
+ .location;
3191
+ }
3192
+ /**
3193
+ * Parse the sample_query_set from SampleQuery resource.
3194
+ *
3195
+ * @param {string} sampleQueryName
3196
+ * A fully-qualified path representing SampleQuery resource.
3197
+ * @returns {string} A string representing the sample_query_set.
3198
+ */
3199
+ matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
3200
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3201
+ .sample_query_set;
3202
+ }
3203
+ /**
3204
+ * Parse the sample_query from SampleQuery resource.
3205
+ *
3206
+ * @param {string} sampleQueryName
3207
+ * A fully-qualified path representing SampleQuery resource.
3208
+ * @returns {string} A string representing the sample_query.
3209
+ */
3210
+ matchSampleQueryFromSampleQueryName(sampleQueryName) {
3211
+ return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
3212
+ .sample_query;
3213
+ }
3214
+ /**
3215
+ * Return a fully-qualified sampleQuerySet resource name string.
3216
+ *
3217
+ * @param {string} project
3218
+ * @param {string} location
3219
+ * @param {string} sample_query_set
3220
+ * @returns {string} Resource name string.
3221
+ */
3222
+ sampleQuerySetPath(project, location, sampleQuerySet) {
3223
+ return this.pathTemplates.sampleQuerySetPathTemplate.render({
3224
+ project: project,
3225
+ location: location,
3226
+ sample_query_set: sampleQuerySet,
3227
+ });
3228
+ }
3229
+ /**
3230
+ * Parse the project from SampleQuerySet resource.
3231
+ *
3232
+ * @param {string} sampleQuerySetName
3233
+ * A fully-qualified path representing SampleQuerySet resource.
3234
+ * @returns {string} A string representing the project.
3235
+ */
3236
+ matchProjectFromSampleQuerySetName(sampleQuerySetName) {
3237
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).project;
3238
+ }
3239
+ /**
3240
+ * Parse the location from SampleQuerySet resource.
3241
+ *
3242
+ * @param {string} sampleQuerySetName
3243
+ * A fully-qualified path representing SampleQuerySet resource.
3244
+ * @returns {string} A string representing the location.
3245
+ */
3246
+ matchLocationFromSampleQuerySetName(sampleQuerySetName) {
3247
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).location;
3248
+ }
3249
+ /**
3250
+ * Parse the sample_query_set from SampleQuerySet resource.
3251
+ *
3252
+ * @param {string} sampleQuerySetName
3253
+ * A fully-qualified path representing SampleQuerySet resource.
3254
+ * @returns {string} A string representing the sample_query_set.
3255
+ */
3256
+ matchSampleQuerySetFromSampleQuerySetName(sampleQuerySetName) {
3257
+ return this.pathTemplates.sampleQuerySetPathTemplate.match(sampleQuerySetName).sample_query_set;
3258
+ }
3102
3259
  /**
3103
3260
  * Terminate the gRPC channel and close the client.
3104
3261
  *