@googleapis/discoveryengine 6.0.0 → 6.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/v1alpha.ts CHANGED
@@ -573,6 +573,15 @@ export namespace discoveryengine_v1alpha {
573
573
  */
574
574
  text?: string[] | null;
575
575
  }
576
+ /**
577
+ * Defines custom fine tuning spec.
578
+ */
579
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec {
580
+ /**
581
+ * Whether or not to enable and include custom fine tuned search adaptor model.
582
+ */
583
+ enableSearchAdaptor?: boolean | null;
584
+ }
576
585
  /**
577
586
  * DataStore captures global settings and configs at the DataStore level.
578
587
  */
@@ -813,6 +822,15 @@ export namespace discoveryengine_v1alpha {
813
822
  */
814
823
  values?: number[] | null;
815
824
  }
825
+ /**
826
+ * Defines embedding config, used for bring your own embeddings feature.
827
+ */
828
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig {
829
+ /**
830
+ * Full field path in the schema mapped as embedding field.
831
+ */
832
+ fieldPath?: string | null;
833
+ }
816
834
  /**
817
835
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
818
836
  */
@@ -1164,6 +1182,23 @@ export namespace discoveryengine_v1alpha {
1164
1182
  */
1165
1183
  inputUris?: string[] | null;
1166
1184
  }
1185
+ /**
1186
+ * Defines guided search spec.
1187
+ */
1188
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
1189
+ /**
1190
+ * Whether or not to enable and include refinement attributes in gudied search result.
1191
+ */
1192
+ enableRefinementAttributes?: boolean | null;
1193
+ /**
1194
+ * Whether or not to enable and include related questions in search response.
1195
+ */
1196
+ enableRelatedQuestions?: boolean | null;
1197
+ /**
1198
+ * Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.
1199
+ */
1200
+ maxRelatedQuestions?: number | null;
1201
+ }
1167
1202
  /**
1168
1203
  * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
1169
1204
  */
@@ -1463,6 +1498,19 @@ export namespace discoveryengine_v1alpha {
1463
1498
  */
1464
1499
  schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
1465
1500
  }
1501
+ /**
1502
+ * Response for ListServingConfigs method.
1503
+ */
1504
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse {
1505
+ /**
1506
+ * Pagination token, if not returned indicates the last page.
1507
+ */
1508
+ nextPageToken?: string | null;
1509
+ /**
1510
+ * All the ServingConfigs for a given dataStore.
1511
+ */
1512
+ servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[];
1513
+ }
1466
1514
  /**
1467
1515
  * Response message for SiteSearchEngineService.ListTargetSites method.
1468
1516
  */
@@ -2152,7 +2200,7 @@ export namespace discoveryengine_v1alpha {
2152
2200
  */
2153
2201
  export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
2154
2202
  /**
2155
- * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English.
2203
+ * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. LINT.IfChange * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English. LINT.ThenChange(//depot/google3/cloud/console/web/ai/unified_cloud_search/pages/configurations/widget_tab.ts)
2156
2204
  */
2157
2205
  version?: string | null;
2158
2206
  }
@@ -2518,6 +2566,126 @@ export namespace discoveryengine_v1alpha {
2518
2566
  */
2519
2567
  summary?: string | null;
2520
2568
  }
2569
+ /**
2570
+ * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.
2571
+ */
2572
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfig {
2573
+ /**
2574
+ * Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.
2575
+ */
2576
+ boostControlIds?: string[] | null;
2577
+ /**
2578
+ * Output only. ServingConfig created timestamp.
2579
+ */
2580
+ createTime?: string | null;
2581
+ /**
2582
+ * Custom fine tuning configs.
2583
+ */
2584
+ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
2585
+ /**
2586
+ * Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
2587
+ */
2588
+ displayName?: string | null;
2589
+ /**
2590
+ * Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2591
+ */
2592
+ dissociateControlIds?: string[] | null;
2593
+ /**
2594
+ * How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
2595
+ */
2596
+ diversityLevel?: string | null;
2597
+ /**
2598
+ * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.
2599
+ */
2600
+ embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig;
2601
+ /**
2602
+ * Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.
2603
+ */
2604
+ filterControlIds?: string[] | null;
2605
+ /**
2606
+ * The GenericConfig of the serving configuration.
2607
+ */
2608
+ genericConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig;
2609
+ /**
2610
+ * Guided search configs.
2611
+ */
2612
+ guidedSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec;
2613
+ /**
2614
+ * Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.
2615
+ */
2616
+ ignoreControlIds?: string[] | null;
2617
+ /**
2618
+ * The MediaConfig of the serving configuration.
2619
+ */
2620
+ mediaConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
2621
+ /**
2622
+ * The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.
2623
+ */
2624
+ modelId?: string | null;
2625
+ /**
2626
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
2627
+ */
2628
+ name?: string | null;
2629
+ /**
2630
+ * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2631
+ */
2632
+ onewaySynonymsControlIds?: string[] | null;
2633
+ rankingExpression?: string | null;
2634
+ /**
2635
+ * IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2636
+ */
2637
+ redirectControlIds?: string[] | null;
2638
+ /**
2639
+ * Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2640
+ */
2641
+ replacementControlIds?: string[] | null;
2642
+ /**
2643
+ * Required. Immutable. Specifies the solution type that a serving config can be associated with.
2644
+ */
2645
+ solutionType?: string | null;
2646
+ /**
2647
+ * Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.
2648
+ */
2649
+ synonymsControlIds?: string[] | null;
2650
+ /**
2651
+ * Output only. ServingConfig updated timestamp.
2652
+ */
2653
+ updateTime?: string | null;
2654
+ }
2655
+ /**
2656
+ * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
2657
+ */
2658
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig {
2659
+ /**
2660
+ * Specifies the expected behavior of content search. Only valid for content-search enabled data store.
2661
+ */
2662
+ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
2663
+ }
2664
+ /**
2665
+ * Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.
2666
+ */
2667
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
2668
+ /**
2669
+ * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
2670
+ */
2671
+ contentFreshnessCutoffDays?: number | null;
2672
+ /**
2673
+ * Specifies the content watched minutes threshold for demotion.
2674
+ */
2675
+ contentWatchedMinutesThreshold?: number | null;
2676
+ /**
2677
+ * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
2678
+ */
2679
+ contentWatchedPercentageThreshold?: number | null;
2680
+ /**
2681
+ * Specifies the content watched minutes threshold for demotion.
2682
+ */
2683
+ contentWatchedSecondsThreshold?: number | null;
2684
+ /**
2685
+ * Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.
2686
+ */
2687
+ demotionEventType?: string | null;
2688
+ }
2521
2689
  /**
2522
2690
  * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
2523
2691
  */
