@googleapis/discoveryengine 28.1.0 → 28.2.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.
@@ -484,11 +484,28 @@ export declare namespace discoveryengine_v1alpha {
484
484
  * Stored definition of an agent that uses A2A.
485
485
  */
486
486
  export interface Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinition {
487
+ /**
488
+ * Optional. Configuration specific to agents that are deployed from Cloud Marketplace.
489
+ */
490
+ cloudMarketplaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig;
487
491
  /**
488
492
  * Optional. The agent card is a JSON string.
489
493
  */
490
494
  jsonAgentCard?: string | null;
491
495
  }
496
+ /**
497
+ * Configuration specific to agents that are deployed from Cloud Marketplace.
498
+ */
499
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaA2AAgentDefinitionCloudMarketplaceConfig {
500
+ /**
501
+ * Required. The Marketplace Entitlement this agent is associated with. Format: `projects/{project\}/entitlements/{entitlement\}`.
502
+ */
503
+ entitlement?: string | null;
504
+ /**
505
+ * Output only. The Marketplace Order this agent belongs to. Format: `billingAccounts/{billing_account\}/orders/{order\}`
506
+ */
507
+ order?: string | null;
508
+ }
492
509
  /**
493
510
  * Access Control Configuration.
494
511
  */
@@ -8264,12 +8281,16 @@ export declare namespace discoveryengine_v1alpha {
8264
8281
  * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
8265
8282
  */
8266
8283
  regionCode?: string | null;
8284
+ /**
8285
+ * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
8286
+ */
8287
+ relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec;
8267
8288
  /**
8268
8289
  * Optional. The specification for returning the relevance score.
8269
8290
  */
8270
8291
  relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec;
8271
8292
  /**
8272
- * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
8293
+ * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.
8273
8294
  */
8274
8295
  relevanceThreshold?: string | null;
8275
8296
  /**
@@ -8710,6 +8731,32 @@ export declare namespace discoveryengine_v1alpha {
8710
8731
  */
8711
8732
  pinUnexpandedResults?: boolean | null;
8712
8733
  }
8734
+ /**
8735
+ * Relevance filtering specification.
8736
+ */
8737
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec {
8738
+ /**
8739
+ * Optional. Relevance filtering threshold specification for keyword search.
8740
+ */
8741
+ keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
8742
+ /**
8743
+ * Optional. Relevance filtering threshold specification for semantic search.
8744
+ */
8745
+ semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
8746
+ }
8747
+ /**
8748
+ * Specification for relevance filtering on a specific sub-search.
8749
+ */
8750
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
8751
+ /**
8752
+ * Pre-defined relevance threshold for the sub-search.
8753
+ */
8754
+ relevanceThreshold?: string | null;
8755
+ /**
8756
+ * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
8757
+ */
8758
+ semanticRelevanceThreshold?: number | null;
8759
+ }
8713
8760
  /**
8714
8761
  * The specification for returning the document relevance score.
8715
8762
  */
@@ -13003,12 +13050,16 @@ export declare namespace discoveryengine_v1alpha {
13003
13050
  * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.
13004
13051
  */
13005
13052
  regionCode?: string | null;
13053
+ /**
13054
+ * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
13055
+ */
13056
+ relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec;
13006
13057
  /**
13007
13058
  * Optional. The specification for returning the relevance score.
13008
13059
  */
13009
13060
  relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec;
13010
13061
  /**
13011
- * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. This feature is not supported for healthcare search.
13062
+ * The global relevance threshold of the search results. Defaults to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. If more granular relevance filtering is required, use the `relevance_filter_spec` instead. This feature is not supported for healthcare search.
13012
13063
  */
13013
13064
  relevanceThreshold?: string | null;
13014
13065
  /**
@@ -13445,6 +13496,32 @@ export declare namespace discoveryengine_v1alpha {
13445
13496
  */
13446
13497
  pinUnexpandedResults?: boolean | null;
13447
13498
  }
