@googleapis/discoveryengine 2.0.0 → 3.1.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.
package/v1beta.ts CHANGED
@@ -240,13 +240,30 @@ export namespace discoveryengine_v1beta {
240
240
  functionName?: string | null;
241
241
  }
242
242
  /**
243
- * Response message for SiteSearchEngineService.BatchCreateTargetSites method.
243
+ * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
244
244
  */
245
- export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse {
245
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata {
246
246
  /**
247
- * TargetSites created.
247
+ * Operation create time.
248
+ */
249
+ createTime?: string | null;
250
+ /**
251
+ * Operation last update time. If the operation is done, this is also the finish time.
252
+ */
253
+ updateTime?: string | null;
254
+ }
255
+ /**
256
+ * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
257
+ */
258
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata {
259
+ /**
260
+ * Operation create time.
248
261
  */
249
- targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[];
262
+ createTime?: string | null;
263
+ /**
264
+ * Operation last update time. If the operation is done, this is also the finish time.
265
+ */
266
+ updateTime?: string | null;
250
267
  }
251
268
  /**
252
269
  * Metadata for Create Schema LRO.
@@ -261,6 +278,65 @@ export namespace discoveryengine_v1beta {
261
278
  */
262
279
  updateTime?: string | null;
263
280
  }
281
+ /**
282
+ * DataStore captures global settings and configs at the DataStore level.
283
+ */
284
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStore {
285
+ /**
286
+ * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
287
+ */
288
+ contentConfig?: string | null;
289
+ /**
290
+ * Output only. Timestamp the DataStore was created at.
291
+ */
292
+ createTime?: string | null;
293
+ /**
294
+ * Output only. The id of the default Schema asscociated to this data store.
295
+ */
296
+ defaultSchemaId?: string | null;
297
+ /**
298
+ * 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.
299
+ */
300
+ displayName?: string | null;
301
+ /**
302
+ * Immutable. The industry vertical that the data store registers.
303
+ */
304
+ industryVertical?: string | null;
305
+ /**
306
+ * 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 UTF-8 encoded string with a length limit of 1024 characters.
307
+ */
308
+ name?: string | null;
309
+ /**
310
+ * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
311
+ */
312
+ solutionTypes?: string[] | null;
313
+ }
314
+ /**
315
+ * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.
316
+ */
317
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata {
318
+ /**
319
+ * Operation create time.
320
+ */
321
+ createTime?: string | null;
322
+ /**
323
+ * Operation last update time. If the operation is done, this is also the finish time.
324
+ */
325
+ updateTime?: string | null;
326
+ }
327
+ /**
328
+ * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.
329
+ */
330
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata {
331
+ /**
332
+ * Operation create time.
333
+ */
334
+ createTime?: string | null;
335
+ /**
336
+ * Operation last update time. If the operation is done, this is also the finish time.
337
+ */
338
+ updateTime?: string | null;
339
+ }
264
340
  /**
265
341
  * Metadata for DeleteSchema LRO.
266
342
  */
@@ -274,6 +350,187 @@ export namespace discoveryengine_v1beta {
274
350
  */
275
351
  updateTime?: string | null;
276
352
  }
