@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20231026 → 0.0.20231110

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 (3) hide show
  1. package/index.d.ts +376 -25
  2. package/package.json +1 -1
  3. package/tests.ts +15 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta
12
- // Revision: 20231026
12
+ // Revision: 20231110
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -104,6 +104,22 @@ declare namespace gapi.client {
104
104
  functionName?:
105
105
  string;
106
106
  }
107
+ interface GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
108
+ /** Operation create time. */
109
+ createTime?:
110
+ string;
111
+ /** Operation last update time. If the operation is done, this is also the finish time. */
112
+ updateTime?:
113
+ string;
114
+ }
115
+ interface GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata {
116
+ /** Operation create time. */
117
+ createTime?:
118
+ string;
119
+ /** Operation last update time. If the operation is done, this is also the finish time. */
120
+ updateTime?:
121
+ string;
122
+ }
107
123
  interface GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata {
108
124
  /** Operation create time. */
109
125
  createTime?:
@@ -112,6 +128,51 @@ declare namespace gapi.client {
112
128
  updateTime?:
113
129
  string;
114
130
  }
131
+ interface GoogleCloudDiscoveryengineV1alphaDataStore {
132
+ /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
133
+ contentConfig?:
134
+ string;
135
+ /** Output only. Timestamp the DataStore was created at. */
136
+ createTime?:
137
+ string;
138
+ /** Output only. The id of the default Schema asscociated to this data store. */
139
+ defaultSchemaId?:
140
+ string;
141
+ /** Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
142
+ displayName?:
143
+ string;
144
+ /** Immutable. The industry vertical that the data store registers. */
145
+ industryVertical?:
146
+ string;
147
+ /**
148
+ * Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a
149
+ * UTF-8 encoded string with a length limit of 1024 characters.
150
+ */
151
+ name?:
152
+ string;
153
+ /**
154
+ * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`:
155
+ * `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
156
+ */
157
+ solutionTypes?:
158
+ string[];
159
+ }
160
+ interface GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
161
+ /** Operation create time. */
162
+ createTime?:
163
+ string;
164
+ /** Operation last update time. If the operation is done, this is also the finish time. */
165
+ updateTime?:
166
+ string;
167
+ }
168
+ interface GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata {
169
+ /** Operation create time. */
170
+ createTime?:
171
+ string;
172
+ /** Operation last update time. If the operation is done, this is also the finish time. */
173
+ updateTime?:
174
+ string;
175
+ }
115
176
  interface GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata {
116
177
  /** Operation create time. */
117
178
  createTime?:
@@ -120,6 +181,173 @@ declare namespace gapi.client {
120
181
  updateTime?:
121
182
  string;
122
183
  }
184
+ interface GoogleCloudDiscoveryengineV1alphaEngine {
185
+ /** Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
186
+ chatEngineConfig?:
187
+ GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
188
+ /** Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */
189
+ chatEngineMetadata?:
190
+ GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
191
+ /** Common config spec that specifies the metadata of the engine. */
192
+ commonConfig?:
193
+ GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
194
+ /** Output only. Timestamp the Recommendation Engine was created at. */
195
+ createTime?:
196
+ string;
197
+ /**
198
+ * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If
199
+ * solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided
200
+ * as the system will use it for necessary intializations.
201
+ */
202
+ dataStoreIds?:
203
+ string[];
204
+ /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
205
+ displayName?:
206
+ string;
207
+ /**
208
+ * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has
209
+ * to match vertical of the DataStore liniked to the engine.
210
+ */
211
+ industryVertical?:
212
+ string;
213
+ /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
214
+ mediaRecommendationEngineConfig?:
215
+ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
216
+ /**
217
+ * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format:
218
+ * `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an
219
+ * INVALID_ARGUMENT error is returned.
220
+ */
221
+ name?:
222
+ string;
223
+ /** Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. */
224
+ recommendationMetadata?:
225
+ GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
226
+ /** Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */
227
+ searchEngineConfig?:
228
+ GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig;
229
+ /** Additional config specs for a `similar-items` engine. */
230
+ similarDocumentsConfig?:
231
+ any;
232
+ /** Required. The solutions of the engine. */
233
+ solutionType?:
234
+ string;
235
+ /** Output only. Timestamp the Recommendation Engine was last updated. */
236
+ updateTime?:
237
+ string;
238
+ }
239
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
240
+ /**
241
+ * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It
242
+ * means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
243
+ */
244
+ agentCreationConfig?:
245
+ GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
246
+ /**
247
+ * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links
248
+ * the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means
249
+ * they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use chat_engine_metadata.dialogflow_agent for actual agent
250
+ * association after Engine is created.
251
+ */
252
+ dialogflowAgentToLink?:
253
+ string;
254
+ }
255
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
256
+ /** Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. */
257
+ business?:
258
+ string;
259
+ /**
260
+ * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently
261
+ * supported language codes.
262
+ */
263
+ defaultLanguageCode?:
264
+ string;
265
+ /** Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. */
266
+ timeZone?:
267
+ string;
268
+ }
269
+ interface GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata {
270
+ /** The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. */
271
+ dialogflowAgent?:
272
+ string;
273
+ }
274
+ interface GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
275
+ /** The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */
276
+ companyName?:
277
+ string;
278
+ }
279
+ interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
280
+ /**
281
+ * The optimization objective e.g. `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported
282
+ * values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` =>
283
+ * `ctr`
284
+ */
285
+ optimizationObjective?:
286
+ string;
287
+ /**
288
+ * Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time
289
+ * in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0]
290
+ * (excludes 0, includes 1.0) (e.g., 0.5).
291
+ */
292
+ optimizationObjectiveConfig?:
293
+ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig;
294
+ /**
295
+ * The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when
296
+ * to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the
297
+ * state the same as before.
298
+ */
299
+ trainingState?:
300
+ string;
301
+ /**
302
+ * Required. The type of engine e.g. `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving.
303
+ * Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
304
+ */
305
+ type?:
306
+ string;
307
+ }
308
+ interface GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
309
+ /** Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`. */
310
+ targetField?:
311
+ string;
312
+ /** Required. The threshold to be applied to the target (e.g., 0.5). */
313
+ targetFieldValueFloat?:
314
+ number;
315
+ }
316
+ interface GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata {
317
+ /**
318
+ * Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR`
319
+ * state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
320
+ */
321
+ dataState?:
322
+ string;
323
+ /** Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines. */
324
+ lastTuneTime?:
325
+ string;
326
+ /** Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`. */
327
+ servingState?:
328
+ string;
329
+ /**
330
+ * Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if
331
+ * there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has
332
+ * happened for this engine, the string is empty.
333
+ */
334
+ tuningOperation?:
335
+ string;
336
+ }
337
+ interface GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
338
+ /** The add-on that this search engine enables. */
339
+ searchAddOns?:
340
+ string[];
341
+ /**
342
+ * The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to
343
+ * SearchTier.SEARCH_TIER_STANDARD if not specified.
344
+ */
345
+ searchTier?:
346
+ string;
347
+ }
348
+ // tslint:disable-next-line:no-empty-interface
349
+ interface GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {
350
+ }
123
351
  interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
