@google-cloud/discoveryengine 1.6.0 → 1.7.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 (142) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +24 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +13 -1
  4. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +5 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +17 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/document.proto +9 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +6 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +2 -2
  9. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +284 -22
  10. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +3 -0
  11. package/build/protos/google/cloud/discoveryengine/v1/recommendation_service.proto +228 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +125 -21
  13. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +16 -11
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/answer.proto +328 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/chunk.proto +41 -1
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +21 -1
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +574 -0
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +19 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/document_processing_config.proto +3 -6
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +64 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +2 -2
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/grounded_generation_service.proto +120 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/grounding.proto +55 -0
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +283 -24
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/project.proto +102 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/project_service.proto +171 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +21 -0
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +158 -24
  29. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +9 -3
  30. package/build/protos/google/cloud/discoveryengine/v1alpha/serving_config_service.proto +2 -1
  31. package/build/protos/google/cloud/discoveryengine/v1alpha/session.proto +94 -0
  32. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +1 -1
  33. package/build/protos/google/cloud/discoveryengine/v1beta/answer.proto +328 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +30 -1
  35. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +559 -0
  36. package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto +3 -6
  37. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +6 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +2 -2
  39. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +93 -0
  40. package/build/protos/google/cloud/discoveryengine/v1beta/grounded_generation_service.proto +120 -0
  41. package/build/protos/google/cloud/discoveryengine/v1beta/grounding.proto +55 -0
  42. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +283 -24
  43. package/build/protos/google/cloud/discoveryengine/v1beta/rank_service.proto +115 -0
  44. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +142 -22
  45. package/build/protos/google/cloud/discoveryengine/v1beta/search_tuning_service.proto +7 -1
  46. package/build/protos/google/cloud/discoveryengine/v1beta/session.proto +94 -0
  47. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +1 -1
  48. package/build/protos/protos.d.ts +44799 -26093
  49. package/build/protos/protos.js +120465 -74222
  50. package/build/protos/protos.json +8911 -4556
  51. package/build/src/index.d.ts +4 -1
  52. package/build/src/index.js +4 -1
  53. package/build/src/v1/conversational_search_service_client.d.ts +4 -0
  54. package/build/src/v1/document_service_client.d.ts +47 -19
  55. package/build/src/v1/index.d.ts +1 -0
  56. package/build/src/v1/index.js +3 -1
  57. package/build/src/v1/recommendation_service_client.d.ts +1087 -0
  58. package/build/src/v1/recommendation_service_client.js +1432 -0
  59. package/build/src/v1/recommendation_service_client_config.json +43 -0
  60. package/build/src/v1/search_service_client.d.ts +27 -9
  61. package/build/src/v1/search_service_client.js +18 -6
  62. package/build/src/v1/search_service_client_config.json +5 -5
  63. package/build/src/v1alpha/acl_config_service_client.d.ts +330 -0
  64. package/build/src/v1alpha/acl_config_service_client.js +454 -0
  65. package/build/src/v1alpha/chunk_service_client.d.ts +330 -0
  66. package/build/src/v1alpha/chunk_service_client.js +454 -0
  67. package/build/src/v1alpha/completion_service_client.d.ts +330 -0
  68. package/build/src/v1alpha/completion_service_client.js +457 -0
  69. package/build/src/v1alpha/conversational_search_service_client.d.ts +674 -0
  70. package/build/src/v1alpha/conversational_search_service_client.js +724 -0
  71. package/build/src/v1alpha/conversational_search_service_client_config.json +35 -0
  72. package/build/src/v1alpha/data_store_service_client.d.ts +330 -0
  73. package/build/src/v1alpha/data_store_service_client.js +457 -0
  74. package/build/src/v1alpha/document_service_client.d.ts +410 -21
  75. package/build/src/v1alpha/document_service_client.js +479 -0
  76. package/build/src/v1alpha/document_service_client_config.json +5 -0
  77. package/build/src/v1alpha/engine_service_client.d.ts +330 -0
  78. package/build/src/v1alpha/engine_service_client.js +457 -0
  79. package/build/src/v1alpha/estimate_billing_service_client.d.ts +330 -0
  80. package/build/src/v1alpha/estimate_billing_service_client.js +457 -0
  81. package/build/src/v1alpha/grounded_generation_service_client.d.ts +1574 -0
  82. package/build/src/v1alpha/grounded_generation_service_client.js +2248 -0
  83. package/build/src/v1alpha/grounded_generation_service_client_config.json +43 -0
  84. package/build/src/v1alpha/index.d.ts +3 -1
  85. package/build/src/v1alpha/index.js +7 -3
  86. package/build/src/v1alpha/project_service_client.d.ts +1756 -0
  87. package/build/src/v1alpha/project_service_client.js +2500 -0
  88. package/build/src/v1alpha/project_service_client_config.json +38 -0
  89. package/build/src/v1alpha/rank_service_client.d.ts +330 -0
  90. package/build/src/v1alpha/rank_service_client.js +454 -0
  91. package/build/src/v1alpha/rank_service_client_config.json +15 -2
  92. package/build/src/v1alpha/recommendation_service_client.d.ts +330 -0
  93. package/build/src/v1alpha/recommendation_service_client.js +454 -0
  94. package/build/src/v1alpha/schema_service_client.d.ts +330 -0
  95. package/build/src/v1alpha/schema_service_client.js +457 -0
  96. package/build/src/v1alpha/search_service_client.d.ts +360 -15
  97. package/build/src/v1alpha/search_service_client.js +474 -10
  98. package/build/src/v1alpha/search_service_client_config.json +5 -5
  99. package/build/src/v1alpha/search_tuning_service_client.d.ts +330 -0
  100. package/build/src/v1alpha/search_tuning_service_client.js +457 -0
  101. package/build/src/v1alpha/serving_config_service_client.d.ts +317 -1
  102. package/build/src/v1alpha/serving_config_service_client.js +434 -1
  103. package/build/src/v1alpha/site_search_engine_service_client.d.ts +330 -0
  104. package/build/src/v1alpha/site_search_engine_service_client.js +457 -0
  105. package/build/src/v1alpha/user_event_service_client.d.ts +330 -0
  106. package/build/src/v1alpha/user_event_service_client.js +457 -0
  107. package/build/src/v1beta/completion_service_client.d.ts +315 -0
  108. package/build/src/v1beta/completion_service_client.js +432 -0
  109. package/build/src/v1beta/conversational_search_service_client.d.ts +659 -0
  110. package/build/src/v1beta/conversational_search_service_client.js +702 -0
  111. package/build/src/v1beta/conversational_search_service_client_config.json +35 -0
  112. package/build/src/v1beta/data_store_service_client.d.ts +315 -0
  113. package/build/src/v1beta/data_store_service_client.js +432 -0
  114. package/build/src/v1beta/document_service_client.d.ts +361 -21
  115. package/build/src/v1beta/document_service_client.js +432 -0
  116. package/build/src/v1beta/engine_service_client.d.ts +410 -0
  117. package/build/src/v1beta/engine_service_client.js +518 -0
  118. package/build/src/v1beta/engine_service_client_config.json +12 -0
  119. package/build/src/v1beta/grounded_generation_service_client.d.ts +1406 -0
  120. package/build/src/v1beta/grounded_generation_service_client.js +2014 -0
  121. package/build/src/v1beta/grounded_generation_service_client_config.json +43 -0
  122. package/build/src/v1beta/index.d.ts +2 -0
  123. package/build/src/v1beta/index.js +5 -1
  124. package/build/src/v1beta/rank_service_client.d.ts +1416 -0
  125. package/build/src/v1beta/rank_service_client.js +2015 -0
  126. package/build/src/v1beta/rank_service_client_config.json +43 -0
  127. package/build/src/v1beta/recommendation_service_client.d.ts +315 -0
  128. package/build/src/v1beta/recommendation_service_client.js +432 -0
  129. package/build/src/v1beta/schema_service_client.d.ts +315 -0
  130. package/build/src/v1beta/schema_service_client.js +432 -0
  131. package/build/src/v1beta/search_service_client.d.ts +342 -12
  132. package/build/src/v1beta/search_service_client.js +450 -8
  133. package/build/src/v1beta/search_service_client_config.json +5 -5
  134. package/build/src/v1beta/search_tuning_service_client.d.ts +315 -0
  135. package/build/src/v1beta/search_tuning_service_client.js +432 -0
  136. package/build/src/v1beta/serving_config_service_client.d.ts +315 -0
  137. package/build/src/v1beta/serving_config_service_client.js +432 -0
  138. package/build/src/v1beta/site_search_engine_service_client.d.ts +315 -0
  139. package/build/src/v1beta/site_search_engine_service_client.js +432 -0
  140. package/build/src/v1beta/user_event_service_client.d.ts +315 -0
  141. package/build/src/v1beta/user_event_service_client.js +432 -0
  142. package/package.json +1 -1