353
+ /**
354
+ * Metadata that describes the training and serving parameters of an Engine.
355
+ */
356
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngine {
357
+ /**
358
+ * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
359
+ */
360
+ chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig;
361
+ /**
362
+ * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
363
+ */
364
+ chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata;
365
+ /**
366
+ * Common config spec that specifies the metadata of the engine.
367
+ */
368
+ commonConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig;
369
+ /**
370
+ * Output only. Timestamp the Recommendation Engine was created at.
371
+ */
372
+ createTime?: string | null;
373
+ /**
374
+ * 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 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 as the system will use it for necessary intializations.
375
+ */
376
+ dataStoreIds?: string[] | null;
377
+ /**
378
+ * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
379
+ */
380
+ displayName?: string | null;
381
+ /**
382
+ * 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 to match vertical of the DataStore liniked to the engine.
383
+ */
384
+ industryVertical?: string | null;
385
+ /**
386
+ * Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
387
+ */
388
+ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
389
+ /**
390
+ * 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: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned.
391
+ */
392
+ name?: string | null;
393
+ /**
394
+ * Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
395
+ */
396
+ recommendationMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata;
397
+ /**
398
+ * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
399
+ */
400
+ searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig;
401
+ /**
402
+ * Additional config specs for a `similar-items` engine.
403
+ */
404
+ similarDocumentsConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig;
405
+ /**
406
+ * Required. The solutions of the engine.
407
+ */
408
+ solutionType?: string | null;
409
+ /**
410
+ * Output only. Timestamp the Recommendation Engine was last updated.
411
+ */
412
+ updateTime?: string | null;
413
+ }
414
+ /**
415
+ * Configurations for a Chat Engine.
416
+ */
417
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig {
418
+ /**
419
+ * 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 means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
420
+ */
421
+ agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig;
422
+ /**
423
+ * 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 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 they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Please use chat_engine_metadata.dialogflow_agent for actual agent association after Engine is created.
424
+ */
425
+ dialogflowAgentToLink?: string | null;
426
+ }
427
+ /**
428
+ * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.
429
+ */
430
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig {
431
+ /**
432
+ * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
433
+ */
434
+ business?: string | null;
435
+ /**
436
+ * 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 supported language codes.
437
+ */
438
+ defaultLanguageCode?: string | null;
439
+ /**
440
+ * 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.
441
+ */
442
+ timeZone?: string | null;
443
+ }
444
+ /**
445
+ * Additional information of a Chat Engine. Fields in this message are output only.
446
+ */
447
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata {
448
+ /**
449
+ * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.
450
+ */
451
+ dialogflowAgent?: string | null;
452
+ }
453
+ /**
454
+ * Common configurations for an Engine.
455
+ */
456
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineCommonConfig {
457
+ /**
458
+ * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.
459
+ */
460
+ companyName?: string | null;
461
+ }
462
+ /**
463
+ * Additional config specs for a Media Recommendation engine.
464
+ */
465
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig {
466
+ /**
467
+ * 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 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` =\> `ctr`
468
+ */
469
+ optimizationObjective?: string | null;
470
+ /**
471
+ * 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 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] (excludes 0, includes 1.0) (e.g., 0.5).
472
+ */
473
+ optimizationObjectiveConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig;
474
+ /**
475
+ * 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 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 state the same as before.
476
+ */
477
+ trainingState?: string | null;
478
+ /**
479
+ * 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. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.
480
+ */
481
+ type?: string | null;
482
+ }
483
+ /**
484
+ * Custom threshold for `cvr` optimization_objective.
485
+ */
486
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig {
487
+ /**
488
+ * Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.
489
+ */
490
+ targetField?: string | null;
491
+ /**
492
+ * Required. The threshold to be applied to the target (e.g., 0.5).
493
+ */
494
+ targetFieldValueFloat?: number | null;
495
+ }
496
+ /**
497
+ * Additional information of a recommendation engine.
498
+ */
499
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata {
500
+ /**
501
+ * 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` 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.
502
+ */
503
+ dataState?: string | null;
504
+ /**
505
+ * Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.
506
+ */
507
+ lastTuneTime?: string | null;
508
+ /**
509
+ * Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.
510
+ */
511
+ servingState?: string | null;
512
+ /**
513
+ * 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 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 happened for this engine, the string is empty.
514
+ */
515
+ tuningOperation?: string | null;
516
+ }
517
+ /**
518
+ * Configurations for a Search Engine.
519
+ */
520
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig {
521
+ /**
522
+ * The add-on that this search engine enables.
523
+ */
524
+ searchAddOns?: string[] | null;
525
+ /**
526
+ * The search feature tier of this engine. Different tiers might have different pricing. To learn more, please check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.
527
+ */
528
+ searchTier?: string | null;
529
+ }
530
+ /**
531
+ * Additional config specs for a `similar-items` engine.
532
+ */
533
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig {}
277
534
  /**
278
535
  * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.
279
536
  */
@@ -621,6 +878,19 @@ export namespace discoveryengine_v1beta {
621
878
  quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure;
622
879
  }
623
880
  export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure {}
881
+ /**
882
+ * Metadata associated with a tune operation.
883
+ */
884
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata {
885
+ /**
886
+ * 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\}`
887
+ */
888
+ engine?: string | null;
889
+ }
890
+ /**
891
+ * Response associated with a tune operation.
892
+ */
893
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {}
624
894
  /**
625
895
  * Metadata for UpdateSchema LRO.
626
896
  */
