@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.
- package/CHANGELOG.md +15 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +459 -5
- package/build/v1.js +99 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +513 -4
- package/build/v1alpha.js +99 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +478 -2
- package/build/v1beta.js +99 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +1105 -381
- package/v1alpha.ts +783 -4
- package/v1beta.ts +1124 -378
package/build/v1.d.ts
CHANGED
|
@@ -4327,12 +4327,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
4327
4327
|
* 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.
|
|
4328
4328
|
*/
|
|
4329
4329
|
regionCode?: string | null;
|
|
4330
|
+
/**
|
|
4331
|
+
* 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.
|
|
4332
|
+
*/
|
|
4333
|
+
relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec;
|
|
4330
4334
|
/**
|
|
4331
4335
|
* Optional. The specification for returning the relevance score.
|
|
4332
4336
|
*/
|
|
4333
4337
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec;
|
|
4334
4338
|
/**
|
|
4335
|
-
* The relevance threshold of the search results.
|
|
4339
|
+
* 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.
|
|
4336
4340
|
*/
|
|
4337
4341
|
relevanceThreshold?: string | null;
|
|
4338
4342
|
/**
|
|
@@ -4773,6 +4777,32 @@ export declare namespace discoveryengine_v1 {
|
|
|
4773
4777
|
*/
|
|
4774
4778
|
pinUnexpandedResults?: boolean | null;
|
|
4775
4779
|
}
|
|
4780
|
+
/**
|
|
4781
|
+
* Relevance filtering specification.
|
|
4782
|
+
*/
|
|
4783
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec {
|
|
4784
|
+
/**
|
|
4785
|
+
* Optional. Relevance filtering threshold specification for keyword search.
|
|
4786
|
+
*/
|
|
4787
|
+
keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
4788
|
+
/**
|
|
4789
|
+
* Optional. Relevance filtering threshold specification for semantic search.
|
|
4790
|
+
*/
|
|
4791
|
+
semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
4792
|
+
}
|
|
4793
|
+
/**
|
|
4794
|
+
* Specification for relevance filtering on a specific sub-search.
|
|
4795
|
+
*/
|
|
4796
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
4797
|
+
/**
|
|
4798
|
+
* Pre-defined relevance threshold for the sub-search.
|
|
4799
|
+
*/
|
|
4800
|
+
relevanceThreshold?: string | null;
|
|
4801
|
+
/**
|
|
4802
|
+
* Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
|
|
4803
|
+
*/
|
|
4804
|
+
semanticRelevanceThreshold?: number | null;
|
|
4805
|
+
}
|
|
4776
4806
|
/**
|
|
4777
4807
|
* The specification for returning the document relevance score.
|
|
4778
4808
|
*/
|
|
@@ -6197,6 +6227,10 @@ export declare namespace discoveryengine_v1 {
|
|
|
6197
6227
|
* Optional. Customer policy for the assistant.
|
|
6198
6228
|
*/
|
|
6199
6229
|
customerPolicy?: Schema$GoogleCloudDiscoveryengineV1AssistantCustomerPolicy;
|
|
6230
|
+
/**
|
|
6231
|
+
* 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.
|
|
6232
|
+
*/
|
|
6233
|
+
defaultWebGroundingToggleOff?: boolean | null;
|
|
6200
6234
|
/**
|
|
6201
6235
|
* Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.
|
|
6202
6236
|
*/
|
|
@@ -8517,12 +8551,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
8517
8551
|
* 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.
|
|
8518
8552
|
*/
|
|
8519
8553
|
regionCode?: string | null;
|
|
8554
|
+
/**
|
|
8555
|
+
* 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.
|
|
8556
|
+
*/
|
|
8557
|
+
relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec;
|
|
8520
8558
|
/**
|
|
8521
8559
|
* Optional. The specification for returning the relevance score.
|
|
8522
8560
|
*/
|
|
8523
8561
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec;
|
|
8524
8562
|
/**
|
|
8525
|
-
* The relevance threshold of the search results.
|
|
8563
|
+
* 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.
|
|
8526
8564
|
*/
|
|
8527
8565
|
relevanceThreshold?: string | null;
|
|
8528
8566
|
/**
|
|
@@ -8959,6 +8997,32 @@ export declare namespace discoveryengine_v1 {
|
|
|
8959
8997
|
*/
|
|
8960
8998
|
pinUnexpandedResults?: boolean | null;
|
|
8961
8999
|
}
|
|
9000
|
+
/**
|
|
9001
|
+
* Relevance filtering specification.
|
|
9002
|
+
*/
|
|
9003
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec {
|
|
9004
|
+
/**
|
|
9005
|
+
* Optional. Relevance filtering threshold specification for keyword search.
|
|
9006
|
+
*/
|
|
9007
|
+
keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
9008
|
+
/**
|
|
9009
|
+
* Optional. Relevance filtering threshold specification for semantic search.
|
|
9010
|
+
*/
|
|
9011
|
+
semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
9012
|
+
}
|
|
9013
|
+
/**
|
|
9014
|
+
* Specification for relevance filtering on a specific sub-search.
|
|
9015
|
+
*/
|
|
9016
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
9017
|
+
/**
|
|
9018
|
+
* Pre-defined relevance threshold for the sub-search.
|
|
9019
|
+
*/
|
|
9020
|
+
relevanceThreshold?: string | null;
|
|
9021
|
+
/**
|
|
9022
|
+
* Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
|
|
9023
|
+
*/
|
|
9024
|
+
semanticRelevanceThreshold?: number | null;
|
|
9025
|
+
}
|
|
8962
9026
|
/**
|
|
8963
9027
|
* The specification for returning the document relevance score.
|
|
8964
9028
|
*/
|
|
@@ -12999,7 +13063,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
12999
13063
|
*/
|
|
13000
13064
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec;
|
|
13001
13065
|
/**
|
|
13002
|
-
* The relevance threshold of the search results.
|
|
13066
|
+
* 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.
|
|
13003
13067
|
*/
|
|
13004
13068
|
relevanceThreshold?: string | null;
|
|
13005
13069
|
/**
|
|
@@ -16483,7 +16547,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16483
16547
|
* await discoveryengine.projects.locations.collections.updateDataConnector({
|
|
16484
16548
|
* // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
16485
16549
|
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataConnector',
|
|
16486
|
-
* // 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.
|
|
16550
|
+
* // 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.
|
|
16487
16551
|
* updateMask: 'placeholder-value',
|
|
16488
16552
|
*
|
|
16489
16553
|
* // Request body metadata
|
|
@@ -16615,7 +16679,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16615
16679
|
*/
|
|
16616
16680
|
name?: string;
|
|
16617
16681
|
/**
|
|
16618
|
-
* 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.
|
|
16682
|
+
* 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.
|
|
16619
16683
|
*/
|
|
16620
16684
|
updateMask?: string;
|
|
16621
16685
|
/**
|
|
@@ -21060,6 +21124,121 @@ export declare namespace discoveryengine_v1 {
|
|
|
21060
21124
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21061
21125
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21062
21126
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21127
|
+
/**
|
|
21128
|
+
* 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.
|
|
21129
|
+
* @example
|
|
21130
|
+
* ```js
|
|
21131
|
+
* // Before running the sample:
|
|
21132
|
+
* // - Enable the API at:
|
|
21133
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21134
|
+
* // - Login into gcloud by running:
|
|
21135
|
+
* // ```sh
|
|
21136
|
+
* // $ gcloud auth application-default login
|
|
21137
|
+
* // ```
|
|
21138
|
+
* // - Install the npm module by running:
|
|
21139
|
+
* // ```sh
|
|
21140
|
+
* // $ npm install googleapis
|
|
21141
|
+
* // ```
|
|
21142
|
+
*
|
|
21143
|
+
* const {google} = require('googleapis');
|
|
21144
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
21145
|
+
*
|
|
21146
|
+
* async function main() {
|
|
21147
|
+
* const auth = new google.auth.GoogleAuth({
|
|
21148
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21149
|
+
* scopes: [
|
|
21150
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21151
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21152
|
+
* ],
|
|
21153
|
+
* });
|
|
21154
|
+
*
|
|
21155
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
21156
|
+
* const authClient = await auth.getClient();
|
|
21157
|
+
* google.options({auth: authClient});
|
|
21158
|
+
*
|
|
21159
|
+
* // Do the magic
|
|
21160
|
+
* const res =
|
|
21161
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.create(
|
|
21162
|
+
* {
|
|
21163
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
21164
|
+
* parent:
|
|
21165
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
21166
|
+
* // 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+/.
|
|
21167
|
+
* servingConfigId: 'placeholder-value',
|
|
21168
|
+
*
|
|
21169
|
+
* // Request body metadata
|
|
21170
|
+
* requestBody: {
|
|
21171
|
+
* // request body parameters
|
|
21172
|
+
* // {
|
|
21173
|
+
* // "answerGenerationSpec": {},
|
|
21174
|
+
* // "boostControlIds": [],
|
|
21175
|
+
* // "createTime": "my_createTime",
|
|
21176
|
+
* // "displayName": "my_displayName",
|
|
21177
|
+
* // "dissociateControlIds": [],
|
|
21178
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
21179
|
+
* // "filterControlIds": [],
|
|
21180
|
+
* // "genericConfig": {},
|
|
21181
|
+
* // "ignoreControlIds": [],
|
|
21182
|
+
* // "mediaConfig": {},
|
|
21183
|
+
* // "modelId": "my_modelId",
|
|
21184
|
+
* // "name": "my_name",
|
|
21185
|
+
* // "onewaySynonymsControlIds": [],
|
|
21186
|
+
* // "promoteControlIds": [],
|
|
21187
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
21188
|
+
* // "redirectControlIds": [],
|
|
21189
|
+
* // "replacementControlIds": [],
|
|
21190
|
+
* // "solutionType": "my_solutionType",
|
|
21191
|
+
* // "synonymsControlIds": [],
|
|
21192
|
+
* // "updateTime": "my_updateTime"
|
|
21193
|
+
* // }
|
|
21194
|
+
* },
|
|
21195
|
+
* },
|
|
21196
|
+
* );
|
|
21197
|
+
* console.log(res.data);
|
|
21198
|
+
*
|
|
21199
|
+
* // Example response
|
|
21200
|
+
* // {
|
|
21201
|
+
* // "answerGenerationSpec": {},
|
|
21202
|
+
* // "boostControlIds": [],
|
|
21203
|
+
* // "createTime": "my_createTime",
|
|
21204
|
+
* // "displayName": "my_displayName",
|
|
21205
|
+
* // "dissociateControlIds": [],
|
|
21206
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
21207
|
+
* // "filterControlIds": [],
|
|
21208
|
+
* // "genericConfig": {},
|
|
21209
|
+
* // "ignoreControlIds": [],
|
|
21210
|
+
* // "mediaConfig": {},
|
|
21211
|
+
* // "modelId": "my_modelId",
|
|
21212
|
+
* // "name": "my_name",
|
|
21213
|
+
* // "onewaySynonymsControlIds": [],
|
|
21214
|
+
* // "promoteControlIds": [],
|
|
21215
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
21216
|
+
* // "redirectControlIds": [],
|
|
21217
|
+
* // "replacementControlIds": [],
|
|
21218
|
+
* // "solutionType": "my_solutionType",
|
|
21219
|
+
* // "synonymsControlIds": [],
|
|
21220
|
+
* // "updateTime": "my_updateTime"
|
|
21221
|
+
* // }
|
|
21222
|
+
* }
|
|
21223
|
+
*
|
|
21224
|
+
* main().catch(e => {
|
|
21225
|
+
* console.error(e);
|
|
21226
|
+
* throw e;
|
|
21227
|
+
* });
|
|
21228
|
+
*
|
|
21229
|
+
* ```
|
|
21230
|
+
*
|
|
21231
|
+
* @param params - Parameters for request
|
|
21232
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21233
|
+
* @param callback - Optional callback that handles the response.
|
|
21234
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21235
|
+
*/
|
|
21236
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21237
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
21238
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21239
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21240
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21241
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21063
21242
|
/**
|
|
21064
21243
|
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
21065
21244
|
* @example
|
|
@@ -21815,6 +21994,20 @@ export declare namespace discoveryengine_v1 {
|
|
|
21815
21994
|
*/
|
|
21816
21995
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
21817
21996
|
}
|
|
21997
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create extends StandardParameters {
|
|
21998
|
+
/**
|
|
21999
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
22000
|
+
*/
|
|
22001
|
+
parent?: string;
|
|
22002
|
+
/**
|
|
22003
|
+
* 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+/.
|
|
22004
|
+
*/
|
|
22005
|
+
servingConfigId?: string;
|
|
22006
|
+
/**
|
|
22007
|
+
* Request body metadata
|
|
22008
|
+
*/
|
|
22009
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ServingConfig;
|
|
22010
|
+
}
|
|
21818
22011
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
21819
22012
|
/**
|
|
21820
22013
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -25471,6 +25664,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25471
25664
|
* // request body parameters
|
|
25472
25665
|
* // {
|
|
25473
25666
|
* // "customerPolicy": {},
|
|
25667
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
25474
25668
|
* // "description": "my_description",
|
|
25475
25669
|
* // "displayName": "my_displayName",
|
|
25476
25670
|
* // "enabledTools": {},
|
|
@@ -25486,6 +25680,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25486
25680
|
* // Example response
|
|
25487
25681
|
* // {
|
|
25488
25682
|
* // "customerPolicy": {},
|
|
25683
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
25489
25684
|
* // "description": "my_description",
|
|
25490
25685
|
* // "displayName": "my_displayName",
|
|
25491
25686
|
* // "enabledTools": {},
|
|
@@ -25624,6 +25819,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25624
25819
|
* // Example response
|
|
25625
25820
|
* // {
|
|
25626
25821
|
* // "customerPolicy": {},
|
|
25822
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
25627
25823
|
* // "description": "my_description",
|
|
25628
25824
|
* // "displayName": "my_displayName",
|
|
25629
25825
|
* // "enabledTools": {},
|
|
@@ -25771,6 +25967,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25771
25967
|
* // request body parameters
|
|
25772
25968
|
* // {
|
|
25773
25969
|
* // "customerPolicy": {},
|
|
25970
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
25774
25971
|
* // "description": "my_description",
|
|
25775
25972
|
* // "displayName": "my_displayName",
|
|
25776
25973
|
* // "enabledTools": {},
|
|
@@ -25786,6 +25983,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
25786
25983
|
* // Example response
|
|
25787
25984
|
* // {
|
|
25788
25985
|
* // "customerPolicy": {},
|
|
25986
|
+
* // "defaultWebGroundingToggleOff": false,
|
|
25789
25987
|
* // "description": "my_description",
|
|
25790
25988
|
* // "displayName": "my_displayName",
|
|
25791
25989
|
* // "enabledTools": {},
|
|
@@ -27499,6 +27697,121 @@ export declare namespace discoveryengine_v1 {
|
|
|
27499
27697
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27500
27698
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27501
27699
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27700
|
+
/**
|
|
27701
|
+
* 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.
|
|
27702
|
+
* @example
|
|
27703
|
+
* ```js
|
|
27704
|
+
* // Before running the sample:
|
|
27705
|
+
* // - Enable the API at:
|
|
27706
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
27707
|
+
* // - Login into gcloud by running:
|
|
27708
|
+
* // ```sh
|
|
27709
|
+
* // $ gcloud auth application-default login
|
|
27710
|
+
* // ```
|
|
27711
|
+
* // - Install the npm module by running:
|
|
27712
|
+
* // ```sh
|
|
27713
|
+
* // $ npm install googleapis
|
|
27714
|
+
* // ```
|
|
27715
|
+
*
|
|
27716
|
+
* const {google} = require('googleapis');
|
|
27717
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
27718
|
+
*
|
|
27719
|
+
* async function main() {
|
|
27720
|
+
* const auth = new google.auth.GoogleAuth({
|
|
27721
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
27722
|
+
* scopes: [
|
|
27723
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
27724
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
27725
|
+
* ],
|
|
27726
|
+
* });
|
|
27727
|
+
*
|
|
27728
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
27729
|
+
* const authClient = await auth.getClient();
|
|
27730
|
+
* google.options({auth: authClient});
|
|
27731
|
+
*
|
|
27732
|
+
* // Do the magic
|
|
27733
|
+
* const res =
|
|
27734
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.create(
|
|
27735
|
+
* {
|
|
27736
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
27737
|
+
* parent:
|
|
27738
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
27739
|
+
* // 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+/.
|
|
27740
|
+
* servingConfigId: 'placeholder-value',
|
|
27741
|
+
*
|
|
27742
|
+
* // Request body metadata
|
|
27743
|
+
* requestBody: {
|
|
27744
|
+
* // request body parameters
|
|
27745
|
+
* // {
|
|
27746
|
+
* // "answerGenerationSpec": {},
|
|
27747
|
+
* // "boostControlIds": [],
|
|
27748
|
+
* // "createTime": "my_createTime",
|
|
27749
|
+
* // "displayName": "my_displayName",
|
|
27750
|
+
* // "dissociateControlIds": [],
|
|
27751
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
27752
|
+
* // "filterControlIds": [],
|
|
27753
|
+
* // "genericConfig": {},
|
|
27754
|
+
* // "ignoreControlIds": [],
|
|
27755
|
+
* // "mediaConfig": {},
|
|
27756
|
+
* // "modelId": "my_modelId",
|
|
27757
|
+
* // "name": "my_name",
|
|
27758
|
+
* // "onewaySynonymsControlIds": [],
|
|
27759
|
+
* // "promoteControlIds": [],
|
|
27760
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
27761
|
+
* // "redirectControlIds": [],
|
|
27762
|
+
* // "replacementControlIds": [],
|
|
27763
|
+
* // "solutionType": "my_solutionType",
|
|
27764
|
+
* // "synonymsControlIds": [],
|
|
27765
|
+
* // "updateTime": "my_updateTime"
|
|
27766
|
+
* // }
|
|
27767
|
+
* },
|
|
27768
|
+
* },
|
|
27769
|
+
* );
|
|
27770
|
+
* console.log(res.data);
|
|
27771
|
+
*
|
|
27772
|
+
* // Example response
|
|
27773
|
+
* // {
|
|
27774
|
+
* // "answerGenerationSpec": {},
|
|
27775
|
+
* // "boostControlIds": [],
|
|
27776
|
+
* // "createTime": "my_createTime",
|
|
27777
|
+
* // "displayName": "my_displayName",
|
|
27778
|
+
* // "dissociateControlIds": [],
|
|
27779
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
27780
|
+
* // "filterControlIds": [],
|
|
27781
|
+
* // "genericConfig": {},
|
|
27782
|
+
* // "ignoreControlIds": [],
|
|
27783
|
+
* // "mediaConfig": {},
|
|
27784
|
+
* // "modelId": "my_modelId",
|
|
27785
|
+
* // "name": "my_name",
|
|
27786
|
+
* // "onewaySynonymsControlIds": [],
|
|
27787
|
+
* // "promoteControlIds": [],
|
|
27788
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
27789
|
+
* // "redirectControlIds": [],
|
|
27790
|
+
* // "replacementControlIds": [],
|
|
27791
|
+
* // "solutionType": "my_solutionType",
|
|
27792
|
+
* // "synonymsControlIds": [],
|
|
27793
|
+
* // "updateTime": "my_updateTime"
|
|
27794
|
+
* // }
|
|
27795
|
+
* }
|
|
27796
|
+
*
|
|
27797
|
+
* main().catch(e => {
|
|
27798
|
+
* console.error(e);
|
|
27799
|
+
* throw e;
|
|
27800
|
+
* });
|
|
27801
|
+
*
|
|
27802
|
+
* ```
|
|
27803
|
+
*
|
|
27804
|
+
* @param params - Parameters for request
|
|
27805
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
27806
|
+
* @param callback - Optional callback that handles the response.
|
|
27807
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
27808
|
+
*/
|
|
27809
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
27810
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
27811
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
27812
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27813
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27814
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27502
27815
|
/**
|
|
27503
27816
|
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
27504
27817
|
* @example
|
|
@@ -28254,6 +28567,20 @@ export declare namespace discoveryengine_v1 {
|
|
|
28254
28567
|
*/
|
|
28255
28568
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
28256
28569
|
}
|
|
28570
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create extends StandardParameters {
|
|
28571
|
+
/**
|
|
28572
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
28573
|
+
*/
|
|
28574
|
+
parent?: string;
|
|
28575
|
+
/**
|
|
28576
|
+
* 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+/.
|
|
28577
|
+
*/
|
|
28578
|
+
servingConfigId?: string;
|
|
28579
|
+
/**
|
|
28580
|
+
* Request body metadata
|
|
28581
|
+
*/
|
|
28582
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ServingConfig;
|
|
28583
|
+
}
|
|
28257
28584
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
|
|
28258
28585
|
/**
|
|
28259
28586
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -33199,6 +33526,119 @@ export declare namespace discoveryengine_v1 {
|
|
|
33199
33526
|
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
33200
33527
|
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
33201
33528
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
33529
|
+
/**
|
|
33530
|
+
* 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.
|
|
33531
|
+
* @example
|
|
33532
|
+
* ```js
|
|
33533
|
+
* // Before running the sample:
|
|
33534
|
+
* // - Enable the API at:
|
|
33535
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33536
|
+
* // - Login into gcloud by running:
|
|
33537
|
+
* // ```sh
|
|
33538
|
+
* // $ gcloud auth application-default login
|
|
33539
|
+
* // ```
|
|
33540
|
+
* // - Install the npm module by running:
|
|
33541
|
+
* // ```sh
|
|
33542
|
+
* // $ npm install googleapis
|
|
33543
|
+
* // ```
|
|
33544
|
+
*
|
|
33545
|
+
* const {google} = require('googleapis');
|
|
33546
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
33547
|
+
*
|
|
33548
|
+
* async function main() {
|
|
33549
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33550
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33551
|
+
* scopes: [
|
|
33552
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33553
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33554
|
+
* ],
|
|
33555
|
+
* });
|
|
33556
|
+
*
|
|
33557
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33558
|
+
* const authClient = await auth.getClient();
|
|
33559
|
+
* google.options({auth: authClient});
|
|
33560
|
+
*
|
|
33561
|
+
* // Do the magic
|
|
33562
|
+
* const res =
|
|
33563
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.create({
|
|
33564
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
33565
|
+
* parent:
|
|
33566
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
33567
|
+
* // 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+/.
|
|
33568
|
+
* servingConfigId: 'placeholder-value',
|
|
33569
|
+
*
|
|
33570
|
+
* // Request body metadata
|
|
33571
|
+
* requestBody: {
|
|
33572
|
+
* // request body parameters
|
|
33573
|
+
* // {
|
|
33574
|
+
* // "answerGenerationSpec": {},
|
|
33575
|
+
* // "boostControlIds": [],
|
|
33576
|
+
* // "createTime": "my_createTime",
|
|
33577
|
+
* // "displayName": "my_displayName",
|
|
33578
|
+
* // "dissociateControlIds": [],
|
|
33579
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
33580
|
+
* // "filterControlIds": [],
|
|
33581
|
+
* // "genericConfig": {},
|
|
33582
|
+
* // "ignoreControlIds": [],
|
|
33583
|
+
* // "mediaConfig": {},
|
|
33584
|
+
* // "modelId": "my_modelId",
|
|
33585
|
+
* // "name": "my_name",
|
|
33586
|
+
* // "onewaySynonymsControlIds": [],
|
|
33587
|
+
* // "promoteControlIds": [],
|
|
33588
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
33589
|
+
* // "redirectControlIds": [],
|
|
33590
|
+
* // "replacementControlIds": [],
|
|
33591
|
+
* // "solutionType": "my_solutionType",
|
|
33592
|
+
* // "synonymsControlIds": [],
|
|
33593
|
+
* // "updateTime": "my_updateTime"
|
|
33594
|
+
* // }
|
|
33595
|
+
* },
|
|
33596
|
+
* });
|
|
33597
|
+
* console.log(res.data);
|
|
33598
|
+
*
|
|
33599
|
+
* // Example response
|
|
33600
|
+
* // {
|
|
33601
|
+
* // "answerGenerationSpec": {},
|
|
33602
|
+
* // "boostControlIds": [],
|
|
33603
|
+
* // "createTime": "my_createTime",
|
|
33604
|
+
* // "displayName": "my_displayName",
|
|
33605
|
+
* // "dissociateControlIds": [],
|
|
33606
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
33607
|
+
* // "filterControlIds": [],
|
|
33608
|
+
* // "genericConfig": {},
|
|
33609
|
+
* // "ignoreControlIds": [],
|
|
33610
|
+
* // "mediaConfig": {},
|
|
33611
|
+
* // "modelId": "my_modelId",
|
|
33612
|
+
* // "name": "my_name",
|
|
33613
|
+
* // "onewaySynonymsControlIds": [],
|
|
33614
|
+
* // "promoteControlIds": [],
|
|
33615
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
33616
|
+
* // "redirectControlIds": [],
|
|
33617
|
+
* // "replacementControlIds": [],
|
|
33618
|
+
* // "solutionType": "my_solutionType",
|
|
33619
|
+
* // "synonymsControlIds": [],
|
|
33620
|
+
* // "updateTime": "my_updateTime"
|
|
33621
|
+
* // }
|
|
33622
|
+
* }
|
|
33623
|
+
*
|
|
33624
|
+
* main().catch(e => {
|
|
33625
|
+
* console.error(e);
|
|
33626
|
+
* throw e;
|
|
33627
|
+
* });
|
|
33628
|
+
*
|
|
33629
|
+
* ```
|
|
33630
|
+
*
|
|
33631
|
+
* @param params - Parameters for request
|
|
33632
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33633
|
+
* @param callback - Optional callback that handles the response.
|
|
33634
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33635
|
+
*/
|
|
33636
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33637
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
33638
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33639
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33640
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33641
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33202
33642
|
/**
|
|
33203
33643
|
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
33204
33644
|
* @example
|
|
@@ -33944,6 +34384,20 @@ export declare namespace discoveryengine_v1 {
|
|
|
33944
34384
|
*/
|
|
33945
34385
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
33946
34386
|
}
|
|
34387
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create extends StandardParameters {
|
|
34388
|
+
/**
|
|
34389
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
34390
|
+
*/
|
|
34391
|
+
parent?: string;
|
|
34392
|
+
/**
|
|
34393
|
+
* 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+/.
|
|
34394
|
+
*/
|
|
34395
|
+
servingConfigId?: string;
|
|
34396
|
+
/**
|
|
34397
|
+
* Request body metadata
|
|
34398
|
+
*/
|
|
34399
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ServingConfig;
|
|
34400
|
+
}
|
|
33947
34401
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
33948
34402
|
/**
|
|
33949
34403
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|