13499
+ /**
13500
+ * Relevance filtering specification.
13501
+ */
13502
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec {
13503
+ /**
13504
+ * Optional. Relevance filtering threshold specification for keyword search.
13505
+ */
13506
+ keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
13507
+ /**
13508
+ * Optional. Relevance filtering threshold specification for semantic search.
13509
+ */
13510
+ semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
13511
+ }
13512
+ /**
13513
+ * Specification for relevance filtering on a specific sub-search.
13514
+ */
13515
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
13516
+ /**
13517
+ * Pre-defined relevance threshold for the sub-search.
13518
+ */
13519
+ relevanceThreshold?: string | null;
13520
+ /**
13521
+ * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
13522
+ */
13523
+ semanticRelevanceThreshold?: number | null;
13524
+ }
13448
13525
  /**
13449
13526
  * The specification for returning the document relevance score.
13450
13527
  */
@@ -19888,7 +19965,7 @@ export declare namespace discoveryengine_v1alpha {
19888
19965
  * await discoveryengine.projects.locations.collections.updateDataConnector({
19889
19966
  * // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
19890
19967
  * name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector',
19891
- * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
19968
+ * // Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
19892
19969
  * updateMask: 'placeholder-value',
19893
19970
  *
19894
19971
  * // Request body metadata
@@ -20058,7 +20135,7 @@ export declare namespace discoveryengine_v1alpha {
20058
20135
  */
20059
20136
  name?: string;
20060
20137
  /**
20061
- * Indicates which fields in the provided DataConnector to update. Supported field paths include: - refresh_interval - params - auto_run_disabled - action_config - action_config.action_params - action_config.service_name - destination_configs - blocking_reasons - sync_mode - incremental_sync_disabled - incremental_refresh_interval Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
20138
+ * Indicates which fields in the provided DataConnector to update. Supported field paths include: - `refresh_interval` - `params` - `auto_run_disabled` - `action_config` - `action_config.action_params` - `action_config.service_name` - `destination_configs` - `blocking_reasons` - `sync_mode` - `incremental_sync_disabled` - `incremental_refresh_interval` - `data_protection_policy` Note: Support for these fields may vary depending on the connector type. For example, not all connectors support `destination_configs`. If an unsupported or unknown field path is provided, the request will return an INVALID_ARGUMENT error.
20062
20139
  */
20063
20140
  updateMask?: string;
20064
20141
  /**
@@ -25540,6 +25617,129 @@ export declare namespace discoveryengine_v1alpha {
25540
25617
  answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
25541
25618
  answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
25542
25619
  answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
25620
+ /**
25621
+ * Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.
25622
+ * @example
25623
+ * ```js
25624
+ * // Before running the sample:
25625
+ * // - Enable the API at:
25626
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
25627
+ * // - Login into gcloud by running:
25628
+ * // ```sh
25629
+ * // $ gcloud auth application-default login
25630
+ * // ```
25631
+ * // - Install the npm module by running:
25632
+ * // ```sh
25633
+ * // $ npm install googleapis
25634
+ * // ```
25635
+ *
25636
+ * const {google} = require('googleapis');
25637
+ * const discoveryengine = google.discoveryengine('v1alpha');
25638
+ *
25639
+ * async function main() {
25640
+ * const auth = new google.auth.GoogleAuth({
25641
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
25642
+ * scopes: [
25643
+ * 'https://www.googleapis.com/auth/cloud-platform',
25644
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25645
+ * ],
25646
+ * });
25647
+ *
25648
+ * // Acquire an auth client, and bind it to all future calls
25649
+ * const authClient = await auth.getClient();
25650
+ * google.options({auth: authClient});
25651
+ *
25652
+ * // Do the magic
25653
+ * const res =
25654
+ * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.create(
25655
+ * {
25656
+ * // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
25657
+ * parent:
25658
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
25659
+ * // Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
25660
+ * servingConfigId: 'placeholder-value',
25661
+ *
25662
+ * // Request body metadata
25663
+ * requestBody: {
25664
+ * // request body parameters
25665
+ * // {
25666
+ * // "answerGenerationSpec": {},
25667
+ * // "boostControlIds": [],
25668
+ * // "createTime": "my_createTime",
25669
+ * // "customFineTuningSpec": {},
25670
+ * // "displayName": "my_displayName",
25671
+ * // "dissociateControlIds": [],
25672
+ * // "diversityLevel": "my_diversityLevel",
25673
+ * // "embeddingConfig": {},
25674
+ * // "filterControlIds": [],
25675
+ * // "genericConfig": {},
25676
+ * // "guidedSearchSpec": {},
25677
+ * // "ignoreControlIds": [],
25678
+ * // "mediaConfig": {},
25679
+ * // "modelId": "my_modelId",
25680
+ * // "name": "my_name",
25681
+ * // "onewaySynonymsControlIds": [],
25682
+ * // "personalizationSpec": {},
25683
+ * // "promoteControlIds": [],
25684
+ * // "rankingExpression": "my_rankingExpression",
25685
+ * // "redirectControlIds": [],
25686
+ * // "replacementControlIds": [],
25687
+ * // "solutionType": "my_solutionType",
25688
+ * // "synonymsControlIds": [],
25689
+ * // "updateTime": "my_updateTime"
25690
+ * // }
25691
+ * },
25692
+ * },
25693
+ * );
25694
+ * console.log(res.data);
25695
+ *
25696
+ * // Example response
25697
+ * // {
25698
+ * // "answerGenerationSpec": {},
25699
+ * // "boostControlIds": [],
25700
+ * // "createTime": "my_createTime",
25701
+ * // "customFineTuningSpec": {},
25702
+ * // "displayName": "my_displayName",
25703
+ * // "dissociateControlIds": [],
25704
+ * // "diversityLevel": "my_diversityLevel",
25705
+ * // "embeddingConfig": {},
25706
+ * // "filterControlIds": [],
25707
+ * // "genericConfig": {},
25708
+ * // "guidedSearchSpec": {},
25709
+ * // "ignoreControlIds": [],
25710
+ * // "mediaConfig": {},
25711
+ * // "modelId": "my_modelId",
25712
+ * // "name": "my_name",
25713
+ * // "onewaySynonymsControlIds": [],
25714
+ * // "personalizationSpec": {},
25715
+ * // "promoteControlIds": [],
25716
+ * // "rankingExpression": "my_rankingExpression",
25717
+ * // "redirectControlIds": [],
25718
+ * // "replacementControlIds": [],
25719
+ * // "solutionType": "my_solutionType",
25720
+ * // "synonymsControlIds": [],
25721
+ * // "updateTime": "my_updateTime"
25722
+ * // }
25723
+ * }
25724
+ *
25725
+ * main().catch(e => {
25726
+ * console.error(e);
25727
+ * throw e;
25728
+ * });
25729
+ *
25730
+ * ```
25731
+ *
25732
+ * @param params - Parameters for request
25733
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25734
+ * @param callback - Optional callback that handles the response.
25735
+ * @returns A promise if used with async/await, or void if used with a callback.
25736
+ */
25737
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25738
+ create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
25739
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25740
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
25741
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
25742
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
25543
25743
  /**
25544
25744
  * Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
25545
25745
  * @example
@@ -26042,6 +26242,7 @@ export declare namespace discoveryengine_v1alpha {
26042
26242
  * // "rankingExpression": "my_rankingExpression",
26043
26243
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
26044
26244
  * // "regionCode": "my_regionCode",
26245
+ * // "relevanceFilterSpec": {},
26045
26246
  * // "relevanceScoreSpec": {},
26046
26247
  * // "relevanceThreshold": "my_relevanceThreshold",
26047
26248
  * // "safeSearch": false,
@@ -26174,6 +26375,7 @@ export declare namespace discoveryengine_v1alpha {
26174
26375
  * // "rankingExpression": "my_rankingExpression",
26175
26376
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
26176
26377
  * // "regionCode": "my_regionCode",
26378
+ * // "relevanceFilterSpec": {},
26177
26379
  * // "relevanceScoreSpec": {},
26178
26380
  * // "relevanceThreshold": "my_relevanceThreshold",
26179
26381
  * // "safeSearch": false,
@@ -26334,6 +26536,20 @@ export declare namespace discoveryengine_v1alpha {
26334
26536
  */
26335
26537
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
26336
26538
  }
26539
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create extends StandardParameters {
26540
+ /**
26541
+ * Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
26542
+ */
26543
+ parent?: string;
26544
+ /**
26545
+ * Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
26546
+ */
26547
+ servingConfigId?: string;
26548
+ /**
26549
+ * Request body metadata
26550
+ */
26551
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
26552
+ }
26337
26553
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
26338
26554
  /**
26339
26555
  * Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
@@ -34375,6 +34591,129 @@ export declare namespace discoveryengine_v1alpha {
34375
34591
  answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
34376
34592
  answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
34377
34593
  answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
34594
+ /**
34595
+ * Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.
34596
+ * @example
34597
+ * ```js
34598
+ * // Before running the sample:
34599
+ * // - Enable the API at:
34600
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
34601
+ * // - Login into gcloud by running:
34602
+ * // ```sh
34603
+ * // $ gcloud auth application-default login
34604
+ * // ```
34605
+ * // - Install the npm module by running:
34606
+ * // ```sh
34607
+ * // $ npm install googleapis
34608
+ * // ```
34609
+ *
34610
+ * const {google} = require('googleapis');
34611
+ * const discoveryengine = google.discoveryengine('v1alpha');
34612
+ *
34613
+ * async function main() {
34614
+ * const auth = new google.auth.GoogleAuth({
34615
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
34616
+ * scopes: [
34617
+ * 'https://www.googleapis.com/auth/cloud-platform',
34618
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
34619
+ * ],
34620
+ * });
34621
+ *
34622
+ * // Acquire an auth client, and bind it to all future calls
34623
+ * const authClient = await auth.getClient();
34624
+ * google.options({auth: authClient});
34625
+ *
34626
+ * // Do the magic
34627
+ * const res =
34628
+ * await discoveryengine.projects.locations.collections.engines.servingConfigs.create(
34629
+ * {
34630
+ * // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
34631
+ * parent:
34632
+ * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
34633
+ * // Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
34634
+ * servingConfigId: 'placeholder-value',
34635
+ *
34636
+ * // Request body metadata
34637
+ * requestBody: {
34638
+ * // request body parameters
34639
+ * // {
34640
+ * // "answerGenerationSpec": {},
34641
+ * // "boostControlIds": [],
34642
+ * // "createTime": "my_createTime",
34643
+ * // "customFineTuningSpec": {},
34644
+ * // "displayName": "my_displayName",
34645
+ * // "dissociateControlIds": [],
34646
+ * // "diversityLevel": "my_diversityLevel",
34647
+ * // "embeddingConfig": {},
34648
+ * // "filterControlIds": [],
34649
+ * // "genericConfig": {},
34650
+ * // "guidedSearchSpec": {},
34651
+ * // "ignoreControlIds": [],
34652
+ * // "mediaConfig": {},
34653
+ * // "modelId": "my_modelId",
34654
+ * // "name": "my_name",
34655
+ * // "onewaySynonymsControlIds": [],
34656
+ * // "personalizationSpec": {},
34657
+ * // "promoteControlIds": [],
34658
+ * // "rankingExpression": "my_rankingExpression",
34659
+ * // "redirectControlIds": [],
34660
+ * // "replacementControlIds": [],
34661
+ * // "solutionType": "my_solutionType",
34662
+ * // "synonymsControlIds": [],
34663
+ * // "updateTime": "my_updateTime"
34664
+ * // }
34665
+ * },
34666
+ * },
34667
+ * );
34668
+ * console.log(res.data);
34669
+ *
34670
+ * // Example response
34671
+ * // {
34672
+ * // "answerGenerationSpec": {},
34673
+ * // "boostControlIds": [],
34674
+ * // "createTime": "my_createTime",
34675
+ * // "customFineTuningSpec": {},
34676
+ * // "displayName": "my_displayName",
34677
+ * // "dissociateControlIds": [],
34678
+ * // "diversityLevel": "my_diversityLevel",
34679
+ * // "embeddingConfig": {},
34680
+ * // "filterControlIds": [],
34681
+ * // "genericConfig": {},
34682
+ * // "guidedSearchSpec": {},
34683
+ * // "ignoreControlIds": [],
34684
+ * // "mediaConfig": {},
34685
+ * // "modelId": "my_modelId",
34686
+ * // "name": "my_name",
34687
+ * // "onewaySynonymsControlIds": [],
34688
+ * // "personalizationSpec": {},
34689
+ * // "promoteControlIds": [],
34690
+ * // "rankingExpression": "my_rankingExpression",
34691
+ * // "redirectControlIds": [],
34692
+ * // "replacementControlIds": [],
34693
+ * // "solutionType": "my_solutionType",
34694
+ * // "synonymsControlIds": [],
34695
+ * // "updateTime": "my_updateTime"
34696
+ * // }
34697
+ * }
34698
+ *
34699
+ * main().catch(e => {
34700
+ * console.error(e);
34701
+ * throw e;
34702
+ * });
34703
+ *
34704
+ * ```
34705
+ *
34706
+ * @param params - Parameters for request
34707
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
34708
+ * @param callback - Optional callback that handles the response.
34709
+ * @returns A promise if used with async/await, or void if used with a callback.
34710
+ */
34711
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
34712
+ create(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
34713
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
34714
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
34715
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
34716
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
34378
34717
  /**
34379
34718
  * Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
34380
34719
  * @example
@@ -34877,6 +35216,7 @@ export declare namespace discoveryengine_v1alpha {
34877
35216
  * // "rankingExpression": "my_rankingExpression",
34878
35217
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
34879
35218
  * // "regionCode": "my_regionCode",
35219
+ * // "relevanceFilterSpec": {},
34880
35220
  * // "relevanceScoreSpec": {},
34881
35221
  * // "relevanceThreshold": "my_relevanceThreshold",
34882
35222
  * // "safeSearch": false,
@@ -35009,6 +35349,7 @@ export declare namespace discoveryengine_v1alpha {
35009
35349
  * // "rankingExpression": "my_rankingExpression",
35010
35350
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
35011
35351
  * // "regionCode": "my_regionCode",
35352
+ * // "relevanceFilterSpec": {},
35012
35353
  * // "relevanceScoreSpec": {},
35013
35354
  * // "relevanceThreshold": "my_relevanceThreshold",
35014
35355
  * // "safeSearch": false,
@@ -35169,6 +35510,20 @@ export declare namespace discoveryengine_v1alpha {
35169
35510
  */
35170
35511
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
35171
35512
  }
35513
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create extends StandardParameters {
35514
+ /**
35515
+ * Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
35516
+ */
35517
+ parent?: string;
35518
+ /**
35519
+ * Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
35520
+ */
35521
+ servingConfigId?: string;
35522
+ /**
35523
+ * Request body metadata
35524
+ */
35525
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
35526
+ }
35172
35527
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
35173
35528
  /**
35174
35529
  * Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
@@ -40994,6 +41349,127 @@ export declare namespace discoveryengine_v1alpha {
40994
41349
  answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
40995
41350
  answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
40996
41351
  answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
41352
+ /**
41353
+ * Creates a ServingConfig. Note: The Google Cloud console works only with the default serving config. Additional ServingConfigs can be created and managed only via the API. A maximum of 100 ServingConfigs are allowed in an Engine, otherwise a RESOURCE_EXHAUSTED error is returned.
41354
+ * @example
41355
+ * ```js
41356
+ * // Before running the sample:
41357
+ * // - Enable the API at:
41358
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
41359
+ * // - Login into gcloud by running:
41360
+ * // ```sh
41361
+ * // $ gcloud auth application-default login
41362
+ * // ```
41363
+ * // - Install the npm module by running:
41364
+ * // ```sh
41365
+ * // $ npm install googleapis
41366
+ * // ```
41367
+ *
41368
+ * const {google} = require('googleapis');
41369
+ * const discoveryengine = google.discoveryengine('v1alpha');
41370
+ *
41371
+ * async function main() {
41372
+ * const auth = new google.auth.GoogleAuth({
41373
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
41374
+ * scopes: [
41375
+ * 'https://www.googleapis.com/auth/cloud-platform',
41376
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
41377
+ * ],
41378
+ * });
41379
+ *
41380
+ * // Acquire an auth client, and bind it to all future calls
41381
+ * const authClient = await auth.getClient();
41382
+ * google.options({auth: authClient});
41383
+ *
41384
+ * // Do the magic
41385
+ * const res =
41386
+ * await discoveryengine.projects.locations.dataStores.servingConfigs.create({
41387
+ * // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
41388
+ * parent:
41389
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
41390
+ * // Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
41391
+ * servingConfigId: 'placeholder-value',
41392
+ *
41393
+ * // Request body metadata
41394
+ * requestBody: {
41395
+ * // request body parameters
41396
+ * // {
41397
+ * // "answerGenerationSpec": {},
41398
+ * // "boostControlIds": [],
41399
+ * // "createTime": "my_createTime",
41400
+ * // "customFineTuningSpec": {},
41401
+ * // "displayName": "my_displayName",
41402
+ * // "dissociateControlIds": [],
41403
+ * // "diversityLevel": "my_diversityLevel",
41404
+ * // "embeddingConfig": {},
41405
+ * // "filterControlIds": [],
41406
+ * // "genericConfig": {},
41407
+ * // "guidedSearchSpec": {},
41408
+ * // "ignoreControlIds": [],
41409
+ * // "mediaConfig": {},
41410
+ * // "modelId": "my_modelId",
41411
+ * // "name": "my_name",
41412
+ * // "onewaySynonymsControlIds": [],
41413
+ * // "personalizationSpec": {},
41414
+ * // "promoteControlIds": [],
41415
+ * // "rankingExpression": "my_rankingExpression",
41416
+ * // "redirectControlIds": [],
41417
+ * // "replacementControlIds": [],
41418
+ * // "solutionType": "my_solutionType",
41419
+ * // "synonymsControlIds": [],
41420
+ * // "updateTime": "my_updateTime"
41421
+ * // }
41422
+ * },
41423
+ * });
41424
+ * console.log(res.data);
41425
+ *
41426
+ * // Example response
41427
+ * // {
41428
+ * // "answerGenerationSpec": {},
41429
+ * // "boostControlIds": [],
41430
+ * // "createTime": "my_createTime",
41431
+ * // "customFineTuningSpec": {},
41432
+ * // "displayName": "my_displayName",
41433
+ * // "dissociateControlIds": [],
41434
+ * // "diversityLevel": "my_diversityLevel",
41435
+ * // "embeddingConfig": {},
41436
+ * // "filterControlIds": [],
41437
+ * // "genericConfig": {},
41438
+ * // "guidedSearchSpec": {},
41439
+ * // "ignoreControlIds": [],
41440
+ * // "mediaConfig": {},
41441
+ * // "modelId": "my_modelId",
41442
+ * // "name": "my_name",
41443
+ * // "onewaySynonymsControlIds": [],
41444
+ * // "personalizationSpec": {},
41445
+ * // "promoteControlIds": [],
41446
+ * // "rankingExpression": "my_rankingExpression",
41447
+ * // "redirectControlIds": [],
41448
+ * // "replacementControlIds": [],
41449
+ * // "solutionType": "my_solutionType",
41450
+ * // "synonymsControlIds": [],
41451
+ * // "updateTime": "my_updateTime"
41452
+ * // }
41453
+ * }
41454
+ *
41455
+ * main().catch(e => {
41456
+ * console.error(e);
41457
+ * throw e;
41458
+ * });
41459
+ *
41460
+ * ```
41461
+ *
41462
+ * @param params - Parameters for request
41463
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
41464
+ * @param callback - Optional callback that handles the response.
41465
+ * @returns A promise if used with async/await, or void if used with a callback.
41466
+ */
41467
+ create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
41468
+ create(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
41469
+ create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
41470
+ create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
41471
+ create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
41472
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
40997
41473
  /**
40998
41474
  * Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
40999
41475
  * @example
@@ -41487,6 +41963,7 @@ export declare namespace discoveryengine_v1alpha {
41487
41963
  * // "rankingExpression": "my_rankingExpression",
41488
41964
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
41489
41965
  * // "regionCode": "my_regionCode",
41966
+ * // "relevanceFilterSpec": {},
41490
41967
  * // "relevanceScoreSpec": {},
41491
41968
  * // "relevanceThreshold": "my_relevanceThreshold",
41492
41969
  * // "safeSearch": false,
@@ -41618,6 +42095,7 @@ export declare namespace discoveryengine_v1alpha {
41618
42095
  * // "rankingExpression": "my_rankingExpression",
41619
42096
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
41620
42097
  * // "regionCode": "my_regionCode",
42098
+ * // "relevanceFilterSpec": {},
41621
42099
  * // "relevanceScoreSpec": {},
41622
42100
  * // "relevanceThreshold": "my_relevanceThreshold",
41623
42101
  * // "safeSearch": false,
@@ -41778,6 +42256,20 @@ export declare namespace discoveryengine_v1alpha {
41778
42256
  */
41779
42257
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
41780
42258
  }
42259
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create extends StandardParameters {
42260
+ /**
42261
+ * Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
42262
+ */
42263
+ parent?: string;
42264
+ /**
42265
+ * Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/.
42266
+ */
42267
+ servingConfigId?: string;
42268
+ /**
42269
+ * Request body metadata
42270
+ */
42271
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
42272
+ }
41781
42273
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
41782
42274
  /**
41783
42275
  * Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`