@@ -1275,7 +1545,7 @@ export namespace discoveryengine_v1beta {
1275
1545
  */
1276
1546
  export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest {
1277
1547
  /**
1278
- * Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
1548
+ * Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
1279
1549
  */
1280
1550
  filter?: string | null;
1281
1551
  /**
@@ -1283,7 +1553,7 @@ export namespace discoveryengine_v1beta {
1283
1553
  */
1284
1554
  pageSize?: number | null;
1285
1555
  /**
1286
- * Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category.
1556
+ * Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
1287
1557
  */
1288
1558
  params?: {[key: string]: any} | null;
1289
1559
  /**
@@ -1414,13 +1684,17 @@ export namespace discoveryengine_v1beta {
1414
1684
  */
1415
1685
  export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest {
1416
1686
  /**
1417
- * Boost specification to boost certain documents.
1687
+ * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
1418
1688
  */
1419
1689
  boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec;
1420
1690
  /**
1421
1691
  * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
1422
1692
  */
1423
1693
  branch?: string | null;
1694
+ /**
1695
+ * 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 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 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 filter syntax, see SearchRequest.filter.
1696
+ */
1697
+ canonicalFilter?: string | null;
1424
1698
  /**
1425
1699
  * A specification for configuring the behavior of content search.
1426
1700
  */
@@ -1434,7 +1708,7 @@ export namespace discoveryengine_v1beta {
1434
1708
  */
1435
1709
  facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[];
1436
1710
  /**
1437
- * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
1711
+ * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
1438
1712
  */
1439
1713
  filter?: string | null;
1440
1714
  /**
@@ -1446,7 +1720,7 @@ export namespace discoveryengine_v1beta {
1446
1720
  */
1447
1721
  offset?: number | null;
1448
1722
  /**
1449
- * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
1723
+ * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
1450
1724
  */
1451
1725
  orderBy?: string | null;
1452
1726
  /**
@@ -1458,7 +1732,7 @@ export namespace discoveryengine_v1beta {
1458
1732
  */
1459
1733
  pageToken?: string | null;
1460
1734
  /**
1461
- * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.
1735
+ * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1
1462
1736
  */
1463
1737
  params?: {[key: string]: any} | null;
1464
1738
  /**
@@ -2319,11 +2593,14 @@ export namespace discoveryengine_v1beta {
2319
2593
 
2320
2594
  export class Resource$Projects$Locations$Collections {
2321
2595
  context: APIRequestContext;
2596
+ dataConnector: Resource$Projects$Locations$Collections$Dataconnector;
2322
2597
  dataStores: Resource$Projects$Locations$Collections$Datastores;
2323
2598
  engines: Resource$Projects$Locations$Collections$Engines;
2324
2599
  operations: Resource$Projects$Locations$Collections$Operations;
2325
2600
  constructor(context: APIRequestContext) {
2326
2601
  this.context = context;
2602
+ this.dataConnector =
2603
+ new Resource$Projects$Locations$Collections$Dataconnector(this.context);
2327
2604
  this.dataStores = new Resource$Projects$Locations$Collections$Datastores(
2328
2605
  this.context
2329
2606
  );
@@ -2336,6 +2613,243 @@ export namespace discoveryengine_v1beta {
2336
2613
  }
2337
2614
  }
2338
2615
 
2616
+ export class Resource$Projects$Locations$Collections$Dataconnector {
2617
+ context: APIRequestContext;
2618
+ operations: Resource$Projects$Locations$Collections$Dataconnector$Operations;
2619
+ constructor(context: APIRequestContext) {
2620
+ this.context = context;
2621
+ this.operations =
2622
+ new Resource$Projects$Locations$Collections$Dataconnector$Operations(
2623
+ this.context
2624
+ );
2625
+ }
2626
+ }
2627
+
2628
+ export class Resource$Projects$Locations$Collections$Dataconnector$Operations {
2629
+ context: APIRequestContext;
2630
+ constructor(context: APIRequestContext) {
2631
+ this.context = context;
2632
+ }
2633
+
2634
+ /**
2635
+ * 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.
2636
+ *
2637
+ * @param params - Parameters for request
2638
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2639
+ * @param callback - Optional callback that handles the response.
2640
+ * @returns A promise if used with async/await, or void if used with a callback.
2641
+ */
2642
+ get(
2643
+ params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
2644
+ options: StreamMethodOptions
2645
+ ): GaxiosPromise<Readable>;
2646
+ get(
2647
+ params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
2648
+ options?: MethodOptions
2649
+ ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
2650
+ get(
2651
+ params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
2652
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
2653
+ callback: BodyResponseCallback<Readable>
2654
+ ): void;
2655
+ get(
2656
+ params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
2657
+ options:
2658
+ | MethodOptions
2659
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
2660
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
2661
+ ): void;
2662
+ get(
2663
+ params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get,
2664
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
2665
+ ): void;
2666
+ get(
2667
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
2668
+ ): void;
2669
+ get(
2670
+ paramsOrCallback?:
2671
+ | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get
2672
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
2673
+ | BodyResponseCallback<Readable>,
2674
+ optionsOrCallback?:
2675
+ | MethodOptions
2676
+ | StreamMethodOptions
2677
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
2678
+ | BodyResponseCallback<Readable>,
2679
+ callback?:
2680
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
2681
+ | BodyResponseCallback<Readable>
2682
+ ):
2683
+ | void
2684
+ | GaxiosPromise<Schema$GoogleLongrunningOperation>
2685
+ | GaxiosPromise<Readable> {
2686
+ let params = (paramsOrCallback ||
2687
+ {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get;
2688
+ let options = (optionsOrCallback || {}) as MethodOptions;
2689
+
2690
+ if (typeof paramsOrCallback === 'function') {
2691
+ callback = paramsOrCallback;
2692
+ params =
2693
+ {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get;
2694
+ options = {};
2695
+ }
2696
+
2697
+ if (typeof optionsOrCallback === 'function') {
2698
+ callback = optionsOrCallback;
2699
+ options = {};
2700
+ }
2701
+
2702
+ const rootUrl =
2703
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
2704
+ const parameters = {
2705
+ options: Object.assign(
2706
+ {
2707
+ url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
2708
+ method: 'GET',
2709
+ },
2710
+ options
2711
+ ),
2712
+ params,
2713
+ requiredParams: ['name'],
2714
+ pathParams: ['name'],
2715
+ context: this.context,
2716
+ };
2717
+ if (callback) {
2718
+ createAPIRequest<Schema$GoogleLongrunningOperation>(
2719
+ parameters,
2720
+ callback as BodyResponseCallback<unknown>
2721
+ );
2722
+ } else {
2723
+ return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
2724
+ }
2725
+ }
2726
+
2727
+ /**
2728
+ * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
2729
+ *
2730
+ * @param params - Parameters for request
2731
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2732
+ * @param callback - Optional callback that handles the response.
2733
+ * @returns A promise if used with async/await, or void if used with a callback.
2734
+ */
2735
+ list(
2736
+ params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
2737
+ options: StreamMethodOptions
2738
+ ): GaxiosPromise<Readable>;
2739
+ list(
2740
+ params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
2741
+ options?: MethodOptions
2742
+ ): GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>;
2743
+ list(
2744
+ params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
2745
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
2746
+ callback: BodyResponseCallback<Readable>
2747
+ ): void;
2748
+ list(
2749
+ params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
2750
+ options:
2751
+ | MethodOptions
2752
+ | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>,
2753
+ callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
2754
+ ): void;
2755
+ list(
2756
+ params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List,
2757
+ callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
2758
+ ): void;
2759
+ list(
2760
+ callback: BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
2761
+ ): void;
2762
+ list(
2763
+ paramsOrCallback?:
2764
+ | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List
2765
+ | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
2766
+ | BodyResponseCallback<Readable>,
2767
+ optionsOrCallback?:
2768
+ | MethodOptions
2769
+ | StreamMethodOptions
2770
+ | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
2771
+ | BodyResponseCallback<Readable>,
2772
+ callback?:
2773
+ | BodyResponseCallback<Schema$GoogleLongrunningListOperationsResponse>
2774
+ | BodyResponseCallback<Readable>
2775
+ ):
2776
+ | void
2777
+ | GaxiosPromise<Schema$GoogleLongrunningListOperationsResponse>
2778
+ | GaxiosPromise<Readable> {
2779
+ let params = (paramsOrCallback ||
2780
+ {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List;
2781
+ let options = (optionsOrCallback || {}) as MethodOptions;
2782
+
2783
+ if (typeof paramsOrCallback === 'function') {
2784
+ callback = paramsOrCallback;
2785
+ params =
2786
+ {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List;
2787
+ options = {};
2788
+ }
2789
+
2790
+ if (typeof optionsOrCallback === 'function') {
2791
+ callback = optionsOrCallback;
2792
+ options = {};
2793
+ }
2794
+
2795
+ const rootUrl =
2796
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
2797
+ const parameters = {
2798
+ options: Object.assign(
2799
+ {
2800
+ url: (rootUrl + '/v1beta/{+name}/operations').replace(
2801
+ /([^:]\/)\/+/g,
2802
+ '$1'
2803
+ ),
2804
+ method: 'GET',
2805
+ },
2806
+ options
2807
+ ),
2808
+ params,
2809
+ requiredParams: ['name'],
2810
+ pathParams: ['name'],
2811
+ context: this.context,
2812
+ };
2813
+ if (callback) {
2814
+ createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
2815
+ parameters,
2816
+ callback as BodyResponseCallback<unknown>
2817
+ );
2818
+ } else {
2819
+ return createAPIRequest<Schema$GoogleLongrunningListOperationsResponse>(
2820
+ parameters
2821
+ );
2822
+ }
2823
+ }
2824
+ }
2825
+
2826
+ export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get
2827
+ extends StandardParameters {
2828
+ /**
2829
+ * The name of the operation resource.
2830
+ */
2831
+ name?: string;
2832
+ }
2833
+ export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List
2834
+ extends StandardParameters {
2835
+ /**
2836
+ * The standard list filter.
2837
+ */
2838
+ filter?: string;
2839
+ /**
2840
+ * The name of the operation's parent resource.
2841
+ */
2842
+ name?: string;
2843
+ /**
2844
+ * The standard list page size.
2845
+ */
2846
+ pageSize?: number;
2847
+ /**
2848
+ * The standard list page token.
2849
+ */
2850
+ pageToken?: string;
2851
+ }
2852
+
2339
2853
  export class Resource$Projects$Locations$Collections$Datastores {
2340
2854
  context: APIRequestContext;
2341
2855
  branches: Resource$Projects$Locations$Collections$Datastores$Branches;
@@ -5607,7 +6121,7 @@ export namespace discoveryengine_v1beta {
5607
6121
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
5608
6122
  extends StandardParameters {
5609
6123
  /**
5610
- * Required. Full resource name of the format: `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` Before you can request recommendations from your model, you must create at least one serving config for it.
6124
+ * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
5611
6125
  */
5612
6126
  servingConfig?: string;
5613
6127
 
@@ -5619,7 +6133,7 @@ export namespace discoveryengine_v1beta {
5619
6133
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
5620
6134
  extends StandardParameters {
5621
6135
  /**
5622
- * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
6136
+ * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
5623
6137
  */
5624
6138
  servingConfig?: string;
5625
6139
 
@@ -6893,7 +7407,7 @@ export namespace discoveryengine_v1beta {
6893
7407
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
6894
7408
  extends StandardParameters {
6895
7409
  /**
6896
- * Required. Full resource name of the format: `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` Before you can request recommendations from your model, you must create at least one serving config for it.
7410
+ * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
6897
7411
  */
6898
7412
  servingConfig?: string;
6899
7413
 
@@ -6905,7 +7419,7 @@ export namespace discoveryengine_v1beta {
6905
7419
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search
6906
7420
  extends StandardParameters {
6907
7421
  /**
6908
- * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
7422
+ * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
6909
7423
  */
6910
7424
  servingConfig?: string;
6911
7425
 
@@ -10167,7 +10681,7 @@ export namespace discoveryengine_v1beta {
10167
10681
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend
10168
10682
  extends StandardParameters {
10169
10683
  /**
10170
- * Required. Full resource name of the format: `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` Before you can request recommendations from your model, you must create at least one serving config for it.
10684
+ * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your Recommend requests.
10171
10685
  */
10172
10686
  servingConfig?: string;
10173
10687
 
@@ -10179,7 +10693,7 @@ export namespace discoveryengine_v1beta {
10179
10693
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search
10180
10694
  extends StandardParameters {
10181
10695
  /**
10182
- * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
10696
+ * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
10183
10697
  */
10184
10698
  servingConfig?: string;
10185
10699