@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.
- package/CHANGELOG.md +8 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +450 -5
- package/build/v1.js +99 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +496 -4
- package/build/v1alpha.js +99 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +465 -2
- package/build/v1beta.js +99 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +1096 -381
- package/v1alpha.ts +866 -104
- package/v1beta.ts +1111 -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
|
*/
|
|
@@ -8517,12 +8547,16 @@ export declare namespace discoveryengine_v1 {
|
|
|
8517
8547
|
* 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
8548
|
*/
|
|
8519
8549
|
regionCode?: string | null;
|
|
8550
|
+
/**
|
|
8551
|
+
* 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.
|
|
8552
|
+
*/
|
|
8553
|
+
relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec;
|
|
8520
8554
|
/**
|
|
8521
8555
|
* Optional. The specification for returning the relevance score.
|
|
8522
8556
|
*/
|
|
8523
8557
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec;
|
|
8524
8558
|
/**
|
|
8525
|
-
* The relevance threshold of the search results.
|
|
8559
|
+
* 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
8560
|
*/
|
|
8527
8561
|
relevanceThreshold?: string | null;
|
|
8528
8562
|
/**
|
|
@@ -8959,6 +8993,32 @@ export declare namespace discoveryengine_v1 {
|
|
|
8959
8993
|
*/
|
|
8960
8994
|
pinUnexpandedResults?: boolean | null;
|
|
8961
8995
|
}
|
|
8996
|
+
/**
|
|
8997
|
+
* Relevance filtering specification.
|
|
8998
|
+
*/
|
|
8999
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec {
|
|
9000
|
+
/**
|
|
9001
|
+
* Optional. Relevance filtering threshold specification for keyword search.
|
|
9002
|
+
*/
|
|
9003
|
+
keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
9004
|
+
/**
|
|
9005
|
+
* Optional. Relevance filtering threshold specification for semantic search.
|
|
9006
|
+
*/
|
|
9007
|
+
semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
9008
|
+
}
|
|
9009
|
+
/**
|
|
9010
|
+
* Specification for relevance filtering on a specific sub-search.
|
|
9011
|
+
*/
|
|
9012
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
9013
|
+
/**
|
|
9014
|
+
* Pre-defined relevance threshold for the sub-search.
|
|
9015
|
+
*/
|
|
9016
|
+
relevanceThreshold?: string | null;
|
|
9017
|
+
/**
|
|
9018
|
+
* Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
|
|
9019
|
+
*/
|
|
9020
|
+
semanticRelevanceThreshold?: number | null;
|
|
9021
|
+
}
|
|
8962
9022
|
/**
|
|
8963
9023
|
* The specification for returning the document relevance score.
|
|
8964
9024
|
*/
|
|
@@ -12999,7 +13059,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
12999
13059
|
*/
|
|
13000
13060
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceScoreSpec;
|
|
13001
13061
|
/**
|
|
13002
|
-
* The relevance threshold of the search results.
|
|
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.
|
|
13003
13063
|
*/
|
|
13004
13064
|
relevanceThreshold?: string | null;
|
|
13005
13065
|
/**
|
|
@@ -16483,7 +16543,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16483
16543
|
* await discoveryengine.projects.locations.collections.updateDataConnector({
|
|
16484
16544
|
* // Output only. The full resource name of the Data Connector. Format: `projects/x/locations/x/collections/x/dataConnector`.
|
|
16485
16545
|
* 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.
|
|
16546
|
+
* // 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
16547
|
* updateMask: 'placeholder-value',
|
|
16488
16548
|
*
|
|
16489
16549
|
* // Request body metadata
|
|
@@ -16615,7 +16675,7 @@ export declare namespace discoveryengine_v1 {
|
|
|
16615
16675
|
*/
|
|
16616
16676
|
name?: string;
|
|
16617
16677
|
/**
|
|
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.
|
|
16678
|
+
* 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
16679
|
*/
|
|
16620
16680
|
updateMask?: string;
|
|
16621
16681
|
/**
|
|
@@ -21060,6 +21120,121 @@ export declare namespace discoveryengine_v1 {
|
|
|
21060
21120
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21061
21121
|
answer(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21062
21122
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
21123
|
+
/**
|
|
21124
|
+
* 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.
|
|
21125
|
+
* @example
|
|
21126
|
+
* ```js
|
|
21127
|
+
* // Before running the sample:
|
|
21128
|
+
* // - Enable the API at:
|
|
21129
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
21130
|
+
* // - Login into gcloud by running:
|
|
21131
|
+
* // ```sh
|
|
21132
|
+
* // $ gcloud auth application-default login
|
|
21133
|
+
* // ```
|
|
21134
|
+
* // - Install the npm module by running:
|
|
21135
|
+
* // ```sh
|
|
21136
|
+
* // $ npm install googleapis
|
|
21137
|
+
* // ```
|
|
21138
|
+
*
|
|
21139
|
+
* const {google} = require('googleapis');
|
|
21140
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
21141
|
+
*
|
|
21142
|
+
* async function main() {
|
|
21143
|
+
* const auth = new google.auth.GoogleAuth({
|
|
21144
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
21145
|
+
* scopes: [
|
|
21146
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
21147
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
21148
|
+
* ],
|
|
21149
|
+
* });
|
|
21150
|
+
*
|
|
21151
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
21152
|
+
* const authClient = await auth.getClient();
|
|
21153
|
+
* google.options({auth: authClient});
|
|
21154
|
+
*
|
|
21155
|
+
* // Do the magic
|
|
21156
|
+
* const res =
|
|
21157
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.create(
|
|
21158
|
+
* {
|
|
21159
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
21160
|
+
* parent:
|
|
21161
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
21162
|
+
* // 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+/.
|
|
21163
|
+
* servingConfigId: 'placeholder-value',
|
|
21164
|
+
*
|
|
21165
|
+
* // Request body metadata
|
|
21166
|
+
* requestBody: {
|
|
21167
|
+
* // request body parameters
|
|
21168
|
+
* // {
|
|
21169
|
+
* // "answerGenerationSpec": {},
|
|
21170
|
+
* // "boostControlIds": [],
|
|
21171
|
+
* // "createTime": "my_createTime",
|
|
21172
|
+
* // "displayName": "my_displayName",
|
|
21173
|
+
* // "dissociateControlIds": [],
|
|
21174
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
21175
|
+
* // "filterControlIds": [],
|
|
21176
|
+
* // "genericConfig": {},
|
|
21177
|
+
* // "ignoreControlIds": [],
|
|
21178
|
+
* // "mediaConfig": {},
|
|
21179
|
+
* // "modelId": "my_modelId",
|
|
21180
|
+
* // "name": "my_name",
|
|
21181
|
+
* // "onewaySynonymsControlIds": [],
|
|
21182
|
+
* // "promoteControlIds": [],
|
|
21183
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
21184
|
+
* // "redirectControlIds": [],
|
|
21185
|
+
* // "replacementControlIds": [],
|
|
21186
|
+
* // "solutionType": "my_solutionType",
|
|
21187
|
+
* // "synonymsControlIds": [],
|
|
21188
|
+
* // "updateTime": "my_updateTime"
|
|
21189
|
+
* // }
|
|
21190
|
+
* },
|
|
21191
|
+
* },
|
|
21192
|
+
* );
|
|
21193
|
+
* console.log(res.data);
|
|
21194
|
+
*
|
|
21195
|
+
* // Example response
|
|
21196
|
+
* // {
|
|
21197
|
+
* // "answerGenerationSpec": {},
|
|
21198
|
+
* // "boostControlIds": [],
|
|
21199
|
+
* // "createTime": "my_createTime",
|
|
21200
|
+
* // "displayName": "my_displayName",
|
|
21201
|
+
* // "dissociateControlIds": [],
|
|
21202
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
21203
|
+
* // "filterControlIds": [],
|
|
21204
|
+
* // "genericConfig": {},
|
|
21205
|
+
* // "ignoreControlIds": [],
|
|
21206
|
+
* // "mediaConfig": {},
|
|
21207
|
+
* // "modelId": "my_modelId",
|
|
21208
|
+
* // "name": "my_name",
|
|
21209
|
+
* // "onewaySynonymsControlIds": [],
|
|
21210
|
+
* // "promoteControlIds": [],
|
|
21211
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
21212
|
+
* // "redirectControlIds": [],
|
|
21213
|
+
* // "replacementControlIds": [],
|
|
21214
|
+
* // "solutionType": "my_solutionType",
|
|
21215
|
+
* // "synonymsControlIds": [],
|
|
21216
|
+
* // "updateTime": "my_updateTime"
|
|
21217
|
+
* // }
|
|
21218
|
+
* }
|
|
21219
|
+
*
|
|
21220
|
+
* main().catch(e => {
|
|
21221
|
+
* console.error(e);
|
|
21222
|
+
* throw e;
|
|
21223
|
+
* });
|
|
21224
|
+
*
|
|
21225
|
+
* ```
|
|
21226
|
+
*
|
|
21227
|
+
* @param params - Parameters for request
|
|
21228
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
21229
|
+
* @param callback - Optional callback that handles the response.
|
|
21230
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
21231
|
+
*/
|
|
21232
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
21233
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
21234
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
21235
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21236
|
+
create(params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21237
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
21063
21238
|
/**
|
|
21064
21239
|
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
21065
21240
|
* @example
|
|
@@ -21815,6 +21990,20 @@ export declare namespace discoveryengine_v1 {
|
|
|
21815
21990
|
*/
|
|
21816
21991
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
21817
21992
|
}
|
|
21993
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create extends StandardParameters {
|
|
21994
|
+
/**
|
|
21995
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
21996
|
+
*/
|
|
21997
|
+
parent?: string;
|
|
21998
|
+
/**
|
|
21999
|
+
* 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+/.
|
|
22000
|
+
*/
|
|
22001
|
+
servingConfigId?: string;
|
|
22002
|
+
/**
|
|
22003
|
+
* Request body metadata
|
|
22004
|
+
*/
|
|
22005
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ServingConfig;
|
|
22006
|
+
}
|
|
21818
22007
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
21819
22008
|
/**
|
|
21820
22009
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -27499,6 +27688,121 @@ export declare namespace discoveryengine_v1 {
|
|
|
27499
27688
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27500
27689
|
answer(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27501
27690
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
27691
|
+
/**
|
|
27692
|
+
* 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.
|
|
27693
|
+
* @example
|
|
27694
|
+
* ```js
|
|
27695
|
+
* // Before running the sample:
|
|
27696
|
+
* // - Enable the API at:
|
|
27697
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
27698
|
+
* // - Login into gcloud by running:
|
|
27699
|
+
* // ```sh
|
|
27700
|
+
* // $ gcloud auth application-default login
|
|
27701
|
+
* // ```
|
|
27702
|
+
* // - Install the npm module by running:
|
|
27703
|
+
* // ```sh
|
|
27704
|
+
* // $ npm install googleapis
|
|
27705
|
+
* // ```
|
|
27706
|
+
*
|
|
27707
|
+
* const {google} = require('googleapis');
|
|
27708
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
27709
|
+
*
|
|
27710
|
+
* async function main() {
|
|
27711
|
+
* const auth = new google.auth.GoogleAuth({
|
|
27712
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
27713
|
+
* scopes: [
|
|
27714
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
27715
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
27716
|
+
* ],
|
|
27717
|
+
* });
|
|
27718
|
+
*
|
|
27719
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
27720
|
+
* const authClient = await auth.getClient();
|
|
27721
|
+
* google.options({auth: authClient});
|
|
27722
|
+
*
|
|
27723
|
+
* // Do the magic
|
|
27724
|
+
* const res =
|
|
27725
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.create(
|
|
27726
|
+
* {
|
|
27727
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
27728
|
+
* parent:
|
|
27729
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
27730
|
+
* // 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+/.
|
|
27731
|
+
* servingConfigId: 'placeholder-value',
|
|
27732
|
+
*
|
|
27733
|
+
* // Request body metadata
|
|
27734
|
+
* requestBody: {
|
|
27735
|
+
* // request body parameters
|
|
27736
|
+
* // {
|
|
27737
|
+
* // "answerGenerationSpec": {},
|
|
27738
|
+
* // "boostControlIds": [],
|
|
27739
|
+
* // "createTime": "my_createTime",
|
|
27740
|
+
* // "displayName": "my_displayName",
|
|
27741
|
+
* // "dissociateControlIds": [],
|
|
27742
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
27743
|
+
* // "filterControlIds": [],
|
|
27744
|
+
* // "genericConfig": {},
|
|
27745
|
+
* // "ignoreControlIds": [],
|
|
27746
|
+
* // "mediaConfig": {},
|
|
27747
|
+
* // "modelId": "my_modelId",
|
|
27748
|
+
* // "name": "my_name",
|
|
27749
|
+
* // "onewaySynonymsControlIds": [],
|
|
27750
|
+
* // "promoteControlIds": [],
|
|
27751
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
27752
|
+
* // "redirectControlIds": [],
|
|
27753
|
+
* // "replacementControlIds": [],
|
|
27754
|
+
* // "solutionType": "my_solutionType",
|
|
27755
|
+
* // "synonymsControlIds": [],
|
|
27756
|
+
* // "updateTime": "my_updateTime"
|
|
27757
|
+
* // }
|
|
27758
|
+
* },
|
|
27759
|
+
* },
|
|
27760
|
+
* );
|
|
27761
|
+
* console.log(res.data);
|
|
27762
|
+
*
|
|
27763
|
+
* // Example response
|
|
27764
|
+
* // {
|
|
27765
|
+
* // "answerGenerationSpec": {},
|
|
27766
|
+
* // "boostControlIds": [],
|
|
27767
|
+
* // "createTime": "my_createTime",
|
|
27768
|
+
* // "displayName": "my_displayName",
|
|
27769
|
+
* // "dissociateControlIds": [],
|
|
27770
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
27771
|
+
* // "filterControlIds": [],
|
|
27772
|
+
* // "genericConfig": {},
|
|
27773
|
+
* // "ignoreControlIds": [],
|
|
27774
|
+
* // "mediaConfig": {},
|
|
27775
|
+
* // "modelId": "my_modelId",
|
|
27776
|
+
* // "name": "my_name",
|
|
27777
|
+
* // "onewaySynonymsControlIds": [],
|
|
27778
|
+
* // "promoteControlIds": [],
|
|
27779
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
27780
|
+
* // "redirectControlIds": [],
|
|
27781
|
+
* // "replacementControlIds": [],
|
|
27782
|
+
* // "solutionType": "my_solutionType",
|
|
27783
|
+
* // "synonymsControlIds": [],
|
|
27784
|
+
* // "updateTime": "my_updateTime"
|
|
27785
|
+
* // }
|
|
27786
|
+
* }
|
|
27787
|
+
*
|
|
27788
|
+
* main().catch(e => {
|
|
27789
|
+
* console.error(e);
|
|
27790
|
+
* throw e;
|
|
27791
|
+
* });
|
|
27792
|
+
*
|
|
27793
|
+
* ```
|
|
27794
|
+
*
|
|
27795
|
+
* @param params - Parameters for request
|
|
27796
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
27797
|
+
* @param callback - Optional callback that handles the response.
|
|
27798
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
27799
|
+
*/
|
|
27800
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
27801
|
+
create(params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
27802
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
27803
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27804
|
+
create(params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27805
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
27502
27806
|
/**
|
|
27503
27807
|
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
27504
27808
|
* @example
|
|
@@ -28254,6 +28558,20 @@ export declare namespace discoveryengine_v1 {
|
|
|
28254
28558
|
*/
|
|
28255
28559
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
28256
28560
|
}
|
|
28561
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create extends StandardParameters {
|
|
28562
|
+
/**
|
|
28563
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
28564
|
+
*/
|
|
28565
|
+
parent?: string;
|
|
28566
|
+
/**
|
|
28567
|
+
* 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+/.
|
|
28568
|
+
*/
|
|
28569
|
+
servingConfigId?: string;
|
|
28570
|
+
/**
|
|
28571
|
+
* Request body metadata
|
|
28572
|
+
*/
|
|
28573
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ServingConfig;
|
|
28574
|
+
}
|
|
28257
28575
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
|
|
28258
28576
|
/**
|
|
28259
28577
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -33199,6 +33517,119 @@ export declare namespace discoveryengine_v1 {
|
|
|
33199
33517
|
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
33200
33518
|
answer(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
33201
33519
|
answer(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse>): void;
|
|
33520
|
+
/**
|
|
33521
|
+
* 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.
|
|
33522
|
+
* @example
|
|
33523
|
+
* ```js
|
|
33524
|
+
* // Before running the sample:
|
|
33525
|
+
* // - Enable the API at:
|
|
33526
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33527
|
+
* // - Login into gcloud by running:
|
|
33528
|
+
* // ```sh
|
|
33529
|
+
* // $ gcloud auth application-default login
|
|
33530
|
+
* // ```
|
|
33531
|
+
* // - Install the npm module by running:
|
|
33532
|
+
* // ```sh
|
|
33533
|
+
* // $ npm install googleapis
|
|
33534
|
+
* // ```
|
|
33535
|
+
*
|
|
33536
|
+
* const {google} = require('googleapis');
|
|
33537
|
+
* const discoveryengine = google.discoveryengine('v1');
|
|
33538
|
+
*
|
|
33539
|
+
* async function main() {
|
|
33540
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33541
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33542
|
+
* scopes: [
|
|
33543
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33544
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33545
|
+
* ],
|
|
33546
|
+
* });
|
|
33547
|
+
*
|
|
33548
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33549
|
+
* const authClient = await auth.getClient();
|
|
33550
|
+
* google.options({auth: authClient});
|
|
33551
|
+
*
|
|
33552
|
+
* // Do the magic
|
|
33553
|
+
* const res =
|
|
33554
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.create({
|
|
33555
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
33556
|
+
* parent:
|
|
33557
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
33558
|
+
* // 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+/.
|
|
33559
|
+
* servingConfigId: 'placeholder-value',
|
|
33560
|
+
*
|
|
33561
|
+
* // Request body metadata
|
|
33562
|
+
* requestBody: {
|
|
33563
|
+
* // request body parameters
|
|
33564
|
+
* // {
|
|
33565
|
+
* // "answerGenerationSpec": {},
|
|
33566
|
+
* // "boostControlIds": [],
|
|
33567
|
+
* // "createTime": "my_createTime",
|
|
33568
|
+
* // "displayName": "my_displayName",
|
|
33569
|
+
* // "dissociateControlIds": [],
|
|
33570
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
33571
|
+
* // "filterControlIds": [],
|
|
33572
|
+
* // "genericConfig": {},
|
|
33573
|
+
* // "ignoreControlIds": [],
|
|
33574
|
+
* // "mediaConfig": {},
|
|
33575
|
+
* // "modelId": "my_modelId",
|
|
33576
|
+
* // "name": "my_name",
|
|
33577
|
+
* // "onewaySynonymsControlIds": [],
|
|
33578
|
+
* // "promoteControlIds": [],
|
|
33579
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
33580
|
+
* // "redirectControlIds": [],
|
|
33581
|
+
* // "replacementControlIds": [],
|
|
33582
|
+
* // "solutionType": "my_solutionType",
|
|
33583
|
+
* // "synonymsControlIds": [],
|
|
33584
|
+
* // "updateTime": "my_updateTime"
|
|
33585
|
+
* // }
|
|
33586
|
+
* },
|
|
33587
|
+
* });
|
|
33588
|
+
* console.log(res.data);
|
|
33589
|
+
*
|
|
33590
|
+
* // Example response
|
|
33591
|
+
* // {
|
|
33592
|
+
* // "answerGenerationSpec": {},
|
|
33593
|
+
* // "boostControlIds": [],
|
|
33594
|
+
* // "createTime": "my_createTime",
|
|
33595
|
+
* // "displayName": "my_displayName",
|
|
33596
|
+
* // "dissociateControlIds": [],
|
|
33597
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
33598
|
+
* // "filterControlIds": [],
|
|
33599
|
+
* // "genericConfig": {},
|
|
33600
|
+
* // "ignoreControlIds": [],
|
|
33601
|
+
* // "mediaConfig": {},
|
|
33602
|
+
* // "modelId": "my_modelId",
|
|
33603
|
+
* // "name": "my_name",
|
|
33604
|
+
* // "onewaySynonymsControlIds": [],
|
|
33605
|
+
* // "promoteControlIds": [],
|
|
33606
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
33607
|
+
* // "redirectControlIds": [],
|
|
33608
|
+
* // "replacementControlIds": [],
|
|
33609
|
+
* // "solutionType": "my_solutionType",
|
|
33610
|
+
* // "synonymsControlIds": [],
|
|
33611
|
+
* // "updateTime": "my_updateTime"
|
|
33612
|
+
* // }
|
|
33613
|
+
* }
|
|
33614
|
+
*
|
|
33615
|
+
* main().catch(e => {
|
|
33616
|
+
* console.error(e);
|
|
33617
|
+
* throw e;
|
|
33618
|
+
* });
|
|
33619
|
+
*
|
|
33620
|
+
* ```
|
|
33621
|
+
*
|
|
33622
|
+
* @param params - Parameters for request
|
|
33623
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33624
|
+
* @param callback - Optional callback that handles the response.
|
|
33625
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33626
|
+
*/
|
|
33627
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33628
|
+
create(params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1ServingConfig>>;
|
|
33629
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
33630
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33631
|
+
create(params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33632
|
+
create(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1ServingConfig>): void;
|
|
33202
33633
|
/**
|
|
33203
33634
|
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
33204
33635
|
* @example
|
|
@@ -33944,6 +34375,20 @@ export declare namespace discoveryengine_v1 {
|
|
|
33944
34375
|
*/
|
|
33945
34376
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest;
|
|
33946
34377
|
}
|
|
34378
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create extends StandardParameters {
|
|
34379
|
+
/**
|
|
34380
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
34381
|
+
*/
|
|
34382
|
+
parent?: string;
|
|
34383
|
+
/**
|
|
34384
|
+
* 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+/.
|
|
34385
|
+
*/
|
|
34386
|
+
servingConfigId?: string;
|
|
34387
|
+
/**
|
|
34388
|
+
* Request body metadata
|
|
34389
|
+
*/
|
|
34390
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1ServingConfig;
|
|
34391
|
+
}
|
|
33947
34392
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
33948
34393
|
/**
|
|
33949
34394
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|