@@ -9243,65 +9411,65 @@ export namespace discoveryengine_v1alpha {
9243
9411
  }
9244
9412
 
9245
9413
  /**
9246
- * Makes a recommendation, which requires a contextual user event.
9414
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
9247
9415
  *
9248
9416
  * @param params - Parameters for request
9249
9417
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9250
9418
  * @param callback - Optional callback that handles the response.
9251
9419
  * @returns A promise if used with async/await, or void if used with a callback.
9252
9420
  */
9253
- recommend(
9254
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9421
+ get(
9422
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9255
9423
  options: StreamMethodOptions
9256
9424
  ): GaxiosPromise<Readable>;
9257
- recommend(
9258
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9425
+ get(
9426
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9259
9427
  options?: MethodOptions
9260
- ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
9261
- recommend(
9262
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9428
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
9429
+ get(
9430
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9263
9431
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
9264
9432
  callback: BodyResponseCallback<Readable>
9265
9433
  ): void;
9266
- recommend(
9267
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9434
+ get(
9435
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9268
9436
  options:
9269
9437
  | MethodOptions
9270
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>,
9271
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9438
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
9439
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9272
9440
  ): void;
9273
- recommend(
9274
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9275
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9441
+ get(
9442
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
9443
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9276
9444
  ): void;
9277
- recommend(
9278
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9445
+ get(
9446
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9279
9447
  ): void;
9280
- recommend(
9448
+ get(
9281
9449
  paramsOrCallback?:
9282
- | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
9283
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9450
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
9451
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9284
9452
  | BodyResponseCallback<Readable>,
9285
9453
  optionsOrCallback?:
9286
9454
  | MethodOptions
9287
9455
  | StreamMethodOptions
9288
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9456
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9289
9457
  | BodyResponseCallback<Readable>,
9290
9458
  callback?:
9291
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9459
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9292
9460
  | BodyResponseCallback<Readable>
9293
9461
  ):
9294
9462
  | void
9295
- | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9463
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9296
9464
  | GaxiosPromise<Readable> {
9297
9465
  let params = (paramsOrCallback ||
9298
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
9466
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
9299
9467
  let options = (optionsOrCallback || {}) as MethodOptions;
9300
9468
 
9301
9469
  if (typeof paramsOrCallback === 'function') {
9302
9470
  callback = paramsOrCallback;
9303
9471
  params =
9304
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
9472
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
9305
9473
  options = {};
9306
9474
  }
9307
9475
 
@@ -9315,91 +9483,88 @@ export namespace discoveryengine_v1alpha {
9315
9483
  const parameters = {
9316
9484
  options: Object.assign(
9317
9485
  {
9318
- url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace(
9319
- /([^:]\/)\/+/g,
9320
- '$1'
9321
- ),
9322
- method: 'POST',
9486
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
9487
+ method: 'GET',
9323
9488
  },
9324
9489
  options
9325
9490
  ),
9326
9491
  params,
9327
- requiredParams: ['servingConfig'],
9328
- pathParams: ['servingConfig'],
9492
+ requiredParams: ['name'],
9493
+ pathParams: ['name'],
9329
9494
  context: this.context,
9330
9495
  };
9331
9496
  if (callback) {
9332
- createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
9497
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
9333
9498
  parameters,
9334
9499
  callback as BodyResponseCallback<unknown>
9335
9500
  );
9336
9501
  } else {
9337
- return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
9502
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
9338
9503
  parameters
9339
9504
  );
9340
9505
  }
9341
9506
  }
9342
9507
 
9343
9508
  /**
9344
- * Performs a search.
9509
+ * Lists all ServingConfigs linked to this dataStore.
9345
9510
  *
9346
9511
  * @param params - Parameters for request
9347
9512
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9348
9513
  * @param callback - Optional callback that handles the response.
9349
9514
  * @returns A promise if used with async/await, or void if used with a callback.
9350
9515
  */
9351
- search(
9352
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9516
+ list(
9517
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9353
9518
  options: StreamMethodOptions
9354
9519
  ): GaxiosPromise<Readable>;
9355
- search(
9356
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9520
+ list(
9521
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9357
9522
  options?: MethodOptions
9358
- ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
9359
- search(
9360
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9523
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
9524
+ list(
9525
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9361
9526
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
9362
9527
  callback: BodyResponseCallback<Readable>
9363
9528
  ): void;
9364
- search(
9365
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9529
+ list(
9530
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9366
9531
  options:
9367
9532
  | MethodOptions
9368
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>,
9369
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9533
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
9534
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9370
9535
  ): void;
9371
- search(
9372
- params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9373
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9536
+ list(
9537
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
9538
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9374
9539
  ): void;
9375
- search(
9376
- callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9540
+ list(
9541
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9377
9542
  ): void;
9378
- search(
9543
+ list(
9379
9544
  paramsOrCallback?:
9380
- | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
9381
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9545
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
9546
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9382
9547
  | BodyResponseCallback<Readable>,
9383
9548
  optionsOrCallback?:
9384
9549
  | MethodOptions
9385
9550
  | StreamMethodOptions
9386
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9551
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9387
9552
  | BodyResponseCallback<Readable>,
9388
9553
  callback?:
9389
- | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9554
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9390
9555
  | BodyResponseCallback<Readable>
9391
9556
  ):
9392
9557
  | void
9393
- | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9558
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
9394
9559
  | GaxiosPromise<Readable> {
9395
9560
  let params = (paramsOrCallback ||
9396
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search;
9561
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
9397
9562
  let options = (optionsOrCallback || {}) as MethodOptions;
9398
9563
 
9399
9564
  if (typeof paramsOrCallback === 'function') {
9400
9565
  callback = paramsOrCallback;
9401
9566
  params =
9402
- {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search;
9567
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
9403
9568
  options = {};
9404
9569
  }
9405
9570
 
@@ -9413,127 +9578,456 @@ export namespace discoveryengine_v1alpha {
9413
9578
  const parameters = {
9414
9579
  options: Object.assign(
9415
9580
  {
9416
- url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace(
9581
+ url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
9417
9582
  /([^:]\/)\/+/g,
9418
9583
  '$1'
9419
9584
  ),
9420
- method: 'POST',
9585
+ method: 'GET',
9421
9586
  },
9422
9587
  options
9423
9588
  ),
9424
9589
  params,
9425
- requiredParams: ['servingConfig'],
9426
- pathParams: ['servingConfig'],
9590
+ requiredParams: ['parent'],
9591
+ pathParams: ['parent'],
9427
9592
  context: this.context,
9428
9593
  };
9429
9594
  if (callback) {
9430
- createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
9595
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
9431
9596
  parameters,
9432
9597
  callback as BodyResponseCallback<unknown>
9433
9598
  );
9434
9599
  } else {
9435
- return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
9600
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
9436
9601
  parameters
9437
9602
  );
9438
9603
  }
9439
9604
  }
9440
- }
9441
-
9442
- export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
9443
- extends StandardParameters {
9444
- /**
9445
- * 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 RecommendationService.Recommend requests.
9446
- */
9447
- servingConfig?: string;
9448
-
9449
- /**
9450
- * Request body metadata
9451
- */
9452
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
9453
- }
9454
- export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
9455
- extends StandardParameters {
9456
- /**
9457
- * 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.
9458
- */
9459
- servingConfig?: string;
9460
-
9461
- /**
9462
- * Request body metadata
9463
- */
9464
- requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
9465
- }
9466
-
9467
- export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
9468
- context: APIRequestContext;
9469
- operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
9470
- targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
9471
- constructor(context: APIRequestContext) {
9472
- this.context = context;
9473
- this.operations =
9474
- new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations(
9475
- this.context
9476
- );
9477
- this.targetSites =
9478
- new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites(
9479
- this.context
9480
- );
9481
- }
9482
9605
 
9483
9606
  /**
9484
- * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
9607
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
9485
9608
  *
9486
9609
  * @param params - Parameters for request
9487
9610
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9488
9611
  * @param callback - Optional callback that handles the response.
9489
9612
  * @returns A promise if used with async/await, or void if used with a callback.
9490
9613
  */
9491
- batchVerifyTargetSites(
9492
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9614
+ patch(
9615
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9493
9616
  options: StreamMethodOptions
9494
9617
  ): GaxiosPromise<Readable>;
9495
- batchVerifyTargetSites(
9496
- params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9618
+ patch(
9619
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9497
9620
  options?: MethodOptions
9498
- ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
9499
- batchVerifyTargetSites(
9500
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9621
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
9622
+ patch(
9623
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9501
9624
  options: StreamMethodOptions | BodyResponseCallback<Readable>,
9502
9625
  callback: BodyResponseCallback<Readable>
9503
9626
  ): void;
9504
- batchVerifyTargetSites(
9505
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9627
+ patch(
9628
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9506
9629
  options:
9507
9630
  | MethodOptions
9508
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
9509
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
9631
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
9632
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9510
9633
  ): void;
9511
- batchVerifyTargetSites(
9512
- params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9513
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
9634
+ patch(
9635
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch,
9636
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9514
9637
  ): void;
9515
- batchVerifyTargetSites(
9516
- callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
9638
+ patch(
9639
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9517
9640
  ): void;
9518
- batchVerifyTargetSites(
9641
+ patch(
9519
9642
  paramsOrCallback?:
9520
- | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites
9521
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
9643
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
9644
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9522
9645
  | BodyResponseCallback<Readable>,
9523
9646
  optionsOrCallback?:
9524
9647
  | MethodOptions
9525
9648
  | StreamMethodOptions
9526
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
9649
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9527
9650
  | BodyResponseCallback<Readable>,
9528
9651
  callback?:
9529
- | BodyResponseCallback<Schema$GoogleLongrunningOperation>
9652
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9530
9653
  | BodyResponseCallback<Readable>
9531
9654
  ):
9532
9655
  | void
9533
- | GaxiosPromise<Schema$GoogleLongrunningOperation>
9656
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
9534
9657
  | GaxiosPromise<Readable> {
9535
9658
  let params = (paramsOrCallback ||
9536
- {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites;
9659
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch;
9660
+ let options = (optionsOrCallback || {}) as MethodOptions;
9661
+
9662
+ if (typeof paramsOrCallback === 'function') {
9663
+ callback = paramsOrCallback;
9664
+ params =
9665
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch;
9666
+ options = {};
9667
+ }
9668
+
9669
+ if (typeof optionsOrCallback === 'function') {
9670
+ callback = optionsOrCallback;
9671
+ options = {};
9672
+ }
9673
+
9674
+ const rootUrl =
9675
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
9676
+ const parameters = {
9677
+ options: Object.assign(
9678
+ {
9679
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
9680
+ method: 'PATCH',
9681
+ },
9682
+ options
9683
+ ),
9684
+ params,
9685
+ requiredParams: ['name'],
9686
+ pathParams: ['name'],
9687
+ context: this.context,
9688
+ };
9689
+ if (callback) {
9690
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
9691
+ parameters,
9692
+ callback as BodyResponseCallback<unknown>
9693
+ );
9694
+ } else {
9695
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
9696
+ parameters
9697
+ );
9698
+ }
9699
+ }
9700
+
9701
+ /**
9702
+ * Makes a recommendation, which requires a contextual user event.
9703
+ *
9704
+ * @param params - Parameters for request
9705
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9706
+ * @param callback - Optional callback that handles the response.
9707
+ * @returns A promise if used with async/await, or void if used with a callback.
9708
+ */
9709
+ recommend(
9710
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9711
+ options: StreamMethodOptions
9712
+ ): GaxiosPromise<Readable>;
9713
+ recommend(
9714
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9715
+ options?: MethodOptions
9716
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
9717
+ recommend(
9718
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9719
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9720
+ callback: BodyResponseCallback<Readable>
9721
+ ): void;
9722
+ recommend(
9723
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9724
+ options:
9725
+ | MethodOptions
9726
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>,
9727
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9728
+ ): void;
9729
+ recommend(
9730
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend,
9731
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9732
+ ): void;
9733
+ recommend(
9734
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9735
+ ): void;
9736
+ recommend(
9737
+ paramsOrCallback?:
9738
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
9739
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9740
+ | BodyResponseCallback<Readable>,
9741
+ optionsOrCallback?:
9742
+ | MethodOptions
9743
+ | StreamMethodOptions
9744
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9745
+ | BodyResponseCallback<Readable>,
9746
+ callback?:
9747
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9748
+ | BodyResponseCallback<Readable>
9749
+ ):
9750
+ | void
9751
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>
9752
+ | GaxiosPromise<Readable> {
9753
+ let params = (paramsOrCallback ||
9754
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
9755
+ let options = (optionsOrCallback || {}) as MethodOptions;
9756
+
9757
+ if (typeof paramsOrCallback === 'function') {
9758
+ callback = paramsOrCallback;
9759
+ params =
9760
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend;
9761
+ options = {};
9762
+ }
9763
+
9764
+ if (typeof optionsOrCallback === 'function') {
9765
+ callback = optionsOrCallback;
9766
+ options = {};
9767
+ }
9768
+
9769
+ const rootUrl =
9770
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
9771
+ const parameters = {
9772
+ options: Object.assign(
9773
+ {
9774
+ url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace(
9775
+ /([^:]\/)\/+/g,
9776
+ '$1'
9777
+ ),
9778
+ method: 'POST',
9779
+ },
9780
+ options
9781
+ ),
9782
+ params,
9783
+ requiredParams: ['servingConfig'],
9784
+ pathParams: ['servingConfig'],
9785
+ context: this.context,
9786
+ };
9787
+ if (callback) {
9788
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
9789
+ parameters,
9790
+ callback as BodyResponseCallback<unknown>
9791
+ );
9792
+ } else {
9793
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaRecommendResponse>(
9794
+ parameters
9795
+ );
9796
+ }
9797
+ }
9798
+
9799
+ /**
9800
+ * Performs a search.
9801
+ *
9802
+ * @param params - Parameters for request
9803
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9804
+ * @param callback - Optional callback that handles the response.
9805
+ * @returns A promise if used with async/await, or void if used with a callback.
9806
+ */
9807
+ search(
9808
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9809
+ options: StreamMethodOptions
9810
+ ): GaxiosPromise<Readable>;
9811
+ search(
9812
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9813
+ options?: MethodOptions
9814
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>;
9815
+ search(
9816
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9817
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9818
+ callback: BodyResponseCallback<Readable>
9819
+ ): void;
9820
+ search(
9821
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9822
+ options:
9823
+ | MethodOptions
9824
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>,
9825
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9826
+ ): void;
9827
+ search(
9828
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search,
9829
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9830
+ ): void;
9831
+ search(
9832
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9833
+ ): void;
9834
+ search(
9835
+ paramsOrCallback?:
9836
+ | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
9837
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9838
+ | BodyResponseCallback<Readable>,
9839
+ optionsOrCallback?:
9840
+ | MethodOptions
9841
+ | StreamMethodOptions
9842
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9843
+ | BodyResponseCallback<Readable>,
9844
+ callback?:
9845
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9846
+ | BodyResponseCallback<Readable>
9847
+ ):
9848
+ | void
9849
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>
9850
+ | GaxiosPromise<Readable> {
9851
+ let params = (paramsOrCallback ||
9852
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search;
9853
+ let options = (optionsOrCallback || {}) as MethodOptions;
9854
+
9855
+ if (typeof paramsOrCallback === 'function') {
9856
+ callback = paramsOrCallback;
9857
+ params =
9858
+ {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search;
9859
+ options = {};
9860
+ }
9861
+
9862
+ if (typeof optionsOrCallback === 'function') {
9863
+ callback = optionsOrCallback;
9864
+ options = {};
9865
+ }
9866
+
9867
+ const rootUrl =
9868
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
9869
+ const parameters = {
9870
+ options: Object.assign(
9871
+ {
9872
+ url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace(
9873
+ /([^:]\/)\/+/g,
9874
+ '$1'
9875
+ ),
9876
+ method: 'POST',
9877
+ },
9878
+ options
9879
+ ),
9880
+ params,
9881
+ requiredParams: ['servingConfig'],
9882
+ pathParams: ['servingConfig'],
9883
+ context: this.context,
9884
+ };
9885
+ if (callback) {
9886
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
9887
+ parameters,
9888
+ callback as BodyResponseCallback<unknown>
9889
+ );
9890
+ } else {
9891
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>(
9892
+ parameters
9893
+ );
9894
+ }
9895
+ }
9896
+ }
9897
+
9898
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
9899
+ extends StandardParameters {
9900
+ /**
9901
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
9902
+ */
9903
+ name?: string;
9904
+ }
9905
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
9906
+ extends StandardParameters {
9907
+ /**
9908
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
9909
+ */
9910
+ pageSize?: number;
9911
+ /**
9912
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
9913
+ */
9914
+ pageToken?: string;
9915
+ /**
9916
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
9917
+ */
9918
+ parent?: string;
9919
+ }
9920
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch
9921
+ extends StandardParameters {
9922
+ /**
9923
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
9924
+ */
9925
+ name?: string;
9926
+ /**
9927
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
9928
+ */
9929
+ updateMask?: string;
9930
+
9931
+ /**
9932
+ * Request body metadata
9933
+ */
9934
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
9935
+ }
9936
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend
9937
+ extends StandardParameters {
9938
+ /**
9939
+ * 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 RecommendationService.Recommend requests.
9940
+ */
9941
+ servingConfig?: string;
9942
+
9943
+ /**
9944
+ * Request body metadata
9945
+ */
9946
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest;
9947
+ }
9948
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search
9949
+ extends StandardParameters {
9950
+ /**
9951
+ * 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.
9952
+ */
9953
+ servingConfig?: string;
9954
+
9955
+ /**
9956
+ * Request body metadata
9957
+ */
9958
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest;
9959
+ }
9960
+
9961
+ export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine {
9962
+ context: APIRequestContext;
9963
+ operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations;
9964
+ targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites;
9965
+ constructor(context: APIRequestContext) {
9966
+ this.context = context;
9967
+ this.operations =
9968
+ new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations(
9969
+ this.context
9970
+ );
9971
+ this.targetSites =
9972
+ new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites(
9973
+ this.context
9974
+ );
9975
+ }
9976
+
9977
+ /**
9978
+ * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
9979
+ *
9980
+ * @param params - Parameters for request
9981
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9982
+ * @param callback - Optional callback that handles the response.
9983
+ * @returns A promise if used with async/await, or void if used with a callback.
9984
+ */
9985
+ batchVerifyTargetSites(
9986
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9987
+ options: StreamMethodOptions
9988
+ ): GaxiosPromise<Readable>;
9989
+ batchVerifyTargetSites(
9990
+ params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9991
+ options?: MethodOptions
9992
+ ): GaxiosPromise<Schema$GoogleLongrunningOperation>;
9993
+ batchVerifyTargetSites(
9994
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
9995
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
9996
+ callback: BodyResponseCallback<Readable>
9997
+ ): void;
9998
+ batchVerifyTargetSites(
9999
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10000
+ options:
10001
+ | MethodOptions
10002
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
10003
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10004
+ ): void;
10005
+ batchVerifyTargetSites(
10006
+ params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites,
10007
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10008
+ ): void;
10009
+ batchVerifyTargetSites(
10010
+ callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
10011
+ ): void;
10012
+ batchVerifyTargetSites(
10013
+ paramsOrCallback?:
10014
+ | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites
10015
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10016
+ | BodyResponseCallback<Readable>,
10017
+ optionsOrCallback?:
10018
+ | MethodOptions
10019
+ | StreamMethodOptions
10020
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10021
+ | BodyResponseCallback<Readable>,
10022
+ callback?:
10023
+ | BodyResponseCallback<Schema$GoogleLongrunningOperation>
10024
+ | BodyResponseCallback<Readable>
10025
+ ):
10026
+ | void
10027
+ | GaxiosPromise<Schema$GoogleLongrunningOperation>
10028
+ | GaxiosPromise<Readable> {
10029
+ let params = (paramsOrCallback ||
10030
+ {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites;
9537
10031
  let options = (optionsOrCallback || {}) as MethodOptions;
9538
10032
 
9539
10033
  if (typeof paramsOrCallback === 'function') {
@@ -13571,6 +14065,294 @@ export namespace discoveryengine_v1alpha {
13571
14065
  this.context = context;
13572
14066
  }
13573
14067
 
14068
+ /**
14069
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
14070
+ *
14071
+ * @param params - Parameters for request
14072
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
14073
+ * @param callback - Optional callback that handles the response.
14074
+ * @returns A promise if used with async/await, or void if used with a callback.
14075
+ */
14076
+ get(
14077
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
14078
+ options: StreamMethodOptions
14079
+ ): GaxiosPromise<Readable>;
14080
+ get(
14081
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
14082
+ options?: MethodOptions
14083
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
14084
+ get(
14085
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
14086
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
14087
+ callback: BodyResponseCallback<Readable>
14088
+ ): void;
14089
+ get(
14090
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
14091
+ options:
14092
+ | MethodOptions
14093
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
14094
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14095
+ ): void;
14096
+ get(
14097
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get,
14098
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14099
+ ): void;
14100
+ get(
14101
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14102
+ ): void;
14103
+ get(
14104
+ paramsOrCallback?:
14105
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
14106
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14107
+ | BodyResponseCallback<Readable>,
14108
+ optionsOrCallback?:
14109
+ | MethodOptions
14110
+ | StreamMethodOptions
14111
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14112
+ | BodyResponseCallback<Readable>,
14113
+ callback?:
14114
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14115
+ | BodyResponseCallback<Readable>
14116
+ ):
14117
+ | void
14118
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14119
+ | GaxiosPromise<Readable> {
14120
+ let params = (paramsOrCallback ||
14121
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get;
14122
+ let options = (optionsOrCallback || {}) as MethodOptions;
14123
+
14124
+ if (typeof paramsOrCallback === 'function') {
14125
+ callback = paramsOrCallback;
14126
+ params =
14127
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get;
14128
+ options = {};
14129
+ }
14130
+
14131
+ if (typeof optionsOrCallback === 'function') {
14132
+ callback = optionsOrCallback;
14133
+ options = {};
14134
+ }
14135
+
14136
+ const rootUrl =
14137
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
14138
+ const parameters = {
14139
+ options: Object.assign(
14140
+ {
14141
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
14142
+ method: 'GET',
14143
+ },
14144
+ options
14145
+ ),
14146
+ params,
14147
+ requiredParams: ['name'],
14148
+ pathParams: ['name'],
14149
+ context: this.context,
14150
+ };
14151
+ if (callback) {
14152
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
14153
+ parameters,
14154
+ callback as BodyResponseCallback<unknown>
14155
+ );
14156
+ } else {
14157
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
14158
+ parameters
14159
+ );
14160
+ }
14161
+ }
14162
+
14163
+ /**
14164
+ * Lists all ServingConfigs linked to this dataStore.
14165
+ *
14166
+ * @param params - Parameters for request
14167
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
14168
+ * @param callback - Optional callback that handles the response.
14169
+ * @returns A promise if used with async/await, or void if used with a callback.
14170
+ */
14171
+ list(
14172
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
14173
+ options: StreamMethodOptions
14174
+ ): GaxiosPromise<Readable>;
14175
+ list(
14176
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
14177
+ options?: MethodOptions
14178
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
14179
+ list(
14180
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
14181
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
14182
+ callback: BodyResponseCallback<Readable>
14183
+ ): void;
14184
+ list(
14185
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
14186
+ options:
14187
+ | MethodOptions
14188
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
14189
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
14190
+ ): void;
14191
+ list(
14192
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List,
14193
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
14194
+ ): void;
14195
+ list(
14196
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
14197
+ ): void;
14198
+ list(
14199
+ paramsOrCallback?:
14200
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List
14201
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
14202
+ | BodyResponseCallback<Readable>,
14203
+ optionsOrCallback?:
14204
+ | MethodOptions
14205
+ | StreamMethodOptions
14206
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
14207
+ | BodyResponseCallback<Readable>,
14208
+ callback?:
14209
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
14210
+ | BodyResponseCallback<Readable>
14211
+ ):
14212
+ | void
14213
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
14214
+ | GaxiosPromise<Readable> {
14215
+ let params = (paramsOrCallback ||
14216
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List;
14217
+ let options = (optionsOrCallback || {}) as MethodOptions;
14218
+
14219
+ if (typeof paramsOrCallback === 'function') {
14220
+ callback = paramsOrCallback;
14221
+ params =
14222
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List;
14223
+ options = {};
14224
+ }
14225
+
14226
+ if (typeof optionsOrCallback === 'function') {
14227
+ callback = optionsOrCallback;
14228
+ options = {};
14229
+ }
14230
+
14231
+ const rootUrl =
14232
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
14233
+ const parameters = {
14234
+ options: Object.assign(
14235
+ {
14236
+ url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
14237
+ /([^:]\/)\/+/g,
14238
+ '$1'
14239
+ ),
14240
+ method: 'GET',
14241
+ },
14242
+ options
14243
+ ),
14244
+ params,
14245
+ requiredParams: ['parent'],
14246
+ pathParams: ['parent'],
14247
+ context: this.context,
14248
+ };
14249
+ if (callback) {
14250
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
14251
+ parameters,
14252
+ callback as BodyResponseCallback<unknown>
14253
+ );
14254
+ } else {
14255
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
14256
+ parameters
14257
+ );
14258
+ }
14259
+ }
14260
+
14261
+ /**
14262
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
14263
+ *
14264
+ * @param params - Parameters for request
14265
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
14266
+ * @param callback - Optional callback that handles the response.
14267
+ * @returns A promise if used with async/await, or void if used with a callback.
14268
+ */
14269
+ patch(
14270
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14271
+ options: StreamMethodOptions
14272
+ ): GaxiosPromise<Readable>;
14273
+ patch(
14274
+ params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14275
+ options?: MethodOptions
14276
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
14277
+ patch(
14278
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14279
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
14280
+ callback: BodyResponseCallback<Readable>
14281
+ ): void;
14282
+ patch(
14283
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14284
+ options:
14285
+ | MethodOptions
14286
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
14287
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14288
+ ): void;
14289
+ patch(
14290
+ params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch,
14291
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14292
+ ): void;
14293
+ patch(
14294
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14295
+ ): void;
14296
+ patch(
14297
+ paramsOrCallback?:
14298
+ | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
14299
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14300
+ | BodyResponseCallback<Readable>,
14301
+ optionsOrCallback?:
14302
+ | MethodOptions
14303
+ | StreamMethodOptions
14304
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14305
+ | BodyResponseCallback<Readable>,
14306
+ callback?:
14307
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14308
+ | BodyResponseCallback<Readable>
14309
+ ):
14310
+ | void
14311
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
14312
+ | GaxiosPromise<Readable> {
14313
+ let params = (paramsOrCallback ||
14314
+ {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch;
14315
+ let options = (optionsOrCallback || {}) as MethodOptions;
14316
+
14317
+ if (typeof paramsOrCallback === 'function') {
14318
+ callback = paramsOrCallback;
14319
+ params =
14320
+ {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch;
14321
+ options = {};
14322
+ }
14323
+
14324
+ if (typeof optionsOrCallback === 'function') {
14325
+ callback = optionsOrCallback;
14326
+ options = {};
14327
+ }
14328
+
14329
+ const rootUrl =
14330
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
14331
+ const parameters = {
14332
+ options: Object.assign(
14333
+ {
14334
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
14335
+ method: 'PATCH',
14336
+ },
14337
+ options
14338
+ ),
14339
+ params,
14340
+ requiredParams: ['name'],
14341
+ pathParams: ['name'],
14342
+ context: this.context,
14343
+ };
14344
+ if (callback) {
14345
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
14346
+ parameters,
14347
+ callback as BodyResponseCallback<unknown>
14348
+ );
14349
+ } else {
14350
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
14351
+ parameters
14352
+ );
14353
+ }
14354
+ }
14355
+
13574
14356
  /**
13575
14357
  * Makes a recommendation, which requires a contextual user event.
13576
14358
  *
@@ -13767,7 +14549,45 @@ export namespace discoveryengine_v1alpha {
13767
14549
  }
13768
14550
  }
13769
14551
  }
13770
-
14552
+
14553
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get
14554
+ extends StandardParameters {
14555
+ /**
14556
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
14557
+ */
14558
+ name?: string;
14559
+ }
14560
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List
14561
+ extends StandardParameters {
14562
+ /**
14563
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
14564
+ */
14565
+ pageSize?: number;
14566
+ /**
14567
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
14568
+ */
14569
+ pageToken?: string;
14570
+ /**
14571
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
14572
+ */
14573
+ parent?: string;
14574
+ }
14575
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch
14576
+ extends StandardParameters {
14577
+ /**
14578
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
14579
+ */
14580
+ name?: string;
14581
+ /**
14582
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
14583
+ */
14584
+ updateMask?: string;
14585
+
14586
+ /**
14587
+ * Request body metadata
14588
+ */
14589
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
14590
+ }
13771
14591
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend
13772
14592
  extends StandardParameters {
13773
14593
  /**
@@ -17711,6 +18531,294 @@ export namespace discoveryengine_v1alpha {
17711
18531
  this.context = context;
17712
18532
  }
17713
18533
 
18534
+ /**
18535
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
18536
+ *
18537
+ * @param params - Parameters for request
18538
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
18539
+ * @param callback - Optional callback that handles the response.
18540
+ * @returns A promise if used with async/await, or void if used with a callback.
18541
+ */
18542
+ get(
18543
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
18544
+ options: StreamMethodOptions
18545
+ ): GaxiosPromise<Readable>;
18546
+ get(
18547
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
18548
+ options?: MethodOptions
18549
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
18550
+ get(
18551
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
18552
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
18553
+ callback: BodyResponseCallback<Readable>
18554
+ ): void;
18555
+ get(
18556
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
18557
+ options:
18558
+ | MethodOptions
18559
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
18560
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18561
+ ): void;
18562
+ get(
18563
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get,
18564
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18565
+ ): void;
18566
+ get(
18567
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18568
+ ): void;
18569
+ get(
18570
+ paramsOrCallback?:
18571
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
18572
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18573
+ | BodyResponseCallback<Readable>,
18574
+ optionsOrCallback?:
18575
+ | MethodOptions
18576
+ | StreamMethodOptions
18577
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18578
+ | BodyResponseCallback<Readable>,
18579
+ callback?:
18580
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18581
+ | BodyResponseCallback<Readable>
18582
+ ):
18583
+ | void
18584
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18585
+ | GaxiosPromise<Readable> {
18586
+ let params = (paramsOrCallback ||
18587
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get;
18588
+ let options = (optionsOrCallback || {}) as MethodOptions;
18589
+
18590
+ if (typeof paramsOrCallback === 'function') {
18591
+ callback = paramsOrCallback;
18592
+ params =
18593
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get;
18594
+ options = {};
18595
+ }
18596
+
18597
+ if (typeof optionsOrCallback === 'function') {
18598
+ callback = optionsOrCallback;
18599
+ options = {};
18600
+ }
18601
+
18602
+ const rootUrl =
18603
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
18604
+ const parameters = {
18605
+ options: Object.assign(
18606
+ {
18607
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
18608
+ method: 'GET',
18609
+ },
18610
+ options
18611
+ ),
18612
+ params,
18613
+ requiredParams: ['name'],
18614
+ pathParams: ['name'],
18615
+ context: this.context,
18616
+ };
18617
+ if (callback) {
18618
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
18619
+ parameters,
18620
+ callback as BodyResponseCallback<unknown>
18621
+ );
18622
+ } else {
18623
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
18624
+ parameters
18625
+ );
18626
+ }
18627
+ }
18628
+
18629
+ /**
18630
+ * Lists all ServingConfigs linked to this dataStore.
18631
+ *
18632
+ * @param params - Parameters for request
18633
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
18634
+ * @param callback - Optional callback that handles the response.
18635
+ * @returns A promise if used with async/await, or void if used with a callback.
18636
+ */
18637
+ list(
18638
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
18639
+ options: StreamMethodOptions
18640
+ ): GaxiosPromise<Readable>;
18641
+ list(
18642
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
18643
+ options?: MethodOptions
18644
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
18645
+ list(
18646
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
18647
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
18648
+ callback: BodyResponseCallback<Readable>
18649
+ ): void;
18650
+ list(
18651
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
18652
+ options:
18653
+ | MethodOptions
18654
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>,
18655
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
18656
+ ): void;
18657
+ list(
18658
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List,
18659
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
18660
+ ): void;
18661
+ list(
18662
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
18663
+ ): void;
18664
+ list(
18665
+ paramsOrCallback?:
18666
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List
18667
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
18668
+ | BodyResponseCallback<Readable>,
18669
+ optionsOrCallback?:
18670
+ | MethodOptions
18671
+ | StreamMethodOptions
18672
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
18673
+ | BodyResponseCallback<Readable>,
18674
+ callback?:
18675
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
18676
+ | BodyResponseCallback<Readable>
18677
+ ):
18678
+ | void
18679
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>
18680
+ | GaxiosPromise<Readable> {
18681
+ let params = (paramsOrCallback ||
18682
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List;
18683
+ let options = (optionsOrCallback || {}) as MethodOptions;
18684
+
18685
+ if (typeof paramsOrCallback === 'function') {
18686
+ callback = paramsOrCallback;
18687
+ params =
18688
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List;
18689
+ options = {};
18690
+ }
18691
+
18692
+ if (typeof optionsOrCallback === 'function') {
18693
+ callback = optionsOrCallback;
18694
+ options = {};
18695
+ }
18696
+
18697
+ const rootUrl =
18698
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
18699
+ const parameters = {
18700
+ options: Object.assign(
18701
+ {
18702
+ url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace(
18703
+ /([^:]\/)\/+/g,
18704
+ '$1'
18705
+ ),
18706
+ method: 'GET',
18707
+ },
18708
+ options
18709
+ ),
18710
+ params,
18711
+ requiredParams: ['parent'],
18712
+ pathParams: ['parent'],
18713
+ context: this.context,
18714
+ };
18715
+ if (callback) {
18716
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
18717
+ parameters,
18718
+ callback as BodyResponseCallback<unknown>
18719
+ );
18720
+ } else {
18721
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>(
18722
+ parameters
18723
+ );
18724
+ }
18725
+ }
18726
+
18727
+ /**
18728
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
18729
+ *
18730
+ * @param params - Parameters for request
18731
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
18732
+ * @param callback - Optional callback that handles the response.
18733
+ * @returns A promise if used with async/await, or void if used with a callback.
18734
+ */
18735
+ patch(
18736
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
18737
+ options: StreamMethodOptions
18738
+ ): GaxiosPromise<Readable>;
18739
+ patch(
18740
+ params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
18741
+ options?: MethodOptions
18742
+ ): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
18743
+ patch(
18744
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
18745
+ options: StreamMethodOptions | BodyResponseCallback<Readable>,
18746
+ callback: BodyResponseCallback<Readable>
18747
+ ): void;
18748
+ patch(
18749
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
18750
+ options:
18751
+ | MethodOptions
18752
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>,
18753
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18754
+ ): void;
18755
+ patch(
18756
+ params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch,
18757
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18758
+ ): void;
18759
+ patch(
18760
+ callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18761
+ ): void;
18762
+ patch(
18763
+ paramsOrCallback?:
18764
+ | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
18765
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18766
+ | BodyResponseCallback<Readable>,
18767
+ optionsOrCallback?:
18768
+ | MethodOptions
18769
+ | StreamMethodOptions
18770
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18771
+ | BodyResponseCallback<Readable>,
18772
+ callback?:
18773
+ | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18774
+ | BodyResponseCallback<Readable>
18775
+ ):
18776
+ | void
18777
+ | GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>
18778
+ | GaxiosPromise<Readable> {
18779
+ let params = (paramsOrCallback ||
18780
+ {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch;
18781
+ let options = (optionsOrCallback || {}) as MethodOptions;
18782
+
18783
+ if (typeof paramsOrCallback === 'function') {
18784
+ callback = paramsOrCallback;
18785
+ params =
18786
+ {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch;
18787
+ options = {};
18788
+ }
18789
+
18790
+ if (typeof optionsOrCallback === 'function') {
18791
+ callback = optionsOrCallback;
18792
+ options = {};
18793
+ }
18794
+
18795
+ const rootUrl =
18796
+ options.rootUrl || 'https://discoveryengine.googleapis.com/';
18797
+ const parameters = {
18798
+ options: Object.assign(
18799
+ {
18800
+ url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
18801
+ method: 'PATCH',
18802
+ },
18803
+ options
18804
+ ),
18805
+ params,
18806
+ requiredParams: ['name'],
18807
+ pathParams: ['name'],
18808
+ context: this.context,
18809
+ };
18810
+ if (callback) {
18811
+ createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
18812
+ parameters,
18813
+ callback as BodyResponseCallback<unknown>
18814
+ );
18815
+ } else {
18816
+ return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>(
18817
+ parameters
18818
+ );
18819
+ }
18820
+ }
18821
+
17714
18822
  /**
17715
18823
  * Makes a recommendation, which requires a contextual user event.
17716
18824
  *
@@ -17908,6 +19016,44 @@ export namespace discoveryengine_v1alpha {
17908
19016
  }
17909
19017
  }
17910
19018
 
19019
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get
19020
+ extends StandardParameters {
19021
+ /**
19022
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
19023
+ */
19024
+ name?: string;
19025
+ }
19026
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List
19027
+ extends StandardParameters {
19028
+ /**
19029
+ * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
19030
+ */
19031
+ pageSize?: number;
19032
+ /**
19033
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
19034
+ */
19035
+ pageToken?: string;
19036
+ /**
19037
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
19038
+ */
19039
+ parent?: string;
19040
+ }
19041
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch
19042
+ extends StandardParameters {
19043
+ /**
19044
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
19045
+ */
19046
+ name?: string;
19047
+ /**
19048
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
19049
+ */
19050
+ updateMask?: string;
19051
+
19052
+ /**
19053
+ * Request body metadata
19054
+ */
19055
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
19056
+ }
17911
19057
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend
17912
19058
  extends StandardParameters {
17913
19059
  /**