@googleapis/discoveryengine 28.1.0 → 28.3.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
  */
@@ -2118,6 +2135,10 @@ export declare namespace discoveryengine_v1alpha {
2118
2135
  * Optional. Customer policy for the assistant.
2119
2136
  */
2120
2137
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy;
2138
+ /**
2139
+ * Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
2140
+ */
2141
+ defaultWebGroundingToggleOff?: boolean | null;
2121
2142
  /**
2122
2143
  * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
2123
2144
  */
@@ -2485,6 +2506,10 @@ export declare namespace discoveryengine_v1alpha {
2485
2506
  * Required. The OAuth2 client secret. Encrypted at rest.
2486
2507
  */
2487
2508
  clientSecret?: string | null;
2509
+ /**
2510
+ * Optional. Whether to enable PKCE verification. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/
2511
+ */
2512
+ pkceVerificationEnabled?: boolean | null;
2488
2513
  /**
2489
2514
  * Required. The scopes to request. Example: `https://www.googleapis.com/auth/calendar.events`
2490
2515
  */
@@ -8264,12 +8289,16 @@ export declare namespace discoveryengine_v1alpha {
8264
8289
  * 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
8290
  */
8266
8291
  regionCode?: string | null;
8292
+ /**
8293
+ * 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.
8294
+ */
8295
+ relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec;
8267
8296
  /**
8268
8297
  * Optional. The specification for returning the relevance score.
8269
8298
  */
8270
8299
  relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec;
8271
8300
  /**
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.
8301
+ * 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
8302
  */
8274
8303
  relevanceThreshold?: string | null;
8275
8304
  /**
@@ -8710,6 +8739,32 @@ export declare namespace discoveryengine_v1alpha {
8710
8739
  */
8711
8740
  pinUnexpandedResults?: boolean | null;
8712
8741
  }
8742
+ /**
8743
+ * Relevance filtering specification.
8744
+ */
8745
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec {
8746
+ /**
8747
+ * Optional. Relevance filtering threshold specification for keyword search.
8748
+ */
8749
+ keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
8750
+ /**
8751
+ * Optional. Relevance filtering threshold specification for semantic search.
8752
+ */
8753
+ semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
8754
+ }
8755
+ /**
8756
+ * Specification for relevance filtering on a specific sub-search.
8757
+ */
8758
+ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
8759
+ /**
8760
+ * Pre-defined relevance threshold for the sub-search.
8761
+ */
8762
+ relevanceThreshold?: string | null;
8763
+ /**
8764
+ * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
8765
+ */
8766
+ semanticRelevanceThreshold?: number | null;
8767
+ }
8713
8768
  /**
8714
8769
  * The specification for returning the document relevance score.
8715
8770
  */
@@ -10957,6 +11012,10 @@ export declare namespace discoveryengine_v1alpha {
10957
11012
  * Optional. Customer policy for the assistant.
10958
11013
  */
10959
11014
  customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
11015
+ /**
11016
+ * Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled.
11017
+ */
11018
+ defaultWebGroundingToggleOff?: boolean | null;
10960
11019
  /**
10961
11020
  * Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
10962
11021
  */
@@ -13003,12 +13062,16 @@ export declare namespace discoveryengine_v1alpha {
13003
13062
  * 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
13063
  */
13005
13064
  regionCode?: string | null;
13065
+ /**
13066
+ * 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.
13067
+ */
13068
+ relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec;
13006
13069
  /**
13007
13070
  * Optional. The specification for returning the relevance score.
13008
13071
  */
13009
13072
  relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec;
13010
13073
  /**
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.
13074
+ * 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
13075
  */
13013
13076
  relevanceThreshold?: string | null;
13014
13077
  /**
@@ -13445,6 +13508,32 @@ export declare namespace discoveryengine_v1alpha {
13445
13508
  */
13446
13509
  pinUnexpandedResults?: boolean | null;
13447
13510
  }
13511
+ /**
13512
+ * Relevance filtering specification.
13513
+ */
13514
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec {
13515
+ /**
13516
+ * Optional. Relevance filtering threshold specification for keyword search.
13517
+ */
13518
+ keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
13519
+ /**
13520
+ * Optional. Relevance filtering threshold specification for semantic search.
13521
+ */
13522
+ semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
13523
+ }
13524
+ /**
13525
+ * Specification for relevance filtering on a specific sub-search.
13526
+ */
13527
+ export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
13528
+ /**
13529
+ * Pre-defined relevance threshold for the sub-search.
13530
+ */
13531
+ relevanceThreshold?: string | null;
13532
+ /**
13533
+ * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
13534
+ */
13535
+ semanticRelevanceThreshold?: number | null;
13536
+ }
13448
13537
  /**
13449
13538
  * The specification for returning the document relevance score.
13450
13539
  */
@@ -19888,7 +19977,7 @@ export declare namespace discoveryengine_v1alpha {
19888
19977
  * await discoveryengine.projects.locations.collections.updateDataConnector({
19889
19978
  * // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
19890
19979
  * 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.
19980
+ * // 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
19981
  * updateMask: 'placeholder-value',
19893
19982
  *
19894
19983
  * // Request body metadata
@@ -20058,7 +20147,7 @@ export declare namespace discoveryengine_v1alpha {
20058
20147
  */
20059
20148
  name?: string;
20060
20149
  /**
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.
20150
+ * 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
20151
  */
20063
20152
  updateMask?: string;
20064
20153
  /**
@@ -25540,6 +25629,129 @@ export declare namespace discoveryengine_v1alpha {
25540
25629
  answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
25541
25630
  answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
25542
25631
  answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
25632
+ /**
25633
+ * 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.
25634
+ * @example
25635
+ * ```js
25636
+ * // Before running the sample:
25637
+ * // - Enable the API at:
25638
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
25639
+ * // - Login into gcloud by running:
25640
+ * // ```sh
25641
+ * // $ gcloud auth application-default login
25642
+ * // ```
25643
+ * // - Install the npm module by running:
25644
+ * // ```sh
25645
+ * // $ npm install googleapis
25646
+ * // ```
25647
+ *
25648
+ * const {google} = require('googleapis');
25649
+ * const discoveryengine = google.discoveryengine('v1alpha');
25650
+ *
25651
+ * async function main() {
25652
+ * const auth = new google.auth.GoogleAuth({
25653
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
25654
+ * scopes: [
25655
+ * 'https://www.googleapis.com/auth/cloud-platform',
25656
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
25657
+ * ],
25658
+ * });
25659
+ *
25660
+ * // Acquire an auth client, and bind it to all future calls
25661
+ * const authClient = await auth.getClient();
25662
+ * google.options({auth: authClient});
25663
+ *
25664
+ * // Do the magic
25665
+ * const res =
25666
+ * await discoveryengine.projects.locations.collections.dataStores.servingConfigs.create(
25667
+ * {
25668
+ * // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
25669
+ * parent:
25670
+ * 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
25671
+ * // 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+/.
25672
+ * servingConfigId: 'placeholder-value',
25673
+ *
25674
+ * // Request body metadata
25675
+ * requestBody: {
25676
+ * // request body parameters
25677
+ * // {
25678
+ * // "answerGenerationSpec": {},
25679
+ * // "boostControlIds": [],
25680
+ * // "createTime": "my_createTime",
25681
+ * // "customFineTuningSpec": {},
25682
+ * // "displayName": "my_displayName",
25683
+ * // "dissociateControlIds": [],
25684
+ * // "diversityLevel": "my_diversityLevel",
25685
+ * // "embeddingConfig": {},
25686
+ * // "filterControlIds": [],
25687
+ * // "genericConfig": {},
25688
+ * // "guidedSearchSpec": {},
25689
+ * // "ignoreControlIds": [],
25690
+ * // "mediaConfig": {},
25691
+ * // "modelId": "my_modelId",
25692
+ * // "name": "my_name",
25693
+ * // "onewaySynonymsControlIds": [],
25694
+ * // "personalizationSpec": {},
25695
+ * // "promoteControlIds": [],
25696
+ * // "rankingExpression": "my_rankingExpression",
25697
+ * // "redirectControlIds": [],
25698
+ * // "replacementControlIds": [],
25699
+ * // "solutionType": "my_solutionType",
25700
+ * // "synonymsControlIds": [],
25701
+ * // "updateTime": "my_updateTime"
25702
+ * // }
25703
+ * },
25704
+ * },
25705
+ * );
25706
+ * console.log(res.data);
25707
+ *
25708
+ * // Example response
25709
+ * // {
25710
+ * // "answerGenerationSpec": {},
25711
+ * // "boostControlIds": [],
25712
+ * // "createTime": "my_createTime",
25713
+ * // "customFineTuningSpec": {},
25714
+ * // "displayName": "my_displayName",
25715
+ * // "dissociateControlIds": [],
25716
+ * // "diversityLevel": "my_diversityLevel",
25717
+ * // "embeddingConfig": {},
25718
+ * // "filterControlIds": [],
25719
+ * // "genericConfig": {},
25720
+ * // "guidedSearchSpec": {},
25721
+ * // "ignoreControlIds": [],
25722
+ * // "mediaConfig": {},
25723
+ * // "modelId": "my_modelId",
25724
+ * // "name": "my_name",
25725
+ * // "onewaySynonymsControlIds": [],
25726
+ * // "personalizationSpec": {},
25727
+ * // "promoteControlIds": [],
25728
+ * // "rankingExpression": "my_rankingExpression",
25729
+ * // "redirectControlIds": [],
25730
+ * // "replacementControlIds": [],
25731
+ * // "solutionType": "my_solutionType",
25732
+ * // "synonymsControlIds": [],
25733
+ * // "updateTime": "my_updateTime"
25734
+ * // }
25735
+ * }
25736
+ *
25737
+ * main().catch(e => {
25738
+ * console.error(e);
25739
+ * throw e;
25740
+ * });
25741
+ *
25742
+ * ```
25743
+ *
25744
+ * @param params - Parameters for request
25745
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
25746
+ * @param callback - Optional callback that handles the response.
25747
+ * @returns A promise if used with async/await, or void if used with a callback.
25748
+ */
25749
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
25750
+ create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
25751
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
25752
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
25753
+ create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
25754
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
25543
25755
  /**
25544
25756
  * Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
25545
25757
  * @example
@@ -26042,6 +26254,7 @@ export declare namespace discoveryengine_v1alpha {
26042
26254
  * // "rankingExpression": "my_rankingExpression",
26043
26255
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
26044
26256
  * // "regionCode": "my_regionCode",
26257
+ * // "relevanceFilterSpec": {},
26045
26258
  * // "relevanceScoreSpec": {},
26046
26259
  * // "relevanceThreshold": "my_relevanceThreshold",
26047
26260
  * // "safeSearch": false,
@@ -26174,6 +26387,7 @@ export declare namespace discoveryengine_v1alpha {
26174
26387
  * // "rankingExpression": "my_rankingExpression",
26175
26388
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
26176
26389
  * // "regionCode": "my_regionCode",
26390
+ * // "relevanceFilterSpec": {},
26177
26391
  * // "relevanceScoreSpec": {},
26178
26392
  * // "relevanceThreshold": "my_relevanceThreshold",
26179
26393
  * // "safeSearch": false,
@@ -26334,6 +26548,20 @@ export declare namespace discoveryengine_v1alpha {
26334
26548
  */
26335
26549
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
26336
26550
  }
26551
+ export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create extends StandardParameters {
26552
+ /**
26553
+ * Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
26554
+ */
26555
+ parent?: string;
26556
+ /**
26557
+ * 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+/.
26558
+ */
26559
+ servingConfigId?: string;
26560
+ /**
26561
+ * Request body metadata
26562
+ */
26563
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
26564
+ }
26337
26565
  export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
26338
26566
  /**
26339
26567
  * Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
@@ -30613,6 +30841,7 @@ export declare namespace discoveryengine_v1alpha {
30613
30841
  * // request body parameters
30614
30842
  * // {
30615
30843
  * // "customerPolicy": {},
30844
+ * // "defaultWebGroundingToggleOff": false,
30616
30845
  * // "description": "my_description",
30617
30846
  * // "disableLocationContext": false,
30618
30847
  * // "displayName": "my_displayName",
@@ -30629,6 +30858,7 @@ export declare namespace discoveryengine_v1alpha {
30629
30858
  * // Example response
30630
30859
  * // {
30631
30860
  * // "customerPolicy": {},
30861
+ * // "defaultWebGroundingToggleOff": false,
30632
30862
  * // "description": "my_description",
30633
30863
  * // "disableLocationContext": false,
30634
30864
  * // "displayName": "my_displayName",
@@ -30768,6 +30998,7 @@ export declare namespace discoveryengine_v1alpha {
30768
30998
  * // Example response
30769
30999
  * // {
30770
31000
  * // "customerPolicy": {},
31001
+ * // "defaultWebGroundingToggleOff": false,
30771
31002
  * // "description": "my_description",
30772
31003
  * // "disableLocationContext": false,
30773
31004
  * // "displayName": "my_displayName",
@@ -31001,6 +31232,7 @@ export declare namespace discoveryengine_v1alpha {
31001
31232
  * // request body parameters
31002
31233
  * // {
31003
31234
  * // "customerPolicy": {},
31235
+ * // "defaultWebGroundingToggleOff": false,
31004
31236
  * // "description": "my_description",
31005
31237
  * // "disableLocationContext": false,
31006
31238
  * // "displayName": "my_displayName",
@@ -31017,6 +31249,7 @@ export declare namespace discoveryengine_v1alpha {
31017
31249
  * // Example response
31018
31250
  * // {
31019
31251
  * // "customerPolicy": {},
31252
+ * // "defaultWebGroundingToggleOff": false,
31020
31253
  * // "description": "my_description",
31021
31254
  * // "disableLocationContext": false,
31022
31255
  * // "displayName": "my_displayName",
@@ -34375,6 +34608,129 @@ export declare namespace discoveryengine_v1alpha {
34375
34608
  answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
34376
34609
  answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
34377
34610
  answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
34611
+ /**
34612
+ * 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.
34613
+ * @example
34614
+ * ```js
34615
+ * // Before running the sample:
34616
+ * // - Enable the API at:
34617
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
34618
+ * // - Login into gcloud by running:
34619
+ * // ```sh
34620
+ * // $ gcloud auth application-default login
34621
+ * // ```
34622
+ * // - Install the npm module by running:
34623
+ * // ```sh
34624
+ * // $ npm install googleapis
34625
+ * // ```
34626
+ *
34627
+ * const {google} = require('googleapis');
34628
+ * const discoveryengine = google.discoveryengine('v1alpha');
34629
+ *
34630
+ * async function main() {
34631
+ * const auth = new google.auth.GoogleAuth({
34632
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
34633
+ * scopes: [
34634
+ * 'https://www.googleapis.com/auth/cloud-platform',
34635
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
34636
+ * ],
34637
+ * });
34638
+ *
34639
+ * // Acquire an auth client, and bind it to all future calls
34640
+ * const authClient = await auth.getClient();
34641
+ * google.options({auth: authClient});
34642
+ *
34643
+ * // Do the magic
34644
+ * const res =
34645
+ * await discoveryengine.projects.locations.collections.engines.servingConfigs.create(
34646
+ * {
34647
+ * // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
34648
+ * parent:
34649
+ * 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
34650
+ * // 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+/.
34651
+ * servingConfigId: 'placeholder-value',
34652
+ *
34653
+ * // Request body metadata
34654
+ * requestBody: {
34655
+ * // request body parameters
34656
+ * // {
34657
+ * // "answerGenerationSpec": {},
34658
+ * // "boostControlIds": [],
34659
+ * // "createTime": "my_createTime",
34660
+ * // "customFineTuningSpec": {},
34661
+ * // "displayName": "my_displayName",
34662
+ * // "dissociateControlIds": [],
34663
+ * // "diversityLevel": "my_diversityLevel",
34664
+ * // "embeddingConfig": {},
34665
+ * // "filterControlIds": [],
34666
+ * // "genericConfig": {},
34667
+ * // "guidedSearchSpec": {},
34668
+ * // "ignoreControlIds": [],
34669
+ * // "mediaConfig": {},
34670
+ * // "modelId": "my_modelId",
34671
+ * // "name": "my_name",
34672
+ * // "onewaySynonymsControlIds": [],
34673
+ * // "personalizationSpec": {},
34674
+ * // "promoteControlIds": [],
34675
+ * // "rankingExpression": "my_rankingExpression",
34676
+ * // "redirectControlIds": [],
34677
+ * // "replacementControlIds": [],
34678
+ * // "solutionType": "my_solutionType",
34679
+ * // "synonymsControlIds": [],
34680
+ * // "updateTime": "my_updateTime"
34681
+ * // }
34682
+ * },
34683
+ * },
34684
+ * );
34685
+ * console.log(res.data);
34686
+ *
34687
+ * // Example response
34688
+ * // {
34689
+ * // "answerGenerationSpec": {},
34690
+ * // "boostControlIds": [],
34691
+ * // "createTime": "my_createTime",
34692
+ * // "customFineTuningSpec": {},
34693
+ * // "displayName": "my_displayName",
34694
+ * // "dissociateControlIds": [],
34695
+ * // "diversityLevel": "my_diversityLevel",
34696
+ * // "embeddingConfig": {},
34697
+ * // "filterControlIds": [],
34698
+ * // "genericConfig": {},
34699
+ * // "guidedSearchSpec": {},
34700
+ * // "ignoreControlIds": [],
34701
+ * // "mediaConfig": {},
34702
+ * // "modelId": "my_modelId",
34703
+ * // "name": "my_name",
34704
+ * // "onewaySynonymsControlIds": [],
34705
+ * // "personalizationSpec": {},
34706
+ * // "promoteControlIds": [],
34707
+ * // "rankingExpression": "my_rankingExpression",
34708
+ * // "redirectControlIds": [],
34709
+ * // "replacementControlIds": [],
34710
+ * // "solutionType": "my_solutionType",
34711
+ * // "synonymsControlIds": [],
34712
+ * // "updateTime": "my_updateTime"
34713
+ * // }
34714
+ * }
34715
+ *
34716
+ * main().catch(e => {
34717
+ * console.error(e);
34718
+ * throw e;
34719
+ * });
34720
+ *
34721
+ * ```
34722
+ *
34723
+ * @param params - Parameters for request
34724
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
34725
+ * @param callback - Optional callback that handles the response.
34726
+ * @returns A promise if used with async/await, or void if used with a callback.
34727
+ */
34728
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
34729
+ create(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
34730
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
34731
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
34732
+ create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
34733
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
34378
34734
  /**
34379
34735
  * Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
34380
34736
  * @example
@@ -34877,6 +35233,7 @@ export declare namespace discoveryengine_v1alpha {
34877
35233
  * // "rankingExpression": "my_rankingExpression",
34878
35234
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
34879
35235
  * // "regionCode": "my_regionCode",
35236
+ * // "relevanceFilterSpec": {},
34880
35237
  * // "relevanceScoreSpec": {},
34881
35238
  * // "relevanceThreshold": "my_relevanceThreshold",
34882
35239
  * // "safeSearch": false,
@@ -35009,6 +35366,7 @@ export declare namespace discoveryengine_v1alpha {
35009
35366
  * // "rankingExpression": "my_rankingExpression",
35010
35367
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
35011
35368
  * // "regionCode": "my_regionCode",
35369
+ * // "relevanceFilterSpec": {},
35012
35370
  * // "relevanceScoreSpec": {},
35013
35371
  * // "relevanceThreshold": "my_relevanceThreshold",
35014
35372
  * // "safeSearch": false,
@@ -35169,6 +35527,20 @@ export declare namespace discoveryengine_v1alpha {
35169
35527
  */
35170
35528
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
35171
35529
  }
35530
+ export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create extends StandardParameters {
35531
+ /**
35532
+ * Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
35533
+ */
35534
+ parent?: string;
35535
+ /**
35536
+ * 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+/.
35537
+ */
35538
+ servingConfigId?: string;
35539
+ /**
35540
+ * Request body metadata
35541
+ */
35542
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
35543
+ }
35172
35544
  export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
35173
35545
  /**
35174
35546
  * Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
@@ -40994,6 +41366,127 @@ export declare namespace discoveryengine_v1alpha {
40994
41366
  answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
40995
41367
  answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
40996
41368
  answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse>): void;
41369
+ /**
41370
+ * 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.
41371
+ * @example
41372
+ * ```js
41373
+ * // Before running the sample:
41374
+ * // - Enable the API at:
41375
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
41376
+ * // - Login into gcloud by running:
41377
+ * // ```sh
41378
+ * // $ gcloud auth application-default login
41379
+ * // ```
41380
+ * // - Install the npm module by running:
41381
+ * // ```sh
41382
+ * // $ npm install googleapis
41383
+ * // ```
41384
+ *
41385
+ * const {google} = require('googleapis');
41386
+ * const discoveryengine = google.discoveryengine('v1alpha');
41387
+ *
41388
+ * async function main() {
41389
+ * const auth = new google.auth.GoogleAuth({
41390
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
41391
+ * scopes: [
41392
+ * 'https://www.googleapis.com/auth/cloud-platform',
41393
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
41394
+ * ],
41395
+ * });
41396
+ *
41397
+ * // Acquire an auth client, and bind it to all future calls
41398
+ * const authClient = await auth.getClient();
41399
+ * google.options({auth: authClient});
41400
+ *
41401
+ * // Do the magic
41402
+ * const res =
41403
+ * await discoveryengine.projects.locations.dataStores.servingConfigs.create({
41404
+ * // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
41405
+ * parent:
41406
+ * 'projects/my-project/locations/my-location/dataStores/my-dataStore',
41407
+ * // 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+/.
41408
+ * servingConfigId: 'placeholder-value',
41409
+ *
41410
+ * // Request body metadata
41411
+ * requestBody: {
41412
+ * // request body parameters
41413
+ * // {
41414
+ * // "answerGenerationSpec": {},
41415
+ * // "boostControlIds": [],
41416
+ * // "createTime": "my_createTime",
41417
+ * // "customFineTuningSpec": {},
41418
+ * // "displayName": "my_displayName",
41419
+ * // "dissociateControlIds": [],
41420
+ * // "diversityLevel": "my_diversityLevel",
41421
+ * // "embeddingConfig": {},
41422
+ * // "filterControlIds": [],
41423
+ * // "genericConfig": {},
41424
+ * // "guidedSearchSpec": {},
41425
+ * // "ignoreControlIds": [],
41426
+ * // "mediaConfig": {},
41427
+ * // "modelId": "my_modelId",
41428
+ * // "name": "my_name",
41429
+ * // "onewaySynonymsControlIds": [],
41430
+ * // "personalizationSpec": {},
41431
+ * // "promoteControlIds": [],
41432
+ * // "rankingExpression": "my_rankingExpression",
41433
+ * // "redirectControlIds": [],
41434
+ * // "replacementControlIds": [],
41435
+ * // "solutionType": "my_solutionType",
41436
+ * // "synonymsControlIds": [],
41437
+ * // "updateTime": "my_updateTime"
41438
+ * // }
41439
+ * },
41440
+ * });
41441
+ * console.log(res.data);
41442
+ *
41443
+ * // Example response
41444
+ * // {
41445
+ * // "answerGenerationSpec": {},
41446
+ * // "boostControlIds": [],
41447
+ * // "createTime": "my_createTime",
41448
+ * // "customFineTuningSpec": {},
41449
+ * // "displayName": "my_displayName",
41450
+ * // "dissociateControlIds": [],
41451
+ * // "diversityLevel": "my_diversityLevel",
41452
+ * // "embeddingConfig": {},
41453
+ * // "filterControlIds": [],
41454
+ * // "genericConfig": {},
41455
+ * // "guidedSearchSpec": {},
41456
+ * // "ignoreControlIds": [],
41457
+ * // "mediaConfig": {},
41458
+ * // "modelId": "my_modelId",
41459
+ * // "name": "my_name",
41460
+ * // "onewaySynonymsControlIds": [],
41461
+ * // "personalizationSpec": {},
41462
+ * // "promoteControlIds": [],
41463
+ * // "rankingExpression": "my_rankingExpression",
41464
+ * // "redirectControlIds": [],
41465
+ * // "replacementControlIds": [],
41466
+ * // "solutionType": "my_solutionType",
41467
+ * // "synonymsControlIds": [],
41468
+ * // "updateTime": "my_updateTime"
41469
+ * // }
41470
+ * }
41471
+ *
41472
+ * main().catch(e => {
41473
+ * console.error(e);
41474
+ * throw e;
41475
+ * });
41476
+ *
41477
+ * ```
41478
+ *
41479
+ * @param params - Parameters for request
41480
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
41481
+ * @param callback - Optional callback that handles the response.
41482
+ * @returns A promise if used with async/await, or void if used with a callback.
41483
+ */
41484
+ create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
41485
+ create(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>>;
41486
+ create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
41487
+ create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
41488
+ create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
41489
+ create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaServingConfig>): void;
40997
41490
  /**
40998
41491
  * Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
40999
41492
  * @example
@@ -41487,6 +41980,7 @@ export declare namespace discoveryengine_v1alpha {
41487
41980
  * // "rankingExpression": "my_rankingExpression",
41488
41981
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
41489
41982
  * // "regionCode": "my_regionCode",
41983
+ * // "relevanceFilterSpec": {},
41490
41984
  * // "relevanceScoreSpec": {},
41491
41985
  * // "relevanceThreshold": "my_relevanceThreshold",
41492
41986
  * // "safeSearch": false,
@@ -41618,6 +42112,7 @@ export declare namespace discoveryengine_v1alpha {
41618
42112
  * // "rankingExpression": "my_rankingExpression",
41619
42113
  * // "rankingExpressionBackend": "my_rankingExpressionBackend",
41620
42114
  * // "regionCode": "my_regionCode",
42115
+ * // "relevanceFilterSpec": {},
41621
42116
  * // "relevanceScoreSpec": {},
41622
42117
  * // "relevanceThreshold": "my_relevanceThreshold",
41623
42118
  * // "safeSearch": false,
@@ -41778,6 +42273,20 @@ export declare namespace discoveryengine_v1alpha {
41778
42273
  */
41779
42274
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
41780
42275
  }
42276
+ export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create extends StandardParameters {
42277
+ /**
42278
+ * Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
42279
+ */
42280
+ parent?: string;
42281
+ /**
42282
+ * 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+/.
42283
+ */
42284
+ servingConfigId?: string;
42285
+ /**
42286
+ * Request body metadata
42287
+ */
42288
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig;
42289
+ }
41781
42290
  export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
41782
42291
  /**
41783
42292
  * Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`