124
352
  /**
125
353
  * If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option
@@ -395,6 +623,14 @@ declare namespace gapi.client {
395
623
  // tslint:disable-next-line:no-empty-interface
396
624
  interface GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {
397
625
  }
626
+ interface GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
627
+ /** Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}` */
628
+ engine?:
629
+ string;
630
+ }
631
+ // tslint:disable-next-line:no-empty-interface
632
+ interface GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {
633
+ }
398
634
  interface GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata {
399
635
  /** Operation create time. */
400
636
  createTime?:
@@ -1062,6 +1298,14 @@ declare namespace gapi.client {
1062
1298
  */
1063
1299
  branch?:
1064
1300
  string;
1301
+ /**
1302
+ * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement
1303
+ * such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query
1304
+ * expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about
1305
+ * filter syntax, see SearchRequest.filter.
1306
+ */
1307
+ canonicalFilter?:
1308
+ string;
1065
1309
  /** A specification for configuring the behavior of content search. */
1066
1310
  contentSearchSpec?:
1067
1311
  GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec;
@@ -1838,6 +2082,99 @@ declare namespace gapi.client {
1838
2082
  year?:
1839
2083
  number;
1840
2084
  }
2085
+ interface OperationsResource {
2086
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
2087
+ get(request?: {
2088
+ /** V1 error format. */
2089
+ "$.xgafv"?:
2090
+ string;
2091
+ /** OAuth access token. */
2092
+ access_token?:
2093
+ string;
2094
+ /** Data format for response. */
2095
+ alt?:
2096
+ string;
2097
+ /** JSONP */
2098
+ callback?:
2099
+ string;
2100
+ /** Selector specifying which fields to include in a partial response. */
2101
+ fields?:
2102
+ string;
2103
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2104
+ key?:
2105
+ string;
2106
+ /** The name of the operation resource. */
2107
+ name:
2108
+ string;
2109
+ /** OAuth 2.0 token for the current user. */
2110
+ oauth_token?:
2111
+ string;
2112
+ /** Returns response with indentations and line breaks. */
2113
+ prettyPrint?:
2114
+ boolean;
2115
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2116
+ quotaUser?:
2117
+ string;
2118
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2119
+ upload_protocol?:
2120
+ string;
2121
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2122
+ uploadType?:
2123
+ string;
2124
+ }): Request<GoogleLongrunningOperation>;
2125
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
2126
+ list(request?: {
2127
+ /** V1 error format. */
2128
+ "$.xgafv"?:
2129
+ string;
2130
+ /** OAuth access token. */
2131
+ access_token?:
2132
+ string;
2133
+ /** Data format for response. */
2134
+ alt?:
2135
+ string;
2136
+ /** JSONP */
2137
+ callback?:
2138
+ string;
2139
+ /** Selector specifying which fields to include in a partial response. */
2140
+ fields?:
2141
+ string;
2142
+ /** The standard list filter. */
2143
+ filter?:
2144
+ string;
2145
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
2146
+ key?:
2147
+ string;
2148
+ /** The name of the operation's parent resource. */
2149
+ name:
2150
+ string;
2151
+ /** OAuth 2.0 token for the current user. */
2152
+ oauth_token?:
2153
+ string;
2154
+ /** The standard list page size. */
2155
+ pageSize?:
2156
+ number;
2157
+ /** The standard list page token. */
2158
+ pageToken?:
2159
+ string;
2160
+ /** Returns response with indentations and line breaks. */
2161
+ prettyPrint?:
2162
+ boolean;
2163
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
2164
+ quotaUser?:
2165
+ string;
2166
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2167
+ upload_protocol?:
2168
+ string;
2169
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2170
+ uploadType?:
2171
+ string;
2172
+ }): Request<GoogleLongrunningListOperationsResponse>;
2173
+ }
2174
+ interface DataConnectorResource {
2175
+ operations:
2176
+ OperationsResource;
2177
+ }
1841
2178
  interface DocumentsResource {
1842
2179
  /** Creates a Document. */
1843
2180
  create(request: {
@@ -3463,8 +3800,10 @@ declare namespace gapi.client {
3463
3800
  quotaUser?:
3464
3801
  string;
3465
3802
  /**
3466
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
3467
- * you must create at least one serving config for it.
3803
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
3804
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
3805
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
3806
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
3468
3807
  */
3469
3808
  servingConfig:
3470
3809
  string;
@@ -3507,8 +3846,10 @@ declare namespace gapi.client {
3507
3846
  quotaUser?:
3508
3847
  string;
3509
3848
  /**
3510
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
3511
- * you must create at least one serving config for it.
3849
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
3850
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
3851
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
3852
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
3512
3853
  */
3513
3854
  servingConfig:
3514
3855
  string;
@@ -3550,8 +3891,8 @@ declare namespace gapi.client {
3550
3891
  quotaUser?:
3551
3892
  string;
3552
3893
  /**
3553
- * Required. The resource name of the Search serving config, such as
3554
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
3894
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
3895
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
3555
3896
  * configuration name, set of models used to make the search.
3556
3897
  */
3557
3898
  servingConfig:
@@ -3595,8 +3936,8 @@ declare namespace gapi.client {
3595
3936
  quotaUser?:
3596
3937
  string;
3597
3938
  /**
3598
- * Required. The resource name of the Search serving config, such as
3599
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
3939
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
3940
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
3600
3941
  * configuration name, set of models used to make the search.
3601
3942
  */
3602
3943
  servingConfig:
@@ -4224,8 +4565,10 @@ declare namespace gapi.client {
4224
4565
  quotaUser?:
4225
4566
  string;
4226
4567
  /**
4227
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
4228
- * you must create at least one serving config for it.
4568
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
4569
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
4570
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
4571
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
4229
4572
  */
4230
4573
  servingConfig:
4231
4574
  string;
@@ -4268,8 +4611,10 @@ declare namespace gapi.client {
4268
4611
  quotaUser?:
4269
4612
  string;
4270
4613
  /**
4271
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
4272
- * you must create at least one serving config for it.
4614
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
4615
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
4616
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
4617
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
4273
4618
  */
4274
4619
  servingConfig:
4275
4620
  string;
@@ -4311,8 +4656,8 @@ declare namespace gapi.client {
4311
4656
  quotaUser?:
4312
4657
  string;
4313
4658
  /**
4314
- * Required. The resource name of the Search serving config, such as
4315
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4659
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
4660
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4316
4661
  * configuration name, set of models used to make the search.
4317
4662
  */
4318
4663
  servingConfig:
@@ -4356,8 +4701,8 @@ declare namespace gapi.client {
4356
4701
  quotaUser?:
4357
4702
  string;
4358
4703
  /**
4359
- * Required. The resource name of the Search serving config, such as
4360
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4704
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
4705
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
4361
4706
  * configuration name, set of models used to make the search.
4362
4707
  */
4363
4708
  servingConfig:
@@ -4467,6 +4812,8 @@ declare namespace gapi.client {
4467
4812
  }): Request<GoogleLongrunningListOperationsResponse>;
4468
4813
  }
4469
4814
  interface CollectionsResource {
4815
+ dataConnector:
4816
+ DataConnectorResource;
4470
4817
  dataStores:
4471
4818
  DataStoresResource;
4472
4819
  engines:
@@ -6008,8 +6355,10 @@ declare namespace gapi.client {
6008
6355
  quotaUser?:
6009
6356
  string;
6010
6357
  /**
6011
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
6012
- * you must create at least one serving config for it.
6358
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
6359
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
6360
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
6361
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
6013
6362
  */
6014
6363
  servingConfig:
6015
6364
  string;
@@ -6052,8 +6401,10 @@ declare namespace gapi.client {
6052
6401
  quotaUser?:
6053
6402
  string;
6054
6403
  /**
6055
- * Required. Full resource name of the format: `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` Before you can request recommendations from your model,
6056
- * you must create at least one serving config for it.
6404
+ * Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or
6405
+ * `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID
6406
+ * will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use
6407
+ * `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
6057
6408
  */
6058
6409
  servingConfig:
6059
6410
  string;
@@ -6095,8 +6446,8 @@ declare namespace gapi.client {
6095
6446
  quotaUser?:
6096
6447
  string;
6097
6448
  /**
6098
- * Required. The resource name of the Search serving config, such as
6099
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
6449
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
6450
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
6100
6451
  * configuration name, set of models used to make the search.
6101
6452
  */
6102
6453
  servingConfig:
@@ -6140,8 +6491,8 @@ declare namespace gapi.client {
6140
6491
  quotaUser?:
6141
6492
  string;
6142
6493
  /**
6143
- * Required. The resource name of the Search serving config, such as
6144
- * `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
6494
+ * Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`,
6495
+ * or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving
6145
6496
  * configuration name, set of models used to make the search.
6146
6497
  */
6147
6498
  servingConfig:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.discoveryengine-v1beta",
3
- "version": "0.0.20231026",
3
+ "version": "0.0.20231110",
4
4
  "description": "TypeScript typings for Discovery Engine API v1beta",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20231026
6
+ // Revision: 20231110
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -29,6 +29,17 @@ gapi.load('client', async () => {
29
29
  });
30
30
 
31
31
  async function run() {
32
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
33
+ await gapi.client.discoveryengine.projects.locations.collections.dataConnector.operations.get({
34
+ name: "Test string",
35
+ });
36
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
37
+ await gapi.client.discoveryengine.projects.locations.collections.dataConnector.operations.list({
38
+ filter: "Test string",
39
+ name: "Test string",
40
+ pageSize: 42,
41
+ pageToken: "Test string",
42
+ });
32
43
  /** Completes the specified user input with keyword suggestions. */
33
44
  await gapi.client.discoveryengine.projects.locations.collections.dataStores.completeQuery({
34
45
  dataStore: "Test string",
@@ -527,6 +538,7 @@ gapi.load('client', async () => {
527
538
  ],
528
539
  },
529
540
  branch: "Test string",
541
+ canonicalFilter: "Test string",
530
542
  contentSearchSpec: {
531
543
  extractiveContentSpec: {
532
544
  maxExtractiveAnswerCount: 42,
@@ -943,6 +955,7 @@ gapi.load('client', async () => {
943
955
  ],
944
956
  },
945
957
  branch: "Test string",
958
+ canonicalFilter: "Test string",
946
959
  contentSearchSpec: {
947
960
  extractiveContentSpec: {
948
961
  maxExtractiveAnswerCount: 42,
@@ -1532,6 +1545,7 @@ gapi.load('client', async () => {
1532
1545
  ],
1533
1546
  },
1534
1547
  branch: "Test string",
1548
+ canonicalFilter: "Test string",
1535
1549
  contentSearchSpec: {
1536
1550
  extractiveContentSpec: {
1537
1551
  maxExtractiveAnswerCount: 42,