@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/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [6.1.0](https://github.com/googleapis/google-api-nodejs-client/compare/discoveryengine-v6.0.0...discoveryengine-v6.1.0) (2024-02-07)
4
+
5
+
6
+ ### Features
7
+
8
+ * **discoveryengine:** update the API ([64f2232](https://github.com/googleapis/google-api-nodejs-client/commit/64f2232f3ba37f9fe96e34e241172b4979383cc2))
9
+
3
10
  ## [6.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/discoveryengine-v5.0.0...discoveryengine-v6.0.0) (2024-02-02)
4
11
 
5
12
 
@@ -528,6 +528,15 @@ export declare namespace discoveryengine_v1alpha {
528
528
  */
529
529
  text?: string[] | null;
530
530
  }
531
+ /**
532
+ * Defines custom fine tuning spec.
533
+ */
534
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec {
535
+ /**
536
+ * Whether or not to enable and include custom fine tuned search adaptor model.
537
+ */
538
+ enableSearchAdaptor?: boolean | null;
539
+ }
531
540
  /**
532
541
  * DataStore captures global settings and configs at the DataStore level.
533
542
  */
@@ -773,6 +782,15 @@ export declare namespace discoveryengine_v1alpha {
773
782
  */
774
783
  values?: number[] | null;
775
784
  }
785
+ /**
786
+ * Defines embedding config, used for bring your own embeddings feature.
787
+ */
788
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig {
789
+ /**
790
+ * Full field path in the schema mapped as embedding field.
791
+ */
792
+ fieldPath?: string | null;
793
+ }
776
794
  /**
777
795
  * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.
778
796
  */
@@ -1127,6 +1145,23 @@ export declare namespace discoveryengine_v1alpha {
1127
1145
  */
1128
1146
  inputUris?: string[] | null;
1129
1147
  }
1148
+ /**
1149
+ * Defines guided search spec.
1150
+ */
1151
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec {
1152
+ /**
1153
+ * Whether or not to enable and include refinement attributes in gudied search result.
1154
+ */
1155
+ enableRefinementAttributes?: boolean | null;
1156
+ /**
1157
+ * Whether or not to enable and include related questions in search response.
1158
+ */
1159
+ enableRelatedQuestions?: boolean | null;
1160
+ /**
1161
+ * 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.
1162
+ */
1163
+ maxRelatedQuestions?: number | null;
1164
+ }
1130
1165
  /**
1131
1166
  * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.
1132
1167
  */
@@ -1427,6 +1462,19 @@ export declare namespace discoveryengine_v1alpha {
1427
1462
  */
1428
1463
  schemas?: Schema$GoogleCloudDiscoveryengineV1alphaSchema[];
1429
1464
  }
1465
+ /**
1466
+ * Response for ListServingConfigs method.
1467
+ */
1468
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse {
1469
+ /**
1470
+ * Pagination token, if not returned indicates the last page.
1471
+ */
1472
+ nextPageToken?: string | null;
1473
+ /**
1474
+ * All the ServingConfigs for a given dataStore.
1475
+ */
1476
+ servingConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig[];
1477
+ }
1430
1478
  /**
1431
1479
  * Response message for SiteSearchEngineService.ListTargetSites method.
1432
1480
  */
@@ -2131,7 +2179,7 @@ export declare namespace discoveryengine_v1alpha {
2131
2179
  */
2132
2180
  export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec {
2133
2181
  /**
2134
- * 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.
2182
+ * 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)
2135
2183
  */
2136
2184
  version?: string | null;
2137
2185
  }
@@ -2497,6 +2545,126 @@ export declare namespace discoveryengine_v1alpha {
2497
2545
  */
2498
2546
  summary?: string | null;
2499
2547
  }
2548
+ /**
2549
+ * 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.
2550
+ */
2551
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfig {
2552
+ /**
2553
+ * 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.
2554
+ */
2555
+ boostControlIds?: string[] | null;
2556
+ /**
2557
+ * Output only. ServingConfig created timestamp.
2558
+ */
2559
+ createTime?: string | null;
2560
+ /**
2561
+ * Custom fine tuning configs.
2562
+ */
2563
+ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec;
2564
+ /**
2565
+ * 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.
2566
+ */
2567
+ displayName?: string | null;
2568
+ /**
2569
+ * 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.
2570
+ */
2571
+ dissociateControlIds?: string[] | null;
2572
+ /**
2573
+ * 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.
2574
+ */
2575
+ diversityLevel?: string | null;
2576
+ /**
2577
+ * 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.
2578
+ */
2579
+ embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEmbeddingConfig;
2580
+ /**
2581
+ * 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.
2582
+ */
2583
+ filterControlIds?: string[] | null;
2584
+ /**
2585
+ * The GenericConfig of the serving configuration.
2586
+ */
2587
+ genericConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig;
2588
+ /**
2589
+ * Guided search configs.
2590
+ */
2591
+ guidedSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec;
2592
+ /**
2593
+ * 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.
2594
+ */
2595
+ ignoreControlIds?: string[] | null;
2596
+ /**
2597
+ * The MediaConfig of the serving configuration.
2598
+ */
2599
+ mediaConfig?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig;
2600
+ /**
2601
+ * 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.
2602
+ */
2603
+ modelId?: string | null;
2604
+ /**
2605
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
2606
+ */
2607
+ name?: string | null;
2608
+ /**
2609
+ * 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.
2610
+ */
2611
+ onewaySynonymsControlIds?: string[] | null;
2612
+ rankingExpression?: string | null;
2613
+ /**
2614
+ * 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.
2615
+ */
2616
+ redirectControlIds?: string[] | null;
2617
+ /**
2618
+ * 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.
2619
+ */
2620
+ replacementControlIds?: string[] | null;
2621
+ /**
2622
+ * Required. Immutable. Specifies the solution type that a serving config can be associated with.
2623
+ */
2624
+ solutionType?: string | null;
2625
+ /**
2626
+ * 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.
2627
+ */
2628
+ synonymsControlIds?: string[] | null;
2629
+ /**
2630
+ * Output only. ServingConfig updated timestamp.
2631
+ */
2632
+ updateTime?: string | null;
2633
+ }
2634
+ /**
2635
+ * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.
2636
+ */
2637
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig {
2638
+ /**
2639
+ * Specifies the expected behavior of content search. Only valid for content-search enabled data store.
2640
+ */
2641
+ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
2642
+ }
2643
+ /**
2644
+ * 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.
2645
+ */
2646
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig {
2647
+ /**
2648
+ * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.
2649
+ */
2650
+ contentFreshnessCutoffDays?: number | null;
2651
+ /**
2652
+ * Specifies the content watched minutes threshold for demotion.
2653
+ */
2654
+ contentWatchedMinutesThreshold?: number | null;
2655
+ /**
2656
+ * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.
2657
+ */
2658
+ contentWatchedPercentageThreshold?: number | null;
2659
+ /**
2660
+ * Specifies the content watched minutes threshold for demotion.
2661
+ */
2662
+ contentWatchedSecondsThreshold?: number | null;
2663
+ /**
2664
+ * 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.
2665
+ */
2666
+ demotionEventType?: string | null;
2667
+ }
2500
2668
  /**
2501
2669
  * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.
2502
2670
  */
@@ -5528,6 +5696,48 @@ export declare namespace discoveryengine_v1alpha {
5528
5696
  export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs {
5529
5697
  context: APIRequestContext;
5530
5698
  constructor(context: APIRequestContext);
5699
+ /**
5700
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
5701
+ *
5702
+ * @param params - Parameters for request
5703
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5704
+ * @param callback - Optional callback that handles the response.
5705
+ * @returns A promise if used with async/await, or void if used with a callback.
5706
+ */
5707
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
5708
+ get(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
5709
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5710
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
5711
+ get(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
5712
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
5713
+ /**
5714
+ * Lists all ServingConfigs linked to this dataStore.
5715
+ *
5716
+ * @param params - Parameters for request
5717
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5718
+ * @param callback - Optional callback that handles the response.
5719
+ * @returns A promise if used with async/await, or void if used with a callback.
5720
+ */
5721
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
5722
+ list(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
5723
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5724
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
5725
+ list(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
5726
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
5727
+ /**
5728
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
5729
+ *
5730
+ * @param params - Parameters for request
5731
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5732
+ * @param callback - Optional callback that handles the response.
5733
+ * @returns A promise if used with async/await, or void if used with a callback.
5734
+ */
5735
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
5736
+ patch(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
5737
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5738
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
5739
+ patch(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
5740
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
5531
5741
  /**
5532
5742
  * Makes a recommendation, which requires a contextual user event.
5533
5743
  *
@@ -5557,6 +5767,40 @@ export declare namespace discoveryengine_v1alpha {
5557
5767
  search(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
5558
5768
  search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
5559
5769
  }
5770
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
5771
+ /**
5772
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
5773
+ */
5774
+ name?: string;
5775
+ }
5776
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List extends StandardParameters {
5777
+ /**
5778
+ * 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.
5779
+ */
5780
+ pageSize?: number;
5781
+ /**
5782
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
5783
+ */
5784
+ pageToken?: string;
5785
+ /**
5786
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
5787
+ */
5788
+ parent?: string;
5789
+ }
5790
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch extends StandardParameters {
5791
+ /**
5792
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
5793
+ */
5794
+ name?: string;
5795
+ /**
5796
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
5797
+ */
5798
+ updateMask?: string;
5799
+ /**
5800
+ * Request body metadata
5801
+ */
5802
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
5803
+ }
5560
5804
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend extends StandardParameters {
5561
5805
  /**
5562
5806
  * 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.
@@ -6546,6 +6790,48 @@ export declare namespace discoveryengine_v1alpha {
6546
6790
  export class Resource$Projects$Locations$Collections$Engines$Servingconfigs {
6547
6791
  context: APIRequestContext;
6548
6792
  constructor(context: APIRequestContext);
6793
+ /**
6794
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
6795
+ *
6796
+ * @param params - Parameters for request
6797
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6798
+ * @param callback - Optional callback that handles the response.
6799
+ * @returns A promise if used with async/await, or void if used with a callback.
6800
+ */
6801
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
6802
+ get(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
6803
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6804
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
6805
+ get(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
6806
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
6807
+ /**
6808
+ * Lists all ServingConfigs linked to this dataStore.
6809
+ *
6810
+ * @param params - Parameters for request
6811
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6812
+ * @param callback - Optional callback that handles the response.
6813
+ * @returns A promise if used with async/await, or void if used with a callback.
6814
+ */
6815
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
6816
+ list(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
6817
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6818
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
6819
+ list(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
6820
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
6821
+ /**
6822
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
6823
+ *
6824
+ * @param params - Parameters for request
6825
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
6826
+ * @param callback - Optional callback that handles the response.
6827
+ * @returns A promise if used with async/await, or void if used with a callback.
6828
+ */
6829
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
6830
+ patch(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
6831
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
6832
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
6833
+ patch(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
6834
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
6549
6835
  /**
6550
6836
  * Makes a recommendation, which requires a contextual user event.
6551
6837
  *
@@ -6575,6 +6861,40 @@ export declare namespace discoveryengine_v1alpha {
6575
6861
  search(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
6576
6862
  search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
6577
6863
  }
6864
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
6865
+ /**
6866
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
6867
+ */
6868
+ name?: string;
6869
+ }
6870
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters {
6871
+ /**
6872
+ * 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.
6873
+ */
6874
+ pageSize?: number;
6875
+ /**
6876
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
6877
+ */
6878
+ pageToken?: string;
6879
+ /**
6880
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
6881
+ */
6882
+ parent?: string;
6883
+ }
6884
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters {
6885
+ /**
6886
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
6887
+ */
6888
+ name?: string;
6889
+ /**
6890
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
6891
+ */
6892
+ updateMask?: string;
6893
+ /**
6894
+ * Request body metadata
6895
+ */
6896
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
6897
+ }
6578
6898
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters {
6579
6899
  /**
6580
6900
  * 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.
@@ -7542,6 +7862,48 @@ export declare namespace discoveryengine_v1alpha {
7542
7862
  export class Resource$Projects$Locations$Datastores$Servingconfigs {
7543
7863
  context: APIRequestContext;
7544
7864
  constructor(context: APIRequestContext);
7865
+ /**
7866
+ * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
7867
+ *
7868
+ * @param params - Parameters for request
7869
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7870
+ * @param callback - Optional callback that handles the response.
7871
+ * @returns A promise if used with async/await, or void if used with a callback.
7872
+ */
7873
+ get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
7874
+ get(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
7875
+ get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7876
+ get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
7877
+ get(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
7878
+ get(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
7879
+ /**
7880
+ * Lists all ServingConfigs linked to this dataStore.
7881
+ *
7882
+ * @param params - Parameters for request
7883
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7884
+ * @param callback - Optional callback that handles the response.
7885
+ * @returns A promise if used with async/await, or void if used with a callback.
7886
+ */
7887
+ list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
7888
+ list(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>;
7889
+ list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7890
+ list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
7891
+ list(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
7892
+ list(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse>): void;
7893
+ /**
7894
+ * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
7895
+ *
7896
+ * @param params - Parameters for request
7897
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
7898
+ * @param callback - Optional callback that handles the response.
7899
+ * @returns A promise if used with async/await, or void if used with a callback.
7900
+ */
7901
+ patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
7902
+ patch(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions): GaxiosPromise<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>;
7903
+ patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
7904
+ patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
7905
+ patch(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
7906
+ patch(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
7545
7907
  /**
7546
7908
  * Makes a recommendation, which requires a contextual user event.
7547
7909
  *
@@ -7571,6 +7933,40 @@ export declare namespace discoveryengine_v1alpha {
7571
7933
  search(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
7572
7934
  search(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse>): void;
7573
7935
  }
7936
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
7937
+ /**
7938
+ * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/servingConfigs/{serving_config_id\}`
7939
+ */
7940
+ name?: string;
7941
+ }
7942
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List extends StandardParameters {
7943
+ /**
7944
+ * 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.
7945
+ */
7946
+ pageSize?: number;
7947
+ /**
7948
+ * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
7949
+ */
7950
+ pageToken?: string;
7951
+ /**
7952
+ * Required. The dataStore resource name. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`
7953
+ */
7954
+ parent?: string;
7955
+ }
7956
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters {
7957
+ /**
7958
+ * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}`
7959
+ */
7960
+ name?: string;
7961
+ /**
7962
+ * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated.
7963
+ */
7964
+ updateMask?: string;
7965
+ /**
7966
+ * Request body metadata
7967
+ */
7968
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
7969
+ }
7574
7970
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend extends StandardParameters {
7575
7971
  /**
7576
7972
  * 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.