@@ -0,0 +1,1087 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LocationsClient, LocationProtos } from 'google-gax';
3
+ import * as protos from '../../protos/protos';
4
+ /**
5
+ * Service for making recommendations.
6
+ * @class
7
+ * @memberof v1
8
+ */
9
+ export declare class RecommendationServiceClient {
10
+ private _terminated;
11
+ private _opts;
12
+ private _providedCustomServicePath;
13
+ private _gaxModule;
14
+ private _gaxGrpc;
15
+ private _protos;
16
+ private _defaults;
17
+ private _universeDomain;
18
+ private _servicePath;
19
+ auth: gax.GoogleAuth;
20
+ descriptors: Descriptors;
21
+ warn: (code: string, message: string, warnType?: string) => void;
22
+ innerApiCalls: {
23
+ [name: string]: Function;
24
+ };
25
+ locationsClient: LocationsClient;
26
+ pathTemplates: {
27
+ [name: string]: gax.PathTemplate;
28
+ };
29
+ recommendationServiceStub?: Promise<{
30
+ [name: string]: Function;
31
+ }>;
32
+ /**
33
+ * Construct an instance of RecommendationServiceClient.
34
+ *
35
+ * @param {object} [options] - The configuration object.
36
+ * The options accepted by the constructor are described in detail
37
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
38
+ * The common options are:
39
+ * @param {object} [options.credentials] - Credentials object.
40
+ * @param {string} [options.credentials.client_email]
41
+ * @param {string} [options.credentials.private_key]
42
+ * @param {string} [options.email] - Account email address. Required when
43
+ * using a .pem or .p12 keyFilename.
44
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
45
+ * .p12 key downloaded from the Google Developers Console. If you provide
46
+ * a path to a JSON file, the projectId option below is not necessary.
47
+ * NOTE: .pem and .p12 require you to specify options.email as well.
48
+ * @param {number} [options.port] - The port on which to connect to
49
+ * the remote host.
50
+ * @param {string} [options.projectId] - The project ID from the Google
51
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
52
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
53
+ * app is running in an environment which supports
54
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
55
+ * your project ID will be detected automatically.
56
+ * @param {string} [options.apiEndpoint] - The domain name of the
57
+ * API remote host.
58
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
59
+ * Follows the structure of {@link gapicConfig}.
60
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
61
+ * For more information, please check the
62
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
63
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
64
+ * need to avoid loading the default gRPC version and want to use the fallback
65
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
66
+ * ```
67
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
68
+ * const client = new RecommendationServiceClient({fallback: true}, gax);
69
+ * ```
70
+ */
71
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
72
+ /**
73
+ * Initialize the client.
74
+ * Performs asynchronous operations (such as authentication) and prepares the client.
75
+ * This function will be called automatically when any class method is called for the
76
+ * first time, but if you need to initialize it before calling an actual method,
77
+ * feel free to call initialize() directly.
78
+ *
79
+ * You can await on this method if you want to make sure the client is initialized.
80
+ *
81
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
82
+ */
83
+ initialize(): Promise<{
84
+ [name: string]: Function;
85
+ }>;
86
+ /**
87
+ * The DNS address for this API service.
88
+ * @deprecated Use the apiEndpoint method of the client instance.
89
+ * @returns {string} The DNS address for this service.
90
+ */
91
+ static get servicePath(): string;
92
+ /**
93
+ * The DNS address for this API service - same as servicePath.
94
+ * @deprecated Use the apiEndpoint method of the client instance.
95
+ * @returns {string} The DNS address for this service.
96
+ */
97
+ static get apiEndpoint(): string;
98
+ /**
99
+ * The DNS address for this API service.
100
+ * @returns {string} The DNS address for this service.
101
+ */
102
+ get apiEndpoint(): string;
103
+ get universeDomain(): string;
104
+ /**
105
+ * The port for this API service.
106
+ * @returns {number} The default port for this service.
107
+ */
108
+ static get port(): number;
109
+ /**
110
+ * The scopes needed to make gRPC calls for every method defined
111
+ * in this service.
112
+ * @returns {string[]} List of default scopes.
113
+ */
114
+ static get scopes(): string[];
115
+ getProjectId(): Promise<string>;
116
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
117
+ /**
118
+ * Makes a recommendation, which requires a contextual user event.
119
+ *
120
+ * @param {Object} request
121
+ * The request object that will be sent.
122
+ * @param {string} request.servingConfig
123
+ * Required. Full resource name of a {@link protos.|ServingConfig}:
124
+ * `projects/* /locations/global/collections/* /engines/* /servingConfigs/*`, or
125
+ * `projects/* /locations/global/collections/* /dataStores/* /servingConfigs/*`
126
+ *
127
+ * One default serving config is created along with your recommendation engine
128
+ * creation. The engine ID will be used as the ID of the default serving
129
+ * config. For example, for Engine
130
+ * `projects/* /locations/global/collections/* /engines/my-engine`, you can use
131
+ * `projects/* /locations/global/collections/* /engines/my-engine/servingConfigs/my-engine`
132
+ * for your
133
+ * {@link protos.google.cloud.discoveryengine.v1.RecommendationService.Recommend|RecommendationService.Recommend}
134
+ * requests.
135
+ * @param {google.cloud.discoveryengine.v1.UserEvent} request.userEvent
136
+ * Required. Context about the user, what they are looking at and what action
137
+ * they took to trigger the Recommend request. Note that this user event
138
+ * detail won't be ingested to userEvent logs. Thus, a separate userEvent
139
+ * write request is required for event logging.
140
+ *
141
+ * Don't set
142
+ * {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
143
+ * or
144
+ * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_id|UserEvent.user_info.user_id}
145
+ * to the same fixed ID for different users. If you are trying to receive
146
+ * non-personalized recommendations (not recommended; this can negatively
147
+ * impact model performance), instead set
148
+ * {@link protos.google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
149
+ * to a random unique ID and leave
150
+ * {@link protos.google.cloud.discoveryengine.v1.UserInfo.user_id|UserEvent.user_info.user_id}
151
+ * unset.
152
+ * @param {number} request.pageSize
153
+ * Maximum number of results to return. Set this property
154
+ * to the number of recommendation results needed. If zero, the service will
155
+ * choose a reasonable default. The maximum allowed value is 100. Values
156
+ * above 100 will be coerced to 100.
157
+ * @param {string} request.filter
158
+ * Filter for restricting recommendation results with a length limit of 5,000
159
+ * characters. Currently, only filter expressions on the `filter_tags`
160
+ * attribute is supported.
161
+ *
162
+ *
163
+ * Examples:
164
+ *
165
+ * * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
166
+ * * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
167
+ *
168
+ * If `attributeFilteringSyntax` is set to true under the `params` field, then
169
+ * attribute-based expressions are expected instead of the above described
170
+ * tag-based syntax. Examples:
171
+ *
172
+ * * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
173
+ * * (available: true) AND
174
+ * (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
175
+ *
176
+ * If your filter blocks all results, the API will return generic
177
+ * (unfiltered) popular Documents. If you only want results strictly matching
178
+ * the filters, set `strictFiltering` to True in
179
+ * {@link protos.google.cloud.discoveryengine.v1.RecommendRequest.params|RecommendRequest.params}
180
+ * to receive empty results instead.
181
+ *
182
+ * Note that the API will never return
183
+ * {@link protos.google.cloud.discoveryengine.v1.Document|Document}s with `storageStatus`
184
+ * of `EXPIRED` or `DELETED` regardless of filter choices.
185
+ * @param {boolean} request.validateOnly
186
+ * Use validate only mode for this recommendation query. If set to true, a
187
+ * fake model will be used that returns arbitrary Document IDs.
188
+ * Note that the validate only mode should only be used for testing the API,
189
+ * or if the model is not ready.
190
+ * @param {number[]} request.params
191
+ * Additional domain specific parameters for the recommendations.
192
+ *
193
+ * Allowed values:
194
+ *
195
+ * * `returnDocument`: Boolean. If set to true, the associated Document
196
+ * object will be returned in
197
+ * {@link protos.google.cloud.discoveryengine.v1.RecommendResponse.RecommendationResult.document|RecommendResponse.RecommendationResult.document}.
198
+ * * `returnScore`: Boolean. If set to true, the recommendation 'score'
199
+ * corresponding to each returned Document will be set in
200
+ * {@link protos.google.cloud.discoveryengine.v1.RecommendResponse.RecommendationResult.metadata|RecommendResponse.RecommendationResult.metadata}.
201
+ * The given 'score' indicates the probability of a Document conversion
202
+ * given the user's context and history.
203
+ * * `strictFiltering`: Boolean. True by default. If set to false, the service
204
+ * will return generic (unfiltered) popular Documents instead of empty if
205
+ * your filter blocks all recommendation results.
206
+ * * `diversityLevel`: String. Default empty. If set to be non-empty, then
207
+ * it needs to be one of:
208
+ * * `no-diversity`
209
+ * * `low-diversity`
210
+ * * `medium-diversity`
211
+ * * `high-diversity`
212
+ * * `auto-diversity`
213
+ * This gives request-level control and adjusts recommendation results
214
+ * based on Document category.
215
+ * * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
216
+ * the `filter` field is interpreted according to the new,
217
+ * attribute-based syntax.
218
+ * @param {number[]} request.userLabels
219
+ * The user labels applied to a resource must meet the following requirements:
220
+ *
221
+ * * Each resource can have multiple labels, up to a maximum of 64.
222
+ * * Each label must be a key-value pair.
223
+ * * Keys have a minimum length of 1 character and a maximum length of 63
224
+ * characters and cannot be empty. Values can be empty and have a maximum
225
+ * length of 63 characters.
226
+ * * Keys and values can contain only lowercase letters, numeric characters,
227
+ * underscores, and dashes. All characters must use UTF-8 encoding, and
228
+ * international characters are allowed.
229
+ * * The key portion of a label must be unique. However, you can use the same
230
+ * key with multiple resources.
231
+ * * Keys must start with a lowercase letter or international character.
232
+ *
233
+ * See [Requirements for
234
+ * labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
235
+ * for more details.
236
+ * @param {object} [options]
237
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
238
+ * @returns {Promise} - The promise which resolves to an array.
239
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.RecommendResponse|RecommendResponse}.
240
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
241
+ * for more details and examples.
242
+ * @example <caption>include:samples/generated/v1/recommendation_service.recommend.js</caption>
243
+ * region_tag:discoveryengine_v1_generated_RecommendationService_Recommend_async
244
+ */
245
+ recommend(request?: protos.google.cloud.discoveryengine.v1.IRecommendRequest, options?: CallOptions): Promise<[
246
+ protos.google.cloud.discoveryengine.v1.IRecommendResponse,
247
+ protos.google.cloud.discoveryengine.v1.IRecommendRequest | undefined,
248
+ {} | undefined
249
+ ]>;
250
+ recommend(request: protos.google.cloud.discoveryengine.v1.IRecommendRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IRecommendResponse, protos.google.cloud.discoveryengine.v1.IRecommendRequest | null | undefined, {} | null | undefined>): void;
251
+ recommend(request: protos.google.cloud.discoveryengine.v1.IRecommendRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IRecommendResponse, protos.google.cloud.discoveryengine.v1.IRecommendRequest | null | undefined, {} | null | undefined>): void;
252
+ /**
253
+ * Gets information about a location.
254
+ *
255
+ * @param {Object} request
256
+ * The request object that will be sent.
257
+ * @param {string} request.name
258
+ * Resource name for the location.
259
+ * @param {object} [options]
260
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
261
+ * @returns {Promise} - The promise which resolves to an array.
262
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
263
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
264
+ * for more details and examples.
265
+ * @example
266
+ * ```
267
+ * const [response] = await client.getLocation(request);
268
+ * ```
269
+ */
270
+ getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
271
+ /**
272
+ * Lists information about the supported locations for this service. Returns an iterable object.
273
+ *
274
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
275
+ * @param {Object} request
276
+ * The request object that will be sent.
277
+ * @param {string} request.name
278
+ * The resource that owns the locations collection, if applicable.
279
+ * @param {string} request.filter
280
+ * The standard list filter.
281
+ * @param {number} request.pageSize
282
+ * The standard list page size.
283
+ * @param {string} request.pageToken
284
+ * The standard list page token.
285
+ * @param {object} [options]
286
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
287
+ * @returns {Object}
288
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
289
+ * When you iterate the returned iterable, each element will be an object representing
290
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
291
+ * so you can stop the iteration when you don't need more results.
292
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
293
+ * for more details and examples.
294
+ * @example
295
+ * ```
296
+ * const iterable = client.listLocationsAsync(request);
297
+ * for await (const response of iterable) {
298
+ * // process response
299
+ * }
300
+ * ```
301
+ */
302
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
303
+ /**
304
+ * Return a fully-qualified engine resource name string.
305
+ *
306
+ * @param {string} project
307
+ * @param {string} location
308
+ * @param {string} collection
309
+ * @param {string} engine
310
+ * @returns {string} Resource name string.
311
+ */
312
+ enginePath(project: string, location: string, collection: string, engine: string): string;
313
+ /**
314
+ * Parse the project from Engine resource.
315
+ *
316
+ * @param {string} engineName
317
+ * A fully-qualified path representing Engine resource.
318
+ * @returns {string} A string representing the project.
319
+ */
320
+ matchProjectFromEngineName(engineName: string): string | number;
321
+ /**
322
+ * Parse the location from Engine resource.
323
+ *
324
+ * @param {string} engineName
325
+ * A fully-qualified path representing Engine resource.
326
+ * @returns {string} A string representing the location.
327
+ */
328
+ matchLocationFromEngineName(engineName: string): string | number;
329
+ /**
330
+ * Parse the collection from Engine resource.
331
+ *
332
+ * @param {string} engineName
333
+ * A fully-qualified path representing Engine resource.
334
+ * @returns {string} A string representing the collection.
335
+ */
336
+ matchCollectionFromEngineName(engineName: string): string | number;
337
+ /**
338
+ * Parse the engine from Engine resource.
339
+ *
340
+ * @param {string} engineName
341
+ * A fully-qualified path representing Engine resource.
342
+ * @returns {string} A string representing the engine.
343
+ */
344
+ matchEngineFromEngineName(engineName: string): string | number;
345
+ /**
346
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
347
+ *
348
+ * @param {string} project
349
+ * @param {string} location
350
+ * @param {string} collection
351
+ * @param {string} data_store
352
+ * @returns {string} Resource name string.
353
+ */
354
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
355
+ /**
356
+ * Parse the project from ProjectLocationCollectionDataStore resource.
357
+ *
358
+ * @param {string} projectLocationCollectionDataStoreName
359
+ * A fully-qualified path representing project_location_collection_data_store resource.
360
+ * @returns {string} A string representing the project.
361
+ */
362
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
363
+ /**
364
+ * Parse the location from ProjectLocationCollectionDataStore resource.
365
+ *
366
+ * @param {string} projectLocationCollectionDataStoreName
367
+ * A fully-qualified path representing project_location_collection_data_store resource.
368
+ * @returns {string} A string representing the location.
369
+ */
370
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
371
+ /**
372
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
373
+ *
374
+ * @param {string} projectLocationCollectionDataStoreName
375
+ * A fully-qualified path representing project_location_collection_data_store resource.
376
+ * @returns {string} A string representing the collection.
377
+ */
378
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
379
+ /**
380
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
381
+ *
382
+ * @param {string} projectLocationCollectionDataStoreName
383
+ * A fully-qualified path representing project_location_collection_data_store resource.
384
+ * @returns {string} A string representing the data_store.
385
+ */
386
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
387
+ /**
388
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
389
+ *
390
+ * @param {string} project
391
+ * @param {string} location
392
+ * @param {string} collection
393
+ * @param {string} data_store
394
+ * @param {string} branch
395
+ * @param {string} document
396
+ * @returns {string} Resource name string.
397
+ */
398
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
399
+ /**
400
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
401
+ *
402
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
403
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
404
+ * @returns {string} A string representing the project.
405
+ */
406
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
407
+ /**
408
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
409
+ *
410
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
411
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
412
+ * @returns {string} A string representing the location.
413
+ */
414
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
415
+ /**
416
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
417
+ *
418
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
419
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
420
+ * @returns {string} A string representing the collection.
421
+ */
422
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
423
+ /**
424
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
425
+ *
426
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
427
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
428
+ * @returns {string} A string representing the data_store.
429
+ */
430
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
431
+ /**
432
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
433
+ *
434
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
435
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
436
+ * @returns {string} A string representing the branch.
437
+ */
438
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
439
+ /**
440
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
441
+ *
442
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
443
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
444
+ * @returns {string} A string representing the document.
445
+ */
446
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
447
+ /**
448
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
449
+ *
450
+ * @param {string} project
451
+ * @param {string} location
452
+ * @param {string} collection
453
+ * @param {string} data_store
454
+ * @param {string} conversation
455
+ * @returns {string} Resource name string.
456
+ */
457
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
458
+ /**
459
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
460
+ *
461
+ * @param {string} projectLocationCollectionDataStoreConversationName
462
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
463
+ * @returns {string} A string representing the project.
464
+ */
465
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
466
+ /**
467
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
468
+ *
469
+ * @param {string} projectLocationCollectionDataStoreConversationName
470
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
471
+ * @returns {string} A string representing the location.
472
+ */
473
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
474
+ /**
475
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
476
+ *
477
+ * @param {string} projectLocationCollectionDataStoreConversationName
478
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
479
+ * @returns {string} A string representing the collection.
480
+ */
481
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
482
+ /**
483
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
484
+ *
485
+ * @param {string} projectLocationCollectionDataStoreConversationName
486
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
487
+ * @returns {string} A string representing the data_store.
488
+ */
489
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
490
+ /**
491
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
492
+ *
493
+ * @param {string} projectLocationCollectionDataStoreConversationName
494
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
495
+ * @returns {string} A string representing the conversation.
496
+ */
497
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
498
+ /**
499
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
500
+ *
501
+ * @param {string} project
502
+ * @param {string} location
503
+ * @param {string} collection
504
+ * @param {string} data_store
505
+ * @param {string} schema
506
+ * @returns {string} Resource name string.
507
+ */
508
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
509
+ /**
510
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
511
+ *
512
+ * @param {string} projectLocationCollectionDataStoreSchemaName
513
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
514
+ * @returns {string} A string representing the project.
515
+ */
516
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
517
+ /**
518
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
519
+ *
520
+ * @param {string} projectLocationCollectionDataStoreSchemaName
521
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
522
+ * @returns {string} A string representing the location.
523
+ */
524
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
525
+ /**
526
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
527
+ *
528
+ * @param {string} projectLocationCollectionDataStoreSchemaName
529
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
530
+ * @returns {string} A string representing the collection.
531
+ */
532
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
533
+ /**
534
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
535
+ *
536
+ * @param {string} projectLocationCollectionDataStoreSchemaName
537
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
538
+ * @returns {string} A string representing the data_store.
539
+ */
540
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
541
+ /**
542
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
543
+ *
544
+ * @param {string} projectLocationCollectionDataStoreSchemaName
545
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
546
+ * @returns {string} A string representing the schema.
547
+ */
548
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
549
+ /**
550
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
551
+ *
552
+ * @param {string} project
553
+ * @param {string} location
554
+ * @param {string} collection
555
+ * @param {string} data_store
556
+ * @param {string} serving_config
557
+ * @returns {string} Resource name string.
558
+ */
559
+ projectLocationCollectionDataStoreServingConfigPath(project: string, location: string, collection: string, dataStore: string, servingConfig: string): string;
560
+ /**
561
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
562
+ *
563
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
564
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
565
+ * @returns {string} A string representing the project.
566
+ */
567
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
568
+ /**
569
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
570
+ *
571
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
572
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
573
+ * @returns {string} A string representing the location.
574
+ */
575
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
576
+ /**
577
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
578
+ *
579
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
580
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
581
+ * @returns {string} A string representing the collection.
582
+ */
583
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
584
+ /**
585
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
586
+ *
587
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
588
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
589
+ * @returns {string} A string representing the data_store.
590
+ */
591
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
592
+ /**
593
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
594
+ *
595
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
596
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
597
+ * @returns {string} A string representing the serving_config.
598
+ */
599
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName: string): string | number;
600
+ /**
601
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
602
+ *
603
+ * @param {string} project
604
+ * @param {string} location
605
+ * @param {string} collection
606
+ * @param {string} data_store
607
+ * @returns {string} Resource name string.
608
+ */
609
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
610
+ /**
611
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
612
+ *
613
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
614
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
615
+ * @returns {string} A string representing the project.
616
+ */
617
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
618
+ /**
619
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
620
+ *
621
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
622
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
623
+ * @returns {string} A string representing the location.
624
+ */
625
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
626
+ /**
627
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
628
+ *
629
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
630
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
631
+ * @returns {string} A string representing the collection.
632
+ */
633
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
634
+ /**
635
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
636
+ *
637
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
638
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
639
+ * @returns {string} A string representing the data_store.
640
+ */
641
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
642
+ /**
643
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
644
+ *
645
+ * @param {string} project
646
+ * @param {string} location
647
+ * @param {string} collection
648
+ * @param {string} data_store
649
+ * @param {string} target_site
650
+ * @returns {string} Resource name string.
651
+ */
652
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
653
+ /**
654
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
655
+ *
656
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
657
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
658
+ * @returns {string} A string representing the project.
659
+ */
660
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
661
+ /**
662
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
663
+ *
664
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
665
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
666
+ * @returns {string} A string representing the location.
667
+ */
668
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
669
+ /**
670
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
671
+ *
672
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
673
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
674
+ * @returns {string} A string representing the collection.
675
+ */
676
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
677
+ /**
678
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
679
+ *
680
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
681
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
682
+ * @returns {string} A string representing the data_store.
683
+ */
684
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
685
+ /**
686
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
687
+ *
688
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
689
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
690
+ * @returns {string} A string representing the target_site.
691
+ */
692
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
693
+ /**
694
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
695
+ *
696
+ * @param {string} project
697
+ * @param {string} location
698
+ * @param {string} collection
699
+ * @param {string} engine
700
+ * @param {string} conversation
701
+ * @returns {string} Resource name string.
702
+ */
703
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
704
+ /**
705
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
706
+ *
707
+ * @param {string} projectLocationCollectionEngineConversationName
708
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
709
+ * @returns {string} A string representing the project.
710
+ */
711
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
712
+ /**
713
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
714
+ *
715
+ * @param {string} projectLocationCollectionEngineConversationName
716
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
717
+ * @returns {string} A string representing the location.
718
+ */
719
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
720
+ /**
721
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
722
+ *
723
+ * @param {string} projectLocationCollectionEngineConversationName
724
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
725
+ * @returns {string} A string representing the collection.
726
+ */
727
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
728
+ /**
729
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
730
+ *
731
+ * @param {string} projectLocationCollectionEngineConversationName
732
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
733
+ * @returns {string} A string representing the engine.
734
+ */
735
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
736
+ /**
737
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
738
+ *
739
+ * @param {string} projectLocationCollectionEngineConversationName
740
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
741
+ * @returns {string} A string representing the conversation.
742
+ */
743
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
744
+ /**
745
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
746
+ *
747
+ * @param {string} project
748
+ * @param {string} location
749
+ * @param {string} collection
750
+ * @param {string} engine
751
+ * @param {string} serving_config
752
+ * @returns {string} Resource name string.
753
+ */
754
+ projectLocationCollectionEngineServingConfigPath(project: string, location: string, collection: string, engine: string, servingConfig: string): string;
755
+ /**
756
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
757
+ *
758
+ * @param {string} projectLocationCollectionEngineServingConfigName
759
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
760
+ * @returns {string} A string representing the project.
761
+ */
762
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
763
+ /**
764
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
765
+ *
766
+ * @param {string} projectLocationCollectionEngineServingConfigName
767
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
768
+ * @returns {string} A string representing the location.
769
+ */
770
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
771
+ /**
772
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
773
+ *
774
+ * @param {string} projectLocationCollectionEngineServingConfigName
775
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
776
+ * @returns {string} A string representing the collection.
777
+ */
778
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
779
+ /**
780
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
781
+ *
782
+ * @param {string} projectLocationCollectionEngineServingConfigName
783
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
784
+ * @returns {string} A string representing the engine.
785
+ */
786
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
787
+ /**
788
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
789
+ *
790
+ * @param {string} projectLocationCollectionEngineServingConfigName
791
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
792
+ * @returns {string} A string representing the serving_config.
793
+ */
794
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
795
+ /**
796
+ * Return a fully-qualified projectLocationDataStore resource name string.
797
+ *
798
+ * @param {string} project
799
+ * @param {string} location
800
+ * @param {string} data_store
801
+ * @returns {string} Resource name string.
802
+ */
803
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
804
+ /**
805
+ * Parse the project from ProjectLocationDataStore resource.
806
+ *
807
+ * @param {string} projectLocationDataStoreName
808
+ * A fully-qualified path representing project_location_data_store resource.
809
+ * @returns {string} A string representing the project.
810
+ */
811
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
812
+ /**
813
+ * Parse the location from ProjectLocationDataStore resource.
814
+ *
815
+ * @param {string} projectLocationDataStoreName
816
+ * A fully-qualified path representing project_location_data_store resource.
817
+ * @returns {string} A string representing the location.
818
+ */
819
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
820
+ /**
821
+ * Parse the data_store from ProjectLocationDataStore resource.
822
+ *
823
+ * @param {string} projectLocationDataStoreName
824
+ * A fully-qualified path representing project_location_data_store resource.
825
+ * @returns {string} A string representing the data_store.
826
+ */
827
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
828
+ /**
829
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
830
+ *
831
+ * @param {string} project
832
+ * @param {string} location
833
+ * @param {string} data_store
834
+ * @param {string} branch
835
+ * @param {string} document
836
+ * @returns {string} Resource name string.
837
+ */
838
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
839
+ /**
840
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
841
+ *
842
+ * @param {string} projectLocationDataStoreBranchDocumentName
843
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
844
+ * @returns {string} A string representing the project.
845
+ */
846
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
847
+ /**
848
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
849
+ *
850
+ * @param {string} projectLocationDataStoreBranchDocumentName
851
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
852
+ * @returns {string} A string representing the location.
853
+ */
854
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
855
+ /**
856
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
857
+ *
858
+ * @param {string} projectLocationDataStoreBranchDocumentName
859
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
860
+ * @returns {string} A string representing the data_store.
861
+ */
862
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
863
+ /**
864
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
865
+ *
866
+ * @param {string} projectLocationDataStoreBranchDocumentName
867
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
868
+ * @returns {string} A string representing the branch.
869
+ */
870
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
871
+ /**
872
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
873
+ *
874
+ * @param {string} projectLocationDataStoreBranchDocumentName
875
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
876
+ * @returns {string} A string representing the document.
877
+ */
878
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
879
+ /**
880
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
881
+ *
882
+ * @param {string} project
883
+ * @param {string} location
884
+ * @param {string} data_store
885
+ * @param {string} conversation
886
+ * @returns {string} Resource name string.
887
+ */
888
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
889
+ /**
890
+ * Parse the project from ProjectLocationDataStoreConversation resource.
891
+ *
892
+ * @param {string} projectLocationDataStoreConversationName
893
+ * A fully-qualified path representing project_location_data_store_conversation resource.
894
+ * @returns {string} A string representing the project.
895
+ */
896
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
897
+ /**
898
+ * Parse the location from ProjectLocationDataStoreConversation resource.
899
+ *
900
+ * @param {string} projectLocationDataStoreConversationName
901
+ * A fully-qualified path representing project_location_data_store_conversation resource.
902
+ * @returns {string} A string representing the location.
903
+ */
904
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
905
+ /**
906
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
907
+ *
908
+ * @param {string} projectLocationDataStoreConversationName
909
+ * A fully-qualified path representing project_location_data_store_conversation resource.
910
+ * @returns {string} A string representing the data_store.
911
+ */
912
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
913
+ /**
914
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
915
+ *
916
+ * @param {string} projectLocationDataStoreConversationName
917
+ * A fully-qualified path representing project_location_data_store_conversation resource.
918
+ * @returns {string} A string representing the conversation.
919
+ */
920
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
921
+ /**
922
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
923
+ *
924
+ * @param {string} project
925
+ * @param {string} location
926
+ * @param {string} data_store
927
+ * @param {string} schema
928
+ * @returns {string} Resource name string.
929
+ */
930
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
931
+ /**
932
+ * Parse the project from ProjectLocationDataStoreSchema resource.
933
+ *
934
+ * @param {string} projectLocationDataStoreSchemaName
935
+ * A fully-qualified path representing project_location_data_store_schema resource.
936
+ * @returns {string} A string representing the project.
937
+ */
938
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
939
+ /**
940
+ * Parse the location from ProjectLocationDataStoreSchema resource.
941
+ *
942
+ * @param {string} projectLocationDataStoreSchemaName
943
+ * A fully-qualified path representing project_location_data_store_schema resource.
944
+ * @returns {string} A string representing the location.
945
+ */
946
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
947
+ /**
948
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
949
+ *
950
+ * @param {string} projectLocationDataStoreSchemaName
951
+ * A fully-qualified path representing project_location_data_store_schema resource.
952
+ * @returns {string} A string representing the data_store.
953
+ */
954
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
955
+ /**
956
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
957
+ *
958
+ * @param {string} projectLocationDataStoreSchemaName
959
+ * A fully-qualified path representing project_location_data_store_schema resource.
960
+ * @returns {string} A string representing the schema.
961
+ */
962
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
963
+ /**
964
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
965
+ *
966
+ * @param {string} project
967
+ * @param {string} location
968
+ * @param {string} data_store
969
+ * @param {string} serving_config
970
+ * @returns {string} Resource name string.
971
+ */
972
+ projectLocationDataStoreServingConfigPath(project: string, location: string, dataStore: string, servingConfig: string): string;
973
+ /**
974
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
975
+ *
976
+ * @param {string} projectLocationDataStoreServingConfigName
977
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
978
+ * @returns {string} A string representing the project.
979
+ */
980
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
981
+ /**
982
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
983
+ *
984
+ * @param {string} projectLocationDataStoreServingConfigName
985
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
986
+ * @returns {string} A string representing the location.
987
+ */
988
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
989
+ /**
990
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
991
+ *
992
+ * @param {string} projectLocationDataStoreServingConfigName
993
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
994
+ * @returns {string} A string representing the data_store.
995
+ */
996
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
997
+ /**
998
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
999
+ *
1000
+ * @param {string} projectLocationDataStoreServingConfigName
1001
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1002
+ * @returns {string} A string representing the serving_config.
1003
+ */
1004
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName: string): string | number;
1005
+ /**
1006
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1007
+ *
1008
+ * @param {string} project
1009
+ * @param {string} location
1010
+ * @param {string} data_store
1011
+ * @returns {string} Resource name string.
1012
+ */
1013
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
1014
+ /**
1015
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1016
+ *
1017
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1018
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1019
+ * @returns {string} A string representing the project.
1020
+ */
1021
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1022
+ /**
1023
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1024
+ *
1025
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1026
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1027
+ * @returns {string} A string representing the location.
1028
+ */
1029
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1030
+ /**
1031
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1032
+ *
1033
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1034
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1035
+ * @returns {string} A string representing the data_store.
1036
+ */
1037
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
1038
+ /**
1039
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1040
+ *
1041
+ * @param {string} project
1042
+ * @param {string} location
1043
+ * @param {string} data_store
1044
+ * @param {string} target_site
1045
+ * @returns {string} Resource name string.
1046
+ */
1047
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
1048
+ /**
1049
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1050
+ *
1051
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1052
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1053
+ * @returns {string} A string representing the project.
1054
+ */
1055
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1056
+ /**
1057
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1058
+ *
1059
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1060
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1061
+ * @returns {string} A string representing the location.
1062
+ */
1063
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1064
+ /**
1065
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1066
+ *
1067
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1068
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1069
+ * @returns {string} A string representing the data_store.
1070
+ */
1071
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1072
+ /**
1073
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1074
+ *
1075
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1076
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1077
+ * @returns {string} A string representing the target_site.
1078
+ */
1079
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
1080
+ /**
1081
+ * Terminate the gRPC channel and close the client.
1082
+ *
1083
+ * The client will no longer be usable and all future behavior is undefined.
1084
+ * @returns {Promise} A promise that resolves when the client is closed.
1085
+ */
1086
+ close(): Promise<void>;
1087
+ }