@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/v1beta.ts
CHANGED
|
@@ -4086,12 +4086,16 @@ export namespace discoveryengine_v1beta {
|
|
|
4086
4086
|
* 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.
|
|
4087
4087
|
*/
|
|
4088
4088
|
regionCode?: string | null;
|
|
4089
|
+
/**
|
|
4090
|
+
* 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.
|
|
4091
|
+
*/
|
|
4092
|
+
relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec;
|
|
4089
4093
|
/**
|
|
4090
4094
|
* Optional. The specification for returning the relevance score.
|
|
4091
4095
|
*/
|
|
4092
4096
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceScoreSpec;
|
|
4093
4097
|
/**
|
|
4094
|
-
* The relevance threshold of the search results.
|
|
4098
|
+
* 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.
|
|
4095
4099
|
*/
|
|
4096
4100
|
relevanceThreshold?: string | null;
|
|
4097
4101
|
/**
|
|
@@ -4530,6 +4534,32 @@ export namespace discoveryengine_v1beta {
|
|
|
4530
4534
|
*/
|
|
4531
4535
|
pinUnexpandedResults?: boolean | null;
|
|
4532
4536
|
}
|
|
4537
|
+
/**
|
|
4538
|
+
* Relevance filtering specification.
|
|
4539
|
+
*/
|
|
4540
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpec {
|
|
4541
|
+
/**
|
|
4542
|
+
* Optional. Relevance filtering threshold specification for keyword search.
|
|
4543
|
+
*/
|
|
4544
|
+
keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
4545
|
+
/**
|
|
4546
|
+
* Optional. Relevance filtering threshold specification for semantic search.
|
|
4547
|
+
*/
|
|
4548
|
+
semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
4549
|
+
}
|
|
4550
|
+
/**
|
|
4551
|
+
* Specification for relevance filtering on a specific sub-search.
|
|
4552
|
+
*/
|
|
4553
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
4554
|
+
/**
|
|
4555
|
+
* Pre-defined relevance threshold for the sub-search.
|
|
4556
|
+
*/
|
|
4557
|
+
relevanceThreshold?: string | null;
|
|
4558
|
+
/**
|
|
4559
|
+
* Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
|
|
4560
|
+
*/
|
|
4561
|
+
semanticRelevanceThreshold?: number | null;
|
|
4562
|
+
}
|
|
4533
4563
|
/**
|
|
4534
4564
|
* The specification for returning the document relevance score.
|
|
4535
4565
|
*/
|
|
@@ -10732,12 +10762,16 @@ export namespace discoveryengine_v1beta {
|
|
|
10732
10762
|
* 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.
|
|
10733
10763
|
*/
|
|
10734
10764
|
regionCode?: string | null;
|
|
10765
|
+
/**
|
|
10766
|
+
* 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.
|
|
10767
|
+
*/
|
|
10768
|
+
relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec;
|
|
10735
10769
|
/**
|
|
10736
10770
|
* Optional. The specification for returning the relevance score.
|
|
10737
10771
|
*/
|
|
10738
10772
|
relevanceScoreSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceScoreSpec;
|
|
10739
10773
|
/**
|
|
10740
|
-
* The relevance threshold of the search results.
|
|
10774
|
+
* 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.
|
|
10741
10775
|
*/
|
|
10742
10776
|
relevanceThreshold?: string | null;
|
|
10743
10777
|
/**
|
|
@@ -11172,6 +11206,32 @@ export namespace discoveryengine_v1beta {
|
|
|
11172
11206
|
*/
|
|
11173
11207
|
pinUnexpandedResults?: boolean | null;
|
|
11174
11208
|
}
|
|
11209
|
+
/**
|
|
11210
|
+
* Relevance filtering specification.
|
|
11211
|
+
*/
|
|
11212
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpec {
|
|
11213
|
+
/**
|
|
11214
|
+
* Optional. Relevance filtering threshold specification for keyword search.
|
|
11215
|
+
*/
|
|
11216
|
+
keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
11217
|
+
/**
|
|
11218
|
+
* Optional. Relevance filtering threshold specification for semantic search.
|
|
11219
|
+
*/
|
|
11220
|
+
semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
|
|
11221
|
+
}
|
|
11222
|
+
/**
|
|
11223
|
+
* Specification for relevance filtering on a specific sub-search.
|
|
11224
|
+
*/
|
|
11225
|
+
export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
|
|
11226
|
+
/**
|
|
11227
|
+
* Pre-defined relevance threshold for the sub-search.
|
|
11228
|
+
*/
|
|
11229
|
+
relevanceThreshold?: string | null;
|
|
11230
|
+
/**
|
|
11231
|
+
* Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
|
|
11232
|
+
*/
|
|
11233
|
+
semanticRelevanceThreshold?: number | null;
|
|
11234
|
+
}
|
|
11175
11235
|
/**
|
|
11176
11236
|
* The specification for returning the document relevance score.
|
|
11177
11237
|
*/
|
|
@@ -25923,7 +25983,7 @@ export namespace discoveryengine_v1beta {
|
|
|
25923
25983
|
}
|
|
25924
25984
|
|
|
25925
25985
|
/**
|
|
25926
|
-
*
|
|
25986
|
+
* 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.
|
|
25927
25987
|
* @example
|
|
25928
25988
|
* ```js
|
|
25929
25989
|
* // Before running the sample:
|
|
@@ -25956,150 +26016,42 @@ export namespace discoveryengine_v1beta {
|
|
|
25956
26016
|
*
|
|
25957
26017
|
* // Do the magic
|
|
25958
26018
|
* const res =
|
|
25959
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.
|
|
26019
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.create(
|
|
25960
26020
|
* {
|
|
25961
|
-
* // Required.
|
|
25962
|
-
*
|
|
25963
|
-
*
|
|
25964
|
-
*
|
|
25965
|
-
*
|
|
25966
|
-
*
|
|
25967
|
-
* // Example response
|
|
25968
|
-
* // {}
|
|
25969
|
-
* }
|
|
25970
|
-
*
|
|
25971
|
-
* main().catch(e => {
|
|
25972
|
-
* console.error(e);
|
|
25973
|
-
* throw e;
|
|
25974
|
-
* });
|
|
25975
|
-
*
|
|
25976
|
-
* ```
|
|
25977
|
-
*
|
|
25978
|
-
* @param params - Parameters for request
|
|
25979
|
-
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
25980
|
-
* @param callback - Optional callback that handles the response.
|
|
25981
|
-
* @returns A promise if used with async/await, or void if used with a callback.
|
|
25982
|
-
*/
|
|
25983
|
-
delete(
|
|
25984
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
25985
|
-
options: StreamMethodOptions
|
|
25986
|
-
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
25987
|
-
delete(
|
|
25988
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
25989
|
-
options?: MethodOptions
|
|
25990
|
-
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
25991
|
-
delete(
|
|
25992
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
25993
|
-
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
25994
|
-
callback: BodyResponseCallback<Readable>
|
|
25995
|
-
): void;
|
|
25996
|
-
delete(
|
|
25997
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
25998
|
-
options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>,
|
|
25999
|
-
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26000
|
-
): void;
|
|
26001
|
-
delete(
|
|
26002
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
26003
|
-
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26004
|
-
): void;
|
|
26005
|
-
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
26006
|
-
delete(
|
|
26007
|
-
paramsOrCallback?:
|
|
26008
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete
|
|
26009
|
-
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26010
|
-
| BodyResponseCallback<Readable>,
|
|
26011
|
-
optionsOrCallback?:
|
|
26012
|
-
| MethodOptions
|
|
26013
|
-
| StreamMethodOptions
|
|
26014
|
-
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26015
|
-
| BodyResponseCallback<Readable>,
|
|
26016
|
-
callback?:
|
|
26017
|
-
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26018
|
-
| BodyResponseCallback<Readable>
|
|
26019
|
-
):
|
|
26020
|
-
| void
|
|
26021
|
-
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>
|
|
26022
|
-
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
26023
|
-
let params = (paramsOrCallback ||
|
|
26024
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete;
|
|
26025
|
-
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
26026
|
-
|
|
26027
|
-
if (typeof paramsOrCallback === 'function') {
|
|
26028
|
-
callback = paramsOrCallback;
|
|
26029
|
-
params =
|
|
26030
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete;
|
|
26031
|
-
options = {};
|
|
26032
|
-
}
|
|
26033
|
-
|
|
26034
|
-
if (typeof optionsOrCallback === 'function') {
|
|
26035
|
-
callback = optionsOrCallback;
|
|
26036
|
-
options = {};
|
|
26037
|
-
}
|
|
26038
|
-
|
|
26039
|
-
const rootUrl =
|
|
26040
|
-
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
26041
|
-
const parameters = {
|
|
26042
|
-
options: Object.assign(
|
|
26043
|
-
{
|
|
26044
|
-
url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
26045
|
-
method: 'DELETE',
|
|
26046
|
-
apiVersion: '',
|
|
26047
|
-
},
|
|
26048
|
-
options
|
|
26049
|
-
),
|
|
26050
|
-
params,
|
|
26051
|
-
requiredParams: ['name'],
|
|
26052
|
-
pathParams: ['name'],
|
|
26053
|
-
context: this.context,
|
|
26054
|
-
};
|
|
26055
|
-
if (callback) {
|
|
26056
|
-
createAPIRequest<Schema$GoogleProtobufEmpty>(
|
|
26057
|
-
parameters,
|
|
26058
|
-
callback as BodyResponseCallback<unknown>
|
|
26059
|
-
);
|
|
26060
|
-
} else {
|
|
26061
|
-
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
|
|
26062
|
-
}
|
|
26063
|
-
}
|
|
26064
|
-
|
|
26065
|
-
/**
|
|
26066
|
-
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
26067
|
-
* @example
|
|
26068
|
-
* ```js
|
|
26069
|
-
* // Before running the sample:
|
|
26070
|
-
* // - Enable the API at:
|
|
26071
|
-
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
26072
|
-
* // - Login into gcloud by running:
|
|
26073
|
-
* // ```sh
|
|
26074
|
-
* // $ gcloud auth application-default login
|
|
26075
|
-
* // ```
|
|
26076
|
-
* // - Install the npm module by running:
|
|
26077
|
-
* // ```sh
|
|
26078
|
-
* // $ npm install googleapis
|
|
26079
|
-
* // ```
|
|
26080
|
-
*
|
|
26081
|
-
* const {google} = require('googleapis');
|
|
26082
|
-
* const discoveryengine = google.discoveryengine('v1beta');
|
|
26083
|
-
*
|
|
26084
|
-
* async function main() {
|
|
26085
|
-
* const auth = new google.auth.GoogleAuth({
|
|
26086
|
-
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
26087
|
-
* scopes: [
|
|
26088
|
-
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
26089
|
-
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
26090
|
-
* ],
|
|
26091
|
-
* });
|
|
26092
|
-
*
|
|
26093
|
-
* // Acquire an auth client, and bind it to all future calls
|
|
26094
|
-
* const authClient = await auth.getClient();
|
|
26095
|
-
* google.options({auth: authClient});
|
|
26021
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
26022
|
+
* parent:
|
|
26023
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
26024
|
+
* // 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+/.
|
|
26025
|
+
* servingConfigId: 'placeholder-value',
|
|
26096
26026
|
*
|
|
26097
|
-
*
|
|
26098
|
-
*
|
|
26099
|
-
*
|
|
26100
|
-
*
|
|
26101
|
-
*
|
|
26102
|
-
*
|
|
26027
|
+
* // Request body metadata
|
|
26028
|
+
* requestBody: {
|
|
26029
|
+
* // request body parameters
|
|
26030
|
+
* // {
|
|
26031
|
+
* // "answerGenerationSpec": {},
|
|
26032
|
+
* // "boostControlIds": [],
|
|
26033
|
+
* // "createTime": "my_createTime",
|
|
26034
|
+
* // "displayName": "my_displayName",
|
|
26035
|
+
* // "dissociateControlIds": [],
|
|
26036
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
26037
|
+
* // "embeddingConfig": {},
|
|
26038
|
+
* // "filterControlIds": [],
|
|
26039
|
+
* // "genericConfig": {},
|
|
26040
|
+
* // "ignoreControlIds": [],
|
|
26041
|
+
* // "mediaConfig": {},
|
|
26042
|
+
* // "modelId": "my_modelId",
|
|
26043
|
+
* // "name": "my_name",
|
|
26044
|
+
* // "onewaySynonymsControlIds": [],
|
|
26045
|
+
* // "personalizationSpec": {},
|
|
26046
|
+
* // "promoteControlIds": [],
|
|
26047
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
26048
|
+
* // "redirectControlIds": [],
|
|
26049
|
+
* // "replacementControlIds": [],
|
|
26050
|
+
* // "solutionType": "my_solutionType",
|
|
26051
|
+
* // "synonymsControlIds": [],
|
|
26052
|
+
* // "updateTime": "my_updateTime"
|
|
26053
|
+
* // }
|
|
26054
|
+
* },
|
|
26103
26055
|
* },
|
|
26104
26056
|
* );
|
|
26105
26057
|
* console.log(res.data);
|
|
@@ -26143,38 +26095,38 @@ export namespace discoveryengine_v1beta {
|
|
|
26143
26095
|
* @param callback - Optional callback that handles the response.
|
|
26144
26096
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
26145
26097
|
*/
|
|
26146
|
-
|
|
26147
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26098
|
+
create(
|
|
26099
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create,
|
|
26148
26100
|
options: StreamMethodOptions
|
|
26149
26101
|
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
26150
|
-
|
|
26151
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26102
|
+
create(
|
|
26103
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create,
|
|
26152
26104
|
options?: MethodOptions
|
|
26153
26105
|
): Promise<
|
|
26154
26106
|
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26155
26107
|
>;
|
|
26156
|
-
|
|
26157
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26108
|
+
create(
|
|
26109
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create,
|
|
26158
26110
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
26159
26111
|
callback: BodyResponseCallback<Readable>
|
|
26160
26112
|
): void;
|
|
26161
|
-
|
|
26162
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26113
|
+
create(
|
|
26114
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create,
|
|
26163
26115
|
options:
|
|
26164
26116
|
| MethodOptions
|
|
26165
26117
|
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
|
|
26166
26118
|
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26167
26119
|
): void;
|
|
26168
|
-
|
|
26169
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26120
|
+
create(
|
|
26121
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create,
|
|
26170
26122
|
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26171
26123
|
): void;
|
|
26172
|
-
|
|
26124
|
+
create(
|
|
26173
26125
|
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26174
26126
|
): void;
|
|
26175
|
-
|
|
26127
|
+
create(
|
|
26176
26128
|
paramsOrCallback?:
|
|
26177
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26129
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create
|
|
26178
26130
|
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26179
26131
|
| BodyResponseCallback<Readable>,
|
|
26180
26132
|
optionsOrCallback?:
|
|
@@ -26192,13 +26144,13 @@ export namespace discoveryengine_v1beta {
|
|
|
26192
26144
|
>
|
|
26193
26145
|
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
26194
26146
|
let params = (paramsOrCallback ||
|
|
26195
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26147
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create;
|
|
26196
26148
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
26197
26149
|
|
|
26198
26150
|
if (typeof paramsOrCallback === 'function') {
|
|
26199
26151
|
callback = paramsOrCallback;
|
|
26200
26152
|
params =
|
|
26201
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26153
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create;
|
|
26202
26154
|
options = {};
|
|
26203
26155
|
}
|
|
26204
26156
|
|
|
@@ -26212,15 +26164,18 @@ export namespace discoveryengine_v1beta {
|
|
|
26212
26164
|
const parameters = {
|
|
26213
26165
|
options: Object.assign(
|
|
26214
26166
|
{
|
|
26215
|
-
url: (rootUrl + '/v1beta/{+
|
|
26216
|
-
|
|
26167
|
+
url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace(
|
|
26168
|
+
/([^:]\/)\/+/g,
|
|
26169
|
+
'$1'
|
|
26170
|
+
),
|
|
26171
|
+
method: 'POST',
|
|
26217
26172
|
apiVersion: '',
|
|
26218
26173
|
},
|
|
26219
26174
|
options
|
|
26220
26175
|
),
|
|
26221
26176
|
params,
|
|
26222
|
-
requiredParams: ['
|
|
26223
|
-
pathParams: ['
|
|
26177
|
+
requiredParams: ['parent'],
|
|
26178
|
+
pathParams: ['parent'],
|
|
26224
26179
|
context: this.context,
|
|
26225
26180
|
};
|
|
26226
26181
|
if (callback) {
|
|
@@ -26236,7 +26191,7 @@ export namespace discoveryengine_v1beta {
|
|
|
26236
26191
|
}
|
|
26237
26192
|
|
|
26238
26193
|
/**
|
|
26239
|
-
*
|
|
26194
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
26240
26195
|
* @example
|
|
26241
26196
|
* ```js
|
|
26242
26197
|
* // Before running the sample:
|
|
@@ -26269,24 +26224,16 @@ export namespace discoveryengine_v1beta {
|
|
|
26269
26224
|
*
|
|
26270
26225
|
* // Do the magic
|
|
26271
26226
|
* const res =
|
|
26272
|
-
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.
|
|
26227
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.delete(
|
|
26273
26228
|
* {
|
|
26274
|
-
* //
|
|
26275
|
-
*
|
|
26276
|
-
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
26277
|
-
* pageToken: 'placeholder-value',
|
|
26278
|
-
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
26279
|
-
* parent:
|
|
26280
|
-
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
26229
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
26230
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
26281
26231
|
* },
|
|
26282
26232
|
* );
|
|
26283
26233
|
* console.log(res.data);
|
|
26284
26234
|
*
|
|
26285
26235
|
* // Example response
|
|
26286
|
-
* // {
|
|
26287
|
-
* // "nextPageToken": "my_nextPageToken",
|
|
26288
|
-
* // "servingConfigs": []
|
|
26289
|
-
* // }
|
|
26236
|
+
* // {}
|
|
26290
26237
|
* }
|
|
26291
26238
|
*
|
|
26292
26239
|
* main().catch(e => {
|
|
@@ -26301,62 +26248,54 @@ export namespace discoveryengine_v1beta {
|
|
|
26301
26248
|
* @param callback - Optional callback that handles the response.
|
|
26302
26249
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
26303
26250
|
*/
|
|
26304
|
-
|
|
26305
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26251
|
+
delete(
|
|
26252
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
26306
26253
|
options: StreamMethodOptions
|
|
26307
26254
|
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
26308
|
-
|
|
26309
|
-
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26255
|
+
delete(
|
|
26256
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
26310
26257
|
options?: MethodOptions
|
|
26311
|
-
): Promise<
|
|
26312
|
-
|
|
26313
|
-
|
|
26314
|
-
list(
|
|
26315
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
26258
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
26259
|
+
delete(
|
|
26260
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
26316
26261
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
26317
26262
|
callback: BodyResponseCallback<Readable>
|
|
26318
26263
|
): void;
|
|
26319
|
-
|
|
26320
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26321
|
-
options:
|
|
26322
|
-
|
|
26323
|
-
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>,
|
|
26324
|
-
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26325
|
-
): void;
|
|
26326
|
-
list(
|
|
26327
|
-
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
26328
|
-
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26264
|
+
delete(
|
|
26265
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
26266
|
+
options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>,
|
|
26267
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26329
26268
|
): void;
|
|
26330
|
-
|
|
26331
|
-
|
|
26269
|
+
delete(
|
|
26270
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
26271
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26332
26272
|
): void;
|
|
26333
|
-
|
|
26273
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
26274
|
+
delete(
|
|
26334
26275
|
paramsOrCallback?:
|
|
26335
|
-
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26336
|
-
| BodyResponseCallback<Schema$
|
|
26276
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete
|
|
26277
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26337
26278
|
| BodyResponseCallback<Readable>,
|
|
26338
26279
|
optionsOrCallback?:
|
|
26339
26280
|
| MethodOptions
|
|
26340
26281
|
| StreamMethodOptions
|
|
26341
|
-
| BodyResponseCallback<Schema$
|
|
26282
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26342
26283
|
| BodyResponseCallback<Readable>,
|
|
26343
26284
|
callback?:
|
|
26344
|
-
| BodyResponseCallback<Schema$
|
|
26285
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
26345
26286
|
| BodyResponseCallback<Readable>
|
|
26346
26287
|
):
|
|
26347
26288
|
| void
|
|
26348
|
-
| Promise<
|
|
26349
|
-
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26350
|
-
>
|
|
26289
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>
|
|
26351
26290
|
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
26352
26291
|
let params = (paramsOrCallback ||
|
|
26353
|
-
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26292
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete;
|
|
26354
26293
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
26355
26294
|
|
|
26356
26295
|
if (typeof paramsOrCallback === 'function') {
|
|
26357
26296
|
callback = paramsOrCallback;
|
|
26358
26297
|
params =
|
|
26359
|
-
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$
|
|
26298
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete;
|
|
26360
26299
|
options = {};
|
|
26361
26300
|
}
|
|
26362
26301
|
|
|
@@ -26370,34 +26309,363 @@ export namespace discoveryengine_v1beta {
|
|
|
26370
26309
|
const parameters = {
|
|
26371
26310
|
options: Object.assign(
|
|
26372
26311
|
{
|
|
26373
|
-
url: (rootUrl + '/v1beta/{+
|
|
26374
|
-
|
|
26375
|
-
'$1'
|
|
26376
|
-
),
|
|
26377
|
-
method: 'GET',
|
|
26312
|
+
url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
26313
|
+
method: 'DELETE',
|
|
26378
26314
|
apiVersion: '',
|
|
26379
26315
|
},
|
|
26380
26316
|
options
|
|
26381
26317
|
),
|
|
26382
26318
|
params,
|
|
26383
|
-
requiredParams: ['
|
|
26384
|
-
pathParams: ['
|
|
26319
|
+
requiredParams: ['name'],
|
|
26320
|
+
pathParams: ['name'],
|
|
26385
26321
|
context: this.context,
|
|
26386
26322
|
};
|
|
26387
26323
|
if (callback) {
|
|
26388
|
-
createAPIRequest<Schema$
|
|
26324
|
+
createAPIRequest<Schema$GoogleProtobufEmpty>(
|
|
26389
26325
|
parameters,
|
|
26390
26326
|
callback as BodyResponseCallback<unknown>
|
|
26391
26327
|
);
|
|
26392
26328
|
} else {
|
|
26393
|
-
return createAPIRequest<Schema$
|
|
26394
|
-
parameters
|
|
26395
|
-
);
|
|
26329
|
+
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
|
|
26396
26330
|
}
|
|
26397
26331
|
}
|
|
26398
26332
|
|
|
26399
26333
|
/**
|
|
26400
|
-
*
|
|
26334
|
+
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
26335
|
+
* @example
|
|
26336
|
+
* ```js
|
|
26337
|
+
* // Before running the sample:
|
|
26338
|
+
* // - Enable the API at:
|
|
26339
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
26340
|
+
* // - Login into gcloud by running:
|
|
26341
|
+
* // ```sh
|
|
26342
|
+
* // $ gcloud auth application-default login
|
|
26343
|
+
* // ```
|
|
26344
|
+
* // - Install the npm module by running:
|
|
26345
|
+
* // ```sh
|
|
26346
|
+
* // $ npm install googleapis
|
|
26347
|
+
* // ```
|
|
26348
|
+
*
|
|
26349
|
+
* const {google} = require('googleapis');
|
|
26350
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
26351
|
+
*
|
|
26352
|
+
* async function main() {
|
|
26353
|
+
* const auth = new google.auth.GoogleAuth({
|
|
26354
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
26355
|
+
* scopes: [
|
|
26356
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
26357
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
26358
|
+
* ],
|
|
26359
|
+
* });
|
|
26360
|
+
*
|
|
26361
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
26362
|
+
* const authClient = await auth.getClient();
|
|
26363
|
+
* google.options({auth: authClient});
|
|
26364
|
+
*
|
|
26365
|
+
* // Do the magic
|
|
26366
|
+
* const res =
|
|
26367
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.get(
|
|
26368
|
+
* {
|
|
26369
|
+
* // Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
26370
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
26371
|
+
* },
|
|
26372
|
+
* );
|
|
26373
|
+
* console.log(res.data);
|
|
26374
|
+
*
|
|
26375
|
+
* // Example response
|
|
26376
|
+
* // {
|
|
26377
|
+
* // "answerGenerationSpec": {},
|
|
26378
|
+
* // "boostControlIds": [],
|
|
26379
|
+
* // "createTime": "my_createTime",
|
|
26380
|
+
* // "displayName": "my_displayName",
|
|
26381
|
+
* // "dissociateControlIds": [],
|
|
26382
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
26383
|
+
* // "embeddingConfig": {},
|
|
26384
|
+
* // "filterControlIds": [],
|
|
26385
|
+
* // "genericConfig": {},
|
|
26386
|
+
* // "ignoreControlIds": [],
|
|
26387
|
+
* // "mediaConfig": {},
|
|
26388
|
+
* // "modelId": "my_modelId",
|
|
26389
|
+
* // "name": "my_name",
|
|
26390
|
+
* // "onewaySynonymsControlIds": [],
|
|
26391
|
+
* // "personalizationSpec": {},
|
|
26392
|
+
* // "promoteControlIds": [],
|
|
26393
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
26394
|
+
* // "redirectControlIds": [],
|
|
26395
|
+
* // "replacementControlIds": [],
|
|
26396
|
+
* // "solutionType": "my_solutionType",
|
|
26397
|
+
* // "synonymsControlIds": [],
|
|
26398
|
+
* // "updateTime": "my_updateTime"
|
|
26399
|
+
* // }
|
|
26400
|
+
* }
|
|
26401
|
+
*
|
|
26402
|
+
* main().catch(e => {
|
|
26403
|
+
* console.error(e);
|
|
26404
|
+
* throw e;
|
|
26405
|
+
* });
|
|
26406
|
+
*
|
|
26407
|
+
* ```
|
|
26408
|
+
*
|
|
26409
|
+
* @param params - Parameters for request
|
|
26410
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
26411
|
+
* @param callback - Optional callback that handles the response.
|
|
26412
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
26413
|
+
*/
|
|
26414
|
+
get(
|
|
26415
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
26416
|
+
options: StreamMethodOptions
|
|
26417
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
26418
|
+
get(
|
|
26419
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
26420
|
+
options?: MethodOptions
|
|
26421
|
+
): Promise<
|
|
26422
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26423
|
+
>;
|
|
26424
|
+
get(
|
|
26425
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
26426
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
26427
|
+
callback: BodyResponseCallback<Readable>
|
|
26428
|
+
): void;
|
|
26429
|
+
get(
|
|
26430
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
26431
|
+
options:
|
|
26432
|
+
| MethodOptions
|
|
26433
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
|
|
26434
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26435
|
+
): void;
|
|
26436
|
+
get(
|
|
26437
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get,
|
|
26438
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26439
|
+
): void;
|
|
26440
|
+
get(
|
|
26441
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26442
|
+
): void;
|
|
26443
|
+
get(
|
|
26444
|
+
paramsOrCallback?:
|
|
26445
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get
|
|
26446
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26447
|
+
| BodyResponseCallback<Readable>,
|
|
26448
|
+
optionsOrCallback?:
|
|
26449
|
+
| MethodOptions
|
|
26450
|
+
| StreamMethodOptions
|
|
26451
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26452
|
+
| BodyResponseCallback<Readable>,
|
|
26453
|
+
callback?:
|
|
26454
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26455
|
+
| BodyResponseCallback<Readable>
|
|
26456
|
+
):
|
|
26457
|
+
| void
|
|
26458
|
+
| Promise<
|
|
26459
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
26460
|
+
>
|
|
26461
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
26462
|
+
let params = (paramsOrCallback ||
|
|
26463
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
|
|
26464
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
26465
|
+
|
|
26466
|
+
if (typeof paramsOrCallback === 'function') {
|
|
26467
|
+
callback = paramsOrCallback;
|
|
26468
|
+
params =
|
|
26469
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get;
|
|
26470
|
+
options = {};
|
|
26471
|
+
}
|
|
26472
|
+
|
|
26473
|
+
if (typeof optionsOrCallback === 'function') {
|
|
26474
|
+
callback = optionsOrCallback;
|
|
26475
|
+
options = {};
|
|
26476
|
+
}
|
|
26477
|
+
|
|
26478
|
+
const rootUrl =
|
|
26479
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
26480
|
+
const parameters = {
|
|
26481
|
+
options: Object.assign(
|
|
26482
|
+
{
|
|
26483
|
+
url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
26484
|
+
method: 'GET',
|
|
26485
|
+
apiVersion: '',
|
|
26486
|
+
},
|
|
26487
|
+
options
|
|
26488
|
+
),
|
|
26489
|
+
params,
|
|
26490
|
+
requiredParams: ['name'],
|
|
26491
|
+
pathParams: ['name'],
|
|
26492
|
+
context: this.context,
|
|
26493
|
+
};
|
|
26494
|
+
if (callback) {
|
|
26495
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
|
|
26496
|
+
parameters,
|
|
26497
|
+
callback as BodyResponseCallback<unknown>
|
|
26498
|
+
);
|
|
26499
|
+
} else {
|
|
26500
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
|
|
26501
|
+
parameters
|
|
26502
|
+
);
|
|
26503
|
+
}
|
|
26504
|
+
}
|
|
26505
|
+
|
|
26506
|
+
/**
|
|
26507
|
+
* Lists all ServingConfigs linked to this dataStore.
|
|
26508
|
+
* @example
|
|
26509
|
+
* ```js
|
|
26510
|
+
* // Before running the sample:
|
|
26511
|
+
* // - Enable the API at:
|
|
26512
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
26513
|
+
* // - Login into gcloud by running:
|
|
26514
|
+
* // ```sh
|
|
26515
|
+
* // $ gcloud auth application-default login
|
|
26516
|
+
* // ```
|
|
26517
|
+
* // - Install the npm module by running:
|
|
26518
|
+
* // ```sh
|
|
26519
|
+
* // $ npm install googleapis
|
|
26520
|
+
* // ```
|
|
26521
|
+
*
|
|
26522
|
+
* const {google} = require('googleapis');
|
|
26523
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
26524
|
+
*
|
|
26525
|
+
* async function main() {
|
|
26526
|
+
* const auth = new google.auth.GoogleAuth({
|
|
26527
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
26528
|
+
* scopes: [
|
|
26529
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
26530
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
26531
|
+
* ],
|
|
26532
|
+
* });
|
|
26533
|
+
*
|
|
26534
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
26535
|
+
* const authClient = await auth.getClient();
|
|
26536
|
+
* google.options({auth: authClient});
|
|
26537
|
+
*
|
|
26538
|
+
* // Do the magic
|
|
26539
|
+
* const res =
|
|
26540
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.list(
|
|
26541
|
+
* {
|
|
26542
|
+
* // Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
|
|
26543
|
+
* pageSize: 'placeholder-value',
|
|
26544
|
+
* // Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page.
|
|
26545
|
+
* pageToken: 'placeholder-value',
|
|
26546
|
+
* // Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
26547
|
+
* parent:
|
|
26548
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore',
|
|
26549
|
+
* },
|
|
26550
|
+
* );
|
|
26551
|
+
* console.log(res.data);
|
|
26552
|
+
*
|
|
26553
|
+
* // Example response
|
|
26554
|
+
* // {
|
|
26555
|
+
* // "nextPageToken": "my_nextPageToken",
|
|
26556
|
+
* // "servingConfigs": []
|
|
26557
|
+
* // }
|
|
26558
|
+
* }
|
|
26559
|
+
*
|
|
26560
|
+
* main().catch(e => {
|
|
26561
|
+
* console.error(e);
|
|
26562
|
+
* throw e;
|
|
26563
|
+
* });
|
|
26564
|
+
*
|
|
26565
|
+
* ```
|
|
26566
|
+
*
|
|
26567
|
+
* @param params - Parameters for request
|
|
26568
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
26569
|
+
* @param callback - Optional callback that handles the response.
|
|
26570
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
26571
|
+
*/
|
|
26572
|
+
list(
|
|
26573
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
26574
|
+
options: StreamMethodOptions
|
|
26575
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
26576
|
+
list(
|
|
26577
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
26578
|
+
options?: MethodOptions
|
|
26579
|
+
): Promise<
|
|
26580
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26581
|
+
>;
|
|
26582
|
+
list(
|
|
26583
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
26584
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
26585
|
+
callback: BodyResponseCallback<Readable>
|
|
26586
|
+
): void;
|
|
26587
|
+
list(
|
|
26588
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
26589
|
+
options:
|
|
26590
|
+
| MethodOptions
|
|
26591
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>,
|
|
26592
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26593
|
+
): void;
|
|
26594
|
+
list(
|
|
26595
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List,
|
|
26596
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26597
|
+
): void;
|
|
26598
|
+
list(
|
|
26599
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26600
|
+
): void;
|
|
26601
|
+
list(
|
|
26602
|
+
paramsOrCallback?:
|
|
26603
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List
|
|
26604
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26605
|
+
| BodyResponseCallback<Readable>,
|
|
26606
|
+
optionsOrCallback?:
|
|
26607
|
+
| MethodOptions
|
|
26608
|
+
| StreamMethodOptions
|
|
26609
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26610
|
+
| BodyResponseCallback<Readable>,
|
|
26611
|
+
callback?:
|
|
26612
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26613
|
+
| BodyResponseCallback<Readable>
|
|
26614
|
+
):
|
|
26615
|
+
| void
|
|
26616
|
+
| Promise<
|
|
26617
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>
|
|
26618
|
+
>
|
|
26619
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
26620
|
+
let params = (paramsOrCallback ||
|
|
26621
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
|
|
26622
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
26623
|
+
|
|
26624
|
+
if (typeof paramsOrCallback === 'function') {
|
|
26625
|
+
callback = paramsOrCallback;
|
|
26626
|
+
params =
|
|
26627
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List;
|
|
26628
|
+
options = {};
|
|
26629
|
+
}
|
|
26630
|
+
|
|
26631
|
+
if (typeof optionsOrCallback === 'function') {
|
|
26632
|
+
callback = optionsOrCallback;
|
|
26633
|
+
options = {};
|
|
26634
|
+
}
|
|
26635
|
+
|
|
26636
|
+
const rootUrl =
|
|
26637
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
26638
|
+
const parameters = {
|
|
26639
|
+
options: Object.assign(
|
|
26640
|
+
{
|
|
26641
|
+
url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace(
|
|
26642
|
+
/([^:]\/)\/+/g,
|
|
26643
|
+
'$1'
|
|
26644
|
+
),
|
|
26645
|
+
method: 'GET',
|
|
26646
|
+
apiVersion: '',
|
|
26647
|
+
},
|
|
26648
|
+
options
|
|
26649
|
+
),
|
|
26650
|
+
params,
|
|
26651
|
+
requiredParams: ['parent'],
|
|
26652
|
+
pathParams: ['parent'],
|
|
26653
|
+
context: this.context,
|
|
26654
|
+
};
|
|
26655
|
+
if (callback) {
|
|
26656
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>(
|
|
26657
|
+
parameters,
|
|
26658
|
+
callback as BodyResponseCallback<unknown>
|
|
26659
|
+
);
|
|
26660
|
+
} else {
|
|
26661
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse>(
|
|
26662
|
+
parameters
|
|
26663
|
+
);
|
|
26664
|
+
}
|
|
26665
|
+
}
|
|
26666
|
+
|
|
26667
|
+
/**
|
|
26668
|
+
* Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
26401
26669
|
* @example
|
|
26402
26670
|
* ```js
|
|
26403
26671
|
* // Before running the sample:
|
|
@@ -26843,6 +27111,7 @@ export namespace discoveryengine_v1beta {
|
|
|
26843
27111
|
* // "rankingExpression": "my_rankingExpression",
|
|
26844
27112
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
26845
27113
|
* // "regionCode": "my_regionCode",
|
|
27114
|
+
* // "relevanceFilterSpec": {},
|
|
26846
27115
|
* // "relevanceScoreSpec": {},
|
|
26847
27116
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
26848
27117
|
* // "safeSearch": false,
|
|
@@ -27062,6 +27331,7 @@ export namespace discoveryengine_v1beta {
|
|
|
27062
27331
|
* // "rankingExpression": "my_rankingExpression",
|
|
27063
27332
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
27064
27333
|
* // "regionCode": "my_regionCode",
|
|
27334
|
+
* // "relevanceFilterSpec": {},
|
|
27065
27335
|
* // "relevanceScoreSpec": {},
|
|
27066
27336
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
27067
27337
|
* // "safeSearch": false,
|
|
@@ -27399,6 +27669,21 @@ export namespace discoveryengine_v1beta {
|
|
|
27399
27669
|
*/
|
|
27400
27670
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
27401
27671
|
}
|
|
27672
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Create extends StandardParameters {
|
|
27673
|
+
/**
|
|
27674
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
27675
|
+
*/
|
|
27676
|
+
parent?: string;
|
|
27677
|
+
/**
|
|
27678
|
+
* 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+/.
|
|
27679
|
+
*/
|
|
27680
|
+
servingConfigId?: string;
|
|
27681
|
+
|
|
27682
|
+
/**
|
|
27683
|
+
* Request body metadata
|
|
27684
|
+
*/
|
|
27685
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
27686
|
+
}
|
|
27402
27687
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
27403
27688
|
/**
|
|
27404
27689
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -38421,6 +38706,214 @@ export namespace discoveryengine_v1beta {
|
|
|
38421
38706
|
}
|
|
38422
38707
|
}
|
|
38423
38708
|
|
|
38709
|
+
/**
|
|
38710
|
+
* 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.
|
|
38711
|
+
* @example
|
|
38712
|
+
* ```js
|
|
38713
|
+
* // Before running the sample:
|
|
38714
|
+
* // - Enable the API at:
|
|
38715
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
38716
|
+
* // - Login into gcloud by running:
|
|
38717
|
+
* // ```sh
|
|
38718
|
+
* // $ gcloud auth application-default login
|
|
38719
|
+
* // ```
|
|
38720
|
+
* // - Install the npm module by running:
|
|
38721
|
+
* // ```sh
|
|
38722
|
+
* // $ npm install googleapis
|
|
38723
|
+
* // ```
|
|
38724
|
+
*
|
|
38725
|
+
* const {google} = require('googleapis');
|
|
38726
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
38727
|
+
*
|
|
38728
|
+
* async function main() {
|
|
38729
|
+
* const auth = new google.auth.GoogleAuth({
|
|
38730
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
38731
|
+
* scopes: [
|
|
38732
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
38733
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
38734
|
+
* ],
|
|
38735
|
+
* });
|
|
38736
|
+
*
|
|
38737
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
38738
|
+
* const authClient = await auth.getClient();
|
|
38739
|
+
* google.options({auth: authClient});
|
|
38740
|
+
*
|
|
38741
|
+
* // Do the magic
|
|
38742
|
+
* const res =
|
|
38743
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.create(
|
|
38744
|
+
* {
|
|
38745
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
38746
|
+
* parent:
|
|
38747
|
+
* 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine',
|
|
38748
|
+
* // 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+/.
|
|
38749
|
+
* servingConfigId: 'placeholder-value',
|
|
38750
|
+
*
|
|
38751
|
+
* // Request body metadata
|
|
38752
|
+
* requestBody: {
|
|
38753
|
+
* // request body parameters
|
|
38754
|
+
* // {
|
|
38755
|
+
* // "answerGenerationSpec": {},
|
|
38756
|
+
* // "boostControlIds": [],
|
|
38757
|
+
* // "createTime": "my_createTime",
|
|
38758
|
+
* // "displayName": "my_displayName",
|
|
38759
|
+
* // "dissociateControlIds": [],
|
|
38760
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
38761
|
+
* // "embeddingConfig": {},
|
|
38762
|
+
* // "filterControlIds": [],
|
|
38763
|
+
* // "genericConfig": {},
|
|
38764
|
+
* // "ignoreControlIds": [],
|
|
38765
|
+
* // "mediaConfig": {},
|
|
38766
|
+
* // "modelId": "my_modelId",
|
|
38767
|
+
* // "name": "my_name",
|
|
38768
|
+
* // "onewaySynonymsControlIds": [],
|
|
38769
|
+
* // "personalizationSpec": {},
|
|
38770
|
+
* // "promoteControlIds": [],
|
|
38771
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
38772
|
+
* // "redirectControlIds": [],
|
|
38773
|
+
* // "replacementControlIds": [],
|
|
38774
|
+
* // "solutionType": "my_solutionType",
|
|
38775
|
+
* // "synonymsControlIds": [],
|
|
38776
|
+
* // "updateTime": "my_updateTime"
|
|
38777
|
+
* // }
|
|
38778
|
+
* },
|
|
38779
|
+
* },
|
|
38780
|
+
* );
|
|
38781
|
+
* console.log(res.data);
|
|
38782
|
+
*
|
|
38783
|
+
* // Example response
|
|
38784
|
+
* // {
|
|
38785
|
+
* // "answerGenerationSpec": {},
|
|
38786
|
+
* // "boostControlIds": [],
|
|
38787
|
+
* // "createTime": "my_createTime",
|
|
38788
|
+
* // "displayName": "my_displayName",
|
|
38789
|
+
* // "dissociateControlIds": [],
|
|
38790
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
38791
|
+
* // "embeddingConfig": {},
|
|
38792
|
+
* // "filterControlIds": [],
|
|
38793
|
+
* // "genericConfig": {},
|
|
38794
|
+
* // "ignoreControlIds": [],
|
|
38795
|
+
* // "mediaConfig": {},
|
|
38796
|
+
* // "modelId": "my_modelId",
|
|
38797
|
+
* // "name": "my_name",
|
|
38798
|
+
* // "onewaySynonymsControlIds": [],
|
|
38799
|
+
* // "personalizationSpec": {},
|
|
38800
|
+
* // "promoteControlIds": [],
|
|
38801
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
38802
|
+
* // "redirectControlIds": [],
|
|
38803
|
+
* // "replacementControlIds": [],
|
|
38804
|
+
* // "solutionType": "my_solutionType",
|
|
38805
|
+
* // "synonymsControlIds": [],
|
|
38806
|
+
* // "updateTime": "my_updateTime"
|
|
38807
|
+
* // }
|
|
38808
|
+
* }
|
|
38809
|
+
*
|
|
38810
|
+
* main().catch(e => {
|
|
38811
|
+
* console.error(e);
|
|
38812
|
+
* throw e;
|
|
38813
|
+
* });
|
|
38814
|
+
*
|
|
38815
|
+
* ```
|
|
38816
|
+
*
|
|
38817
|
+
* @param params - Parameters for request
|
|
38818
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
38819
|
+
* @param callback - Optional callback that handles the response.
|
|
38820
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
38821
|
+
*/
|
|
38822
|
+
create(
|
|
38823
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create,
|
|
38824
|
+
options: StreamMethodOptions
|
|
38825
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
38826
|
+
create(
|
|
38827
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create,
|
|
38828
|
+
options?: MethodOptions
|
|
38829
|
+
): Promise<
|
|
38830
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
38831
|
+
>;
|
|
38832
|
+
create(
|
|
38833
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create,
|
|
38834
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
38835
|
+
callback: BodyResponseCallback<Readable>
|
|
38836
|
+
): void;
|
|
38837
|
+
create(
|
|
38838
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create,
|
|
38839
|
+
options:
|
|
38840
|
+
| MethodOptions
|
|
38841
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
|
|
38842
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
38843
|
+
): void;
|
|
38844
|
+
create(
|
|
38845
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create,
|
|
38846
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
38847
|
+
): void;
|
|
38848
|
+
create(
|
|
38849
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
38850
|
+
): void;
|
|
38851
|
+
create(
|
|
38852
|
+
paramsOrCallback?:
|
|
38853
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create
|
|
38854
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
38855
|
+
| BodyResponseCallback<Readable>,
|
|
38856
|
+
optionsOrCallback?:
|
|
38857
|
+
| MethodOptions
|
|
38858
|
+
| StreamMethodOptions
|
|
38859
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
38860
|
+
| BodyResponseCallback<Readable>,
|
|
38861
|
+
callback?:
|
|
38862
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
38863
|
+
| BodyResponseCallback<Readable>
|
|
38864
|
+
):
|
|
38865
|
+
| void
|
|
38866
|
+
| Promise<
|
|
38867
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
38868
|
+
>
|
|
38869
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
38870
|
+
let params = (paramsOrCallback ||
|
|
38871
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create;
|
|
38872
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
38873
|
+
|
|
38874
|
+
if (typeof paramsOrCallback === 'function') {
|
|
38875
|
+
callback = paramsOrCallback;
|
|
38876
|
+
params =
|
|
38877
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create;
|
|
38878
|
+
options = {};
|
|
38879
|
+
}
|
|
38880
|
+
|
|
38881
|
+
if (typeof optionsOrCallback === 'function') {
|
|
38882
|
+
callback = optionsOrCallback;
|
|
38883
|
+
options = {};
|
|
38884
|
+
}
|
|
38885
|
+
|
|
38886
|
+
const rootUrl =
|
|
38887
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
38888
|
+
const parameters = {
|
|
38889
|
+
options: Object.assign(
|
|
38890
|
+
{
|
|
38891
|
+
url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace(
|
|
38892
|
+
/([^:]\/)\/+/g,
|
|
38893
|
+
'$1'
|
|
38894
|
+
),
|
|
38895
|
+
method: 'POST',
|
|
38896
|
+
apiVersion: '',
|
|
38897
|
+
},
|
|
38898
|
+
options
|
|
38899
|
+
),
|
|
38900
|
+
params,
|
|
38901
|
+
requiredParams: ['parent'],
|
|
38902
|
+
pathParams: ['parent'],
|
|
38903
|
+
context: this.context,
|
|
38904
|
+
};
|
|
38905
|
+
if (callback) {
|
|
38906
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
|
|
38907
|
+
parameters,
|
|
38908
|
+
callback as BodyResponseCallback<unknown>
|
|
38909
|
+
);
|
|
38910
|
+
} else {
|
|
38911
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
|
|
38912
|
+
parameters
|
|
38913
|
+
);
|
|
38914
|
+
}
|
|
38915
|
+
}
|
|
38916
|
+
|
|
38424
38917
|
/**
|
|
38425
38918
|
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
38426
38919
|
* @example
|
|
@@ -39342,6 +39835,7 @@ export namespace discoveryengine_v1beta {
|
|
|
39342
39835
|
* // "rankingExpression": "my_rankingExpression",
|
|
39343
39836
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
39344
39837
|
* // "regionCode": "my_regionCode",
|
|
39838
|
+
* // "relevanceFilterSpec": {},
|
|
39345
39839
|
* // "relevanceScoreSpec": {},
|
|
39346
39840
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
39347
39841
|
* // "safeSearch": false,
|
|
@@ -39561,6 +40055,7 @@ export namespace discoveryengine_v1beta {
|
|
|
39561
40055
|
* // "rankingExpression": "my_rankingExpression",
|
|
39562
40056
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
39563
40057
|
* // "regionCode": "my_regionCode",
|
|
40058
|
+
* // "relevanceFilterSpec": {},
|
|
39564
40059
|
* // "relevanceScoreSpec": {},
|
|
39565
40060
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
39566
40061
|
* // "safeSearch": false,
|
|
@@ -39898,6 +40393,21 @@ export namespace discoveryengine_v1beta {
|
|
|
39898
40393
|
*/
|
|
39899
40394
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
39900
40395
|
}
|
|
40396
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Create extends StandardParameters {
|
|
40397
|
+
/**
|
|
40398
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
40399
|
+
*/
|
|
40400
|
+
parent?: string;
|
|
40401
|
+
/**
|
|
40402
|
+
* 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+/.
|
|
40403
|
+
*/
|
|
40404
|
+
servingConfigId?: string;
|
|
40405
|
+
|
|
40406
|
+
/**
|
|
40407
|
+
* Request body metadata
|
|
40408
|
+
*/
|
|
40409
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
40410
|
+
}
|
|
39901
40411
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
|
|
39902
40412
|
/**
|
|
39903
40413
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -48580,33 +49090,263 @@ export namespace discoveryengine_v1beta {
|
|
|
48580
49090
|
* google.options({auth: authClient});
|
|
48581
49091
|
*
|
|
48582
49092
|
* // Do the magic
|
|
48583
|
-
* const res = await discoveryengine.projects.locations.dataStores.schemas.patch(
|
|
48584
|
-
* {
|
|
48585
|
-
* // If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
|
|
48586
|
-
* allowMissing: 'placeholder-value',
|
|
48587
|
-
* // Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
48588
|
-
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema',
|
|
49093
|
+
* const res = await discoveryengine.projects.locations.dataStores.schemas.patch(
|
|
49094
|
+
* {
|
|
49095
|
+
* // If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
|
|
49096
|
+
* allowMissing: 'placeholder-value',
|
|
49097
|
+
* // Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
49098
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/schemas/my-schema',
|
|
49099
|
+
*
|
|
49100
|
+
* // Request body metadata
|
|
49101
|
+
* requestBody: {
|
|
49102
|
+
* // request body parameters
|
|
49103
|
+
* // {
|
|
49104
|
+
* // "jsonSchema": "my_jsonSchema",
|
|
49105
|
+
* // "name": "my_name",
|
|
49106
|
+
* // "structSchema": {}
|
|
49107
|
+
* // }
|
|
49108
|
+
* },
|
|
49109
|
+
* },
|
|
49110
|
+
* );
|
|
49111
|
+
* console.log(res.data);
|
|
49112
|
+
*
|
|
49113
|
+
* // Example response
|
|
49114
|
+
* // {
|
|
49115
|
+
* // "done": false,
|
|
49116
|
+
* // "error": {},
|
|
49117
|
+
* // "metadata": {},
|
|
49118
|
+
* // "name": "my_name",
|
|
49119
|
+
* // "response": {}
|
|
49120
|
+
* // }
|
|
49121
|
+
* }
|
|
49122
|
+
*
|
|
49123
|
+
* main().catch(e => {
|
|
49124
|
+
* console.error(e);
|
|
49125
|
+
* throw e;
|
|
49126
|
+
* });
|
|
49127
|
+
*
|
|
49128
|
+
* ```
|
|
49129
|
+
*
|
|
49130
|
+
* @param params - Parameters for request
|
|
49131
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
49132
|
+
* @param callback - Optional callback that handles the response.
|
|
49133
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
49134
|
+
*/
|
|
49135
|
+
patch(
|
|
49136
|
+
params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch,
|
|
49137
|
+
options: StreamMethodOptions
|
|
49138
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
49139
|
+
patch(
|
|
49140
|
+
params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch,
|
|
49141
|
+
options?: MethodOptions
|
|
49142
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
49143
|
+
patch(
|
|
49144
|
+
params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch,
|
|
49145
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
49146
|
+
callback: BodyResponseCallback<Readable>
|
|
49147
|
+
): void;
|
|
49148
|
+
patch(
|
|
49149
|
+
params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch,
|
|
49150
|
+
options:
|
|
49151
|
+
| MethodOptions
|
|
49152
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>,
|
|
49153
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
49154
|
+
): void;
|
|
49155
|
+
patch(
|
|
49156
|
+
params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch,
|
|
49157
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
49158
|
+
): void;
|
|
49159
|
+
patch(
|
|
49160
|
+
callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
49161
|
+
): void;
|
|
49162
|
+
patch(
|
|
49163
|
+
paramsOrCallback?:
|
|
49164
|
+
| Params$Resource$Projects$Locations$Datastores$Schemas$Patch
|
|
49165
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
49166
|
+
| BodyResponseCallback<Readable>,
|
|
49167
|
+
optionsOrCallback?:
|
|
49168
|
+
| MethodOptions
|
|
49169
|
+
| StreamMethodOptions
|
|
49170
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
49171
|
+
| BodyResponseCallback<Readable>,
|
|
49172
|
+
callback?:
|
|
49173
|
+
| BodyResponseCallback<Schema$GoogleLongrunningOperation>
|
|
49174
|
+
| BodyResponseCallback<Readable>
|
|
49175
|
+
):
|
|
49176
|
+
| void
|
|
49177
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
|
|
49178
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
49179
|
+
let params = (paramsOrCallback ||
|
|
49180
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch;
|
|
49181
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
49182
|
+
|
|
49183
|
+
if (typeof paramsOrCallback === 'function') {
|
|
49184
|
+
callback = paramsOrCallback;
|
|
49185
|
+
params =
|
|
49186
|
+
{} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch;
|
|
49187
|
+
options = {};
|
|
49188
|
+
}
|
|
49189
|
+
|
|
49190
|
+
if (typeof optionsOrCallback === 'function') {
|
|
49191
|
+
callback = optionsOrCallback;
|
|
49192
|
+
options = {};
|
|
49193
|
+
}
|
|
49194
|
+
|
|
49195
|
+
const rootUrl =
|
|
49196
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
49197
|
+
const parameters = {
|
|
49198
|
+
options: Object.assign(
|
|
49199
|
+
{
|
|
49200
|
+
url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
49201
|
+
method: 'PATCH',
|
|
49202
|
+
apiVersion: '',
|
|
49203
|
+
},
|
|
49204
|
+
options
|
|
49205
|
+
),
|
|
49206
|
+
params,
|
|
49207
|
+
requiredParams: ['name'],
|
|
49208
|
+
pathParams: ['name'],
|
|
49209
|
+
context: this.context,
|
|
49210
|
+
};
|
|
49211
|
+
if (callback) {
|
|
49212
|
+
createAPIRequest<Schema$GoogleLongrunningOperation>(
|
|
49213
|
+
parameters,
|
|
49214
|
+
callback as BodyResponseCallback<unknown>
|
|
49215
|
+
);
|
|
49216
|
+
} else {
|
|
49217
|
+
return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
|
|
49218
|
+
}
|
|
49219
|
+
}
|
|
49220
|
+
}
|
|
49221
|
+
|
|
49222
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create extends StandardParameters {
|
|
49223
|
+
/**
|
|
49224
|
+
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
49225
|
+
*/
|
|
49226
|
+
parent?: string;
|
|
49227
|
+
/**
|
|
49228
|
+
* Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
|
|
49229
|
+
*/
|
|
49230
|
+
schemaId?: string;
|
|
49231
|
+
|
|
49232
|
+
/**
|
|
49233
|
+
* Request body metadata
|
|
49234
|
+
*/
|
|
49235
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
49236
|
+
}
|
|
49237
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete extends StandardParameters {
|
|
49238
|
+
/**
|
|
49239
|
+
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
49240
|
+
*/
|
|
49241
|
+
name?: string;
|
|
49242
|
+
}
|
|
49243
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get extends StandardParameters {
|
|
49244
|
+
/**
|
|
49245
|
+
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
49246
|
+
*/
|
|
49247
|
+
name?: string;
|
|
49248
|
+
}
|
|
49249
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$List extends StandardParameters {
|
|
49250
|
+
/**
|
|
49251
|
+
* The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.
|
|
49252
|
+
*/
|
|
49253
|
+
pageSize?: number;
|
|
49254
|
+
/**
|
|
49255
|
+
* A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.
|
|
49256
|
+
*/
|
|
49257
|
+
pageToken?: string;
|
|
49258
|
+
/**
|
|
49259
|
+
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
49260
|
+
*/
|
|
49261
|
+
parent?: string;
|
|
49262
|
+
}
|
|
49263
|
+
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch extends StandardParameters {
|
|
49264
|
+
/**
|
|
49265
|
+
* If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
|
|
49266
|
+
*/
|
|
49267
|
+
allowMissing?: boolean;
|
|
49268
|
+
/**
|
|
49269
|
+
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
49270
|
+
*/
|
|
49271
|
+
name?: string;
|
|
49272
|
+
|
|
49273
|
+
/**
|
|
49274
|
+
* Request body metadata
|
|
49275
|
+
*/
|
|
49276
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
49277
|
+
}
|
|
49278
|
+
|
|
49279
|
+
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
49280
|
+
context: APIRequestContext;
|
|
49281
|
+
constructor(context: APIRequestContext) {
|
|
49282
|
+
this.context = context;
|
|
49283
|
+
}
|
|
49284
|
+
|
|
49285
|
+
/**
|
|
49286
|
+
* Answer query method.
|
|
49287
|
+
* @example
|
|
49288
|
+
* ```js
|
|
49289
|
+
* // Before running the sample:
|
|
49290
|
+
* // - Enable the API at:
|
|
49291
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
49292
|
+
* // - Login into gcloud by running:
|
|
49293
|
+
* // ```sh
|
|
49294
|
+
* // $ gcloud auth application-default login
|
|
49295
|
+
* // ```
|
|
49296
|
+
* // - Install the npm module by running:
|
|
49297
|
+
* // ```sh
|
|
49298
|
+
* // $ npm install googleapis
|
|
49299
|
+
* // ```
|
|
49300
|
+
*
|
|
49301
|
+
* const {google} = require('googleapis');
|
|
49302
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
49303
|
+
*
|
|
49304
|
+
* async function main() {
|
|
49305
|
+
* const auth = new google.auth.GoogleAuth({
|
|
49306
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
49307
|
+
* scopes: [
|
|
49308
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
49309
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
49310
|
+
* ],
|
|
49311
|
+
* });
|
|
49312
|
+
*
|
|
49313
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
49314
|
+
* const authClient = await auth.getClient();
|
|
49315
|
+
* google.options({auth: authClient});
|
|
49316
|
+
*
|
|
49317
|
+
* // Do the magic
|
|
49318
|
+
* const res =
|
|
49319
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.answer({
|
|
49320
|
+
* // Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
|
|
49321
|
+
* servingConfig:
|
|
49322
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
48589
49323
|
*
|
|
48590
49324
|
* // Request body metadata
|
|
48591
49325
|
* requestBody: {
|
|
48592
49326
|
* // request body parameters
|
|
48593
49327
|
* // {
|
|
48594
|
-
* // "
|
|
48595
|
-
* // "
|
|
48596
|
-
* // "
|
|
49328
|
+
* // "answerGenerationSpec": {},
|
|
49329
|
+
* // "asynchronousMode": false,
|
|
49330
|
+
* // "endUserSpec": {},
|
|
49331
|
+
* // "groundingSpec": {},
|
|
49332
|
+
* // "query": {},
|
|
49333
|
+
* // "queryUnderstandingSpec": {},
|
|
49334
|
+
* // "relatedQuestionsSpec": {},
|
|
49335
|
+
* // "safetySpec": {},
|
|
49336
|
+
* // "searchSpec": {},
|
|
49337
|
+
* // "session": "my_session",
|
|
49338
|
+
* // "userLabels": {},
|
|
49339
|
+
* // "userPseudoId": "my_userPseudoId"
|
|
48597
49340
|
* // }
|
|
48598
49341
|
* },
|
|
48599
|
-
* }
|
|
48600
|
-
* );
|
|
49342
|
+
* });
|
|
48601
49343
|
* console.log(res.data);
|
|
48602
49344
|
*
|
|
48603
49345
|
* // Example response
|
|
48604
49346
|
* // {
|
|
48605
|
-
* // "
|
|
48606
|
-
* // "
|
|
48607
|
-
* // "
|
|
48608
|
-
* // "name": "my_name",
|
|
48609
|
-
* // "response": {}
|
|
49347
|
+
* // "answer": {},
|
|
49348
|
+
* // "answerQueryToken": "my_answerQueryToken",
|
|
49349
|
+
* // "session": {}
|
|
48610
49350
|
* // }
|
|
48611
49351
|
* }
|
|
48612
49352
|
*
|
|
@@ -48622,58 +49362,62 @@ export namespace discoveryengine_v1beta {
|
|
|
48622
49362
|
* @param callback - Optional callback that handles the response.
|
|
48623
49363
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
48624
49364
|
*/
|
|
48625
|
-
|
|
48626
|
-
params: Params$Resource$Projects$Locations$Datastores$
|
|
49365
|
+
answer(
|
|
49366
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer,
|
|
48627
49367
|
options: StreamMethodOptions
|
|
48628
49368
|
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
48629
|
-
|
|
48630
|
-
params?: Params$Resource$Projects$Locations$Datastores$
|
|
49369
|
+
answer(
|
|
49370
|
+
params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer,
|
|
48631
49371
|
options?: MethodOptions
|
|
48632
|
-
): Promise<
|
|
48633
|
-
|
|
48634
|
-
|
|
49372
|
+
): Promise<
|
|
49373
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>
|
|
49374
|
+
>;
|
|
49375
|
+
answer(
|
|
49376
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer,
|
|
48635
49377
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
48636
49378
|
callback: BodyResponseCallback<Readable>
|
|
48637
49379
|
): void;
|
|
48638
|
-
|
|
48639
|
-
params: Params$Resource$Projects$Locations$Datastores$
|
|
49380
|
+
answer(
|
|
49381
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer,
|
|
48640
49382
|
options:
|
|
48641
49383
|
| MethodOptions
|
|
48642
|
-
| BodyResponseCallback<Schema$
|
|
48643
|
-
callback: BodyResponseCallback<Schema$
|
|
49384
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>,
|
|
49385
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>
|
|
48644
49386
|
): void;
|
|
48645
|
-
|
|
48646
|
-
params: Params$Resource$Projects$Locations$Datastores$
|
|
48647
|
-
callback: BodyResponseCallback<Schema$
|
|
49387
|
+
answer(
|
|
49388
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer,
|
|
49389
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>
|
|
48648
49390
|
): void;
|
|
48649
|
-
|
|
48650
|
-
callback: BodyResponseCallback<Schema$
|
|
49391
|
+
answer(
|
|
49392
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>
|
|
48651
49393
|
): void;
|
|
48652
|
-
|
|
49394
|
+
answer(
|
|
48653
49395
|
paramsOrCallback?:
|
|
48654
|
-
| Params$Resource$Projects$Locations$Datastores$
|
|
48655
|
-
| BodyResponseCallback<Schema$
|
|
49396
|
+
| Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer
|
|
49397
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>
|
|
48656
49398
|
| BodyResponseCallback<Readable>,
|
|
48657
49399
|
optionsOrCallback?:
|
|
48658
49400
|
| MethodOptions
|
|
48659
49401
|
| StreamMethodOptions
|
|
48660
|
-
| BodyResponseCallback<Schema$
|
|
49402
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>
|
|
48661
49403
|
| BodyResponseCallback<Readable>,
|
|
48662
49404
|
callback?:
|
|
48663
|
-
| BodyResponseCallback<Schema$
|
|
49405
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>
|
|
48664
49406
|
| BodyResponseCallback<Readable>
|
|
48665
49407
|
):
|
|
48666
49408
|
| void
|
|
48667
|
-
| Promise<
|
|
49409
|
+
| Promise<
|
|
49410
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>
|
|
49411
|
+
>
|
|
48668
49412
|
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
48669
49413
|
let params = (paramsOrCallback ||
|
|
48670
|
-
{}) as Params$Resource$Projects$Locations$Datastores$
|
|
49414
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer;
|
|
48671
49415
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
48672
49416
|
|
|
48673
49417
|
if (typeof paramsOrCallback === 'function') {
|
|
48674
49418
|
callback = paramsOrCallback;
|
|
48675
49419
|
params =
|
|
48676
|
-
{} as Params$Resource$Projects$Locations$Datastores$
|
|
49420
|
+
{} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer;
|
|
48677
49421
|
options = {};
|
|
48678
49422
|
}
|
|
48679
49423
|
|
|
@@ -48687,93 +49431,34 @@ export namespace discoveryengine_v1beta {
|
|
|
48687
49431
|
const parameters = {
|
|
48688
49432
|
options: Object.assign(
|
|
48689
49433
|
{
|
|
48690
|
-
url: (rootUrl + '/v1beta/{+
|
|
48691
|
-
|
|
49434
|
+
url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace(
|
|
49435
|
+
/([^:]\/)\/+/g,
|
|
49436
|
+
'$1'
|
|
49437
|
+
),
|
|
49438
|
+
method: 'POST',
|
|
48692
49439
|
apiVersion: '',
|
|
48693
49440
|
},
|
|
48694
49441
|
options
|
|
48695
49442
|
),
|
|
48696
49443
|
params,
|
|
48697
|
-
requiredParams: ['
|
|
48698
|
-
pathParams: ['
|
|
49444
|
+
requiredParams: ['servingConfig'],
|
|
49445
|
+
pathParams: ['servingConfig'],
|
|
48699
49446
|
context: this.context,
|
|
48700
49447
|
};
|
|
48701
49448
|
if (callback) {
|
|
48702
|
-
createAPIRequest<Schema$
|
|
49449
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>(
|
|
48703
49450
|
parameters,
|
|
48704
49451
|
callback as BodyResponseCallback<unknown>
|
|
48705
49452
|
);
|
|
48706
49453
|
} else {
|
|
48707
|
-
return createAPIRequest<Schema$
|
|
49454
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse>(
|
|
49455
|
+
parameters
|
|
49456
|
+
);
|
|
48708
49457
|
}
|
|
48709
49458
|
}
|
|
48710
|
-
}
|
|
48711
|
-
|
|
48712
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create extends StandardParameters {
|
|
48713
|
-
/**
|
|
48714
|
-
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
48715
|
-
*/
|
|
48716
|
-
parent?: string;
|
|
48717
|
-
/**
|
|
48718
|
-
* Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
|
|
48719
|
-
*/
|
|
48720
|
-
schemaId?: string;
|
|
48721
49459
|
|
|
48722
49460
|
/**
|
|
48723
|
-
*
|
|
48724
|
-
*/
|
|
48725
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
48726
|
-
}
|
|
48727
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete extends StandardParameters {
|
|
48728
|
-
/**
|
|
48729
|
-
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
48730
|
-
*/
|
|
48731
|
-
name?: string;
|
|
48732
|
-
}
|
|
48733
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get extends StandardParameters {
|
|
48734
|
-
/**
|
|
48735
|
-
* Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`.
|
|
48736
|
-
*/
|
|
48737
|
-
name?: string;
|
|
48738
|
-
}
|
|
48739
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$List extends StandardParameters {
|
|
48740
|
-
/**
|
|
48741
|
-
* The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.
|
|
48742
|
-
*/
|
|
48743
|
-
pageSize?: number;
|
|
48744
|
-
/**
|
|
48745
|
-
* A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.
|
|
48746
|
-
*/
|
|
48747
|
-
pageToken?: string;
|
|
48748
|
-
/**
|
|
48749
|
-
* Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`.
|
|
48750
|
-
*/
|
|
48751
|
-
parent?: string;
|
|
48752
|
-
}
|
|
48753
|
-
export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch extends StandardParameters {
|
|
48754
|
-
/**
|
|
48755
|
-
* If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored.
|
|
48756
|
-
*/
|
|
48757
|
-
allowMissing?: boolean;
|
|
48758
|
-
/**
|
|
48759
|
-
* Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
48760
|
-
*/
|
|
48761
|
-
name?: string;
|
|
48762
|
-
|
|
48763
|
-
/**
|
|
48764
|
-
* Request body metadata
|
|
48765
|
-
*/
|
|
48766
|
-
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema;
|
|
48767
|
-
}
|
|
48768
|
-
|
|
48769
|
-
export class Resource$Projects$Locations$Datastores$Servingconfigs {
|
|
48770
|
-
context: APIRequestContext;
|
|
48771
|
-
constructor(context: APIRequestContext) {
|
|
48772
|
-
this.context = context;
|
|
48773
|
-
}
|
|
48774
|
-
|
|
48775
|
-
/**
|
|
48776
|
-
* Answer query method.
|
|
49461
|
+
* 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.
|
|
48777
49462
|
* @example
|
|
48778
49463
|
* ```js
|
|
48779
49464
|
* // Before running the sample:
|
|
@@ -48806,27 +49491,39 @@ export namespace discoveryengine_v1beta {
|
|
|
48806
49491
|
*
|
|
48807
49492
|
* // Do the magic
|
|
48808
49493
|
* const res =
|
|
48809
|
-
* await discoveryengine.projects.locations.dataStores.servingConfigs.
|
|
48810
|
-
* // Required.
|
|
48811
|
-
*
|
|
48812
|
-
* 'projects/my-project/locations/my-location/dataStores/my-dataStore
|
|
49494
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.create({
|
|
49495
|
+
* // Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
49496
|
+
* parent:
|
|
49497
|
+
* 'projects/my-project/locations/my-location/dataStores/my-dataStore',
|
|
49498
|
+
* // 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+/.
|
|
49499
|
+
* servingConfigId: 'placeholder-value',
|
|
48813
49500
|
*
|
|
48814
49501
|
* // Request body metadata
|
|
48815
49502
|
* requestBody: {
|
|
48816
49503
|
* // request body parameters
|
|
48817
49504
|
* // {
|
|
48818
49505
|
* // "answerGenerationSpec": {},
|
|
48819
|
-
* // "
|
|
48820
|
-
* // "
|
|
48821
|
-
* // "
|
|
48822
|
-
* // "
|
|
48823
|
-
* // "
|
|
48824
|
-
* // "
|
|
48825
|
-
* // "
|
|
48826
|
-
* // "
|
|
48827
|
-
* // "
|
|
48828
|
-
* // "
|
|
48829
|
-
* // "
|
|
49506
|
+
* // "boostControlIds": [],
|
|
49507
|
+
* // "createTime": "my_createTime",
|
|
49508
|
+
* // "displayName": "my_displayName",
|
|
49509
|
+
* // "dissociateControlIds": [],
|
|
49510
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
49511
|
+
* // "embeddingConfig": {},
|
|
49512
|
+
* // "filterControlIds": [],
|
|
49513
|
+
* // "genericConfig": {},
|
|
49514
|
+
* // "ignoreControlIds": [],
|
|
49515
|
+
* // "mediaConfig": {},
|
|
49516
|
+
* // "modelId": "my_modelId",
|
|
49517
|
+
* // "name": "my_name",
|
|
49518
|
+
* // "onewaySynonymsControlIds": [],
|
|
49519
|
+
* // "personalizationSpec": {},
|
|
49520
|
+
* // "promoteControlIds": [],
|
|
49521
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
49522
|
+
* // "redirectControlIds": [],
|
|
49523
|
+
* // "replacementControlIds": [],
|
|
49524
|
+
* // "solutionType": "my_solutionType",
|
|
49525
|
+
* // "synonymsControlIds": [],
|
|
49526
|
+
* // "updateTime": "my_updateTime"
|
|
48830
49527
|
* // }
|
|
48831
49528
|
* },
|
|
48832
49529
|
* });
|
|
@@ -48834,9 +49531,28 @@ export namespace discoveryengine_v1beta {
|
|
|
48834
49531
|
*
|
|
48835
49532
|
* // Example response
|
|
48836
49533
|
* // {
|
|
48837
|
-
* // "
|
|
48838
|
-
* // "
|
|
48839
|
-
* // "
|
|
49534
|
+
* // "answerGenerationSpec": {},
|
|
49535
|
+
* // "boostControlIds": [],
|
|
49536
|
+
* // "createTime": "my_createTime",
|
|
49537
|
+
* // "displayName": "my_displayName",
|
|
49538
|
+
* // "dissociateControlIds": [],
|
|
49539
|
+
* // "diversityLevel": "my_diversityLevel",
|
|
49540
|
+
* // "embeddingConfig": {},
|
|
49541
|
+
* // "filterControlIds": [],
|
|
49542
|
+
* // "genericConfig": {},
|
|
49543
|
+
* // "ignoreControlIds": [],
|
|
49544
|
+
* // "mediaConfig": {},
|
|
49545
|
+
* // "modelId": "my_modelId",
|
|
49546
|
+
* // "name": "my_name",
|
|
49547
|
+
* // "onewaySynonymsControlIds": [],
|
|
49548
|
+
* // "personalizationSpec": {},
|
|
49549
|
+
* // "promoteControlIds": [],
|
|
49550
|
+
* // "rankingExpression": "my_rankingExpression",
|
|
49551
|
+
* // "redirectControlIds": [],
|
|
49552
|
+
* // "replacementControlIds": [],
|
|
49553
|
+
* // "solutionType": "my_solutionType",
|
|
49554
|
+
* // "synonymsControlIds": [],
|
|
49555
|
+
* // "updateTime": "my_updateTime"
|
|
48840
49556
|
* // }
|
|
48841
49557
|
* }
|
|
48842
49558
|
*
|
|
@@ -48852,62 +49568,62 @@ export namespace discoveryengine_v1beta {
|
|
|
48852
49568
|
* @param callback - Optional callback that handles the response.
|
|
48853
49569
|
* @returns A promise if used with async/await, or void if used with a callback.
|
|
48854
49570
|
*/
|
|
48855
|
-
|
|
48856
|
-
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$
|
|
49571
|
+
create(
|
|
49572
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create,
|
|
48857
49573
|
options: StreamMethodOptions
|
|
48858
49574
|
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
48859
|
-
|
|
48860
|
-
params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$
|
|
49575
|
+
create(
|
|
49576
|
+
params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create,
|
|
48861
49577
|
options?: MethodOptions
|
|
48862
49578
|
): Promise<
|
|
48863
|
-
GaxiosResponseWithHTTP2<Schema$
|
|
49579
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
48864
49580
|
>;
|
|
48865
|
-
|
|
48866
|
-
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$
|
|
49581
|
+
create(
|
|
49582
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create,
|
|
48867
49583
|
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
48868
49584
|
callback: BodyResponseCallback<Readable>
|
|
48869
49585
|
): void;
|
|
48870
|
-
|
|
48871
|
-
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$
|
|
49586
|
+
create(
|
|
49587
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create,
|
|
48872
49588
|
options:
|
|
48873
49589
|
| MethodOptions
|
|
48874
|
-
| BodyResponseCallback<Schema$
|
|
48875
|
-
callback: BodyResponseCallback<Schema$
|
|
49590
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>,
|
|
49591
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
48876
49592
|
): void;
|
|
48877
|
-
|
|
48878
|
-
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$
|
|
48879
|
-
callback: BodyResponseCallback<Schema$
|
|
49593
|
+
create(
|
|
49594
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create,
|
|
49595
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
48880
49596
|
): void;
|
|
48881
|
-
|
|
48882
|
-
callback: BodyResponseCallback<Schema$
|
|
49597
|
+
create(
|
|
49598
|
+
callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
48883
49599
|
): void;
|
|
48884
|
-
|
|
49600
|
+
create(
|
|
48885
49601
|
paramsOrCallback?:
|
|
48886
|
-
| Params$Resource$Projects$Locations$Datastores$Servingconfigs$
|
|
48887
|
-
| BodyResponseCallback<Schema$
|
|
49602
|
+
| Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create
|
|
49603
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
48888
49604
|
| BodyResponseCallback<Readable>,
|
|
48889
49605
|
optionsOrCallback?:
|
|
48890
49606
|
| MethodOptions
|
|
48891
49607
|
| StreamMethodOptions
|
|
48892
|
-
| BodyResponseCallback<Schema$
|
|
49608
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
48893
49609
|
| BodyResponseCallback<Readable>,
|
|
48894
49610
|
callback?:
|
|
48895
|
-
| BodyResponseCallback<Schema$
|
|
49611
|
+
| BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
48896
49612
|
| BodyResponseCallback<Readable>
|
|
48897
49613
|
):
|
|
48898
49614
|
| void
|
|
48899
49615
|
| Promise<
|
|
48900
|
-
GaxiosResponseWithHTTP2<Schema$
|
|
49616
|
+
GaxiosResponseWithHTTP2<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>
|
|
48901
49617
|
>
|
|
48902
49618
|
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
48903
49619
|
let params = (paramsOrCallback ||
|
|
48904
|
-
{}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$
|
|
49620
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create;
|
|
48905
49621
|
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
48906
49622
|
|
|
48907
49623
|
if (typeof paramsOrCallback === 'function') {
|
|
48908
49624
|
callback = paramsOrCallback;
|
|
48909
49625
|
params =
|
|
48910
|
-
{} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$
|
|
49626
|
+
{} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create;
|
|
48911
49627
|
options = {};
|
|
48912
49628
|
}
|
|
48913
49629
|
|
|
@@ -48921,7 +49637,7 @@ export namespace discoveryengine_v1beta {
|
|
|
48921
49637
|
const parameters = {
|
|
48922
49638
|
options: Object.assign(
|
|
48923
49639
|
{
|
|
48924
|
-
url: (rootUrl + '/v1beta/{+
|
|
49640
|
+
url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace(
|
|
48925
49641
|
/([^:]\/)\/+/g,
|
|
48926
49642
|
'$1'
|
|
48927
49643
|
),
|
|
@@ -48931,17 +49647,17 @@ export namespace discoveryengine_v1beta {
|
|
|
48931
49647
|
options
|
|
48932
49648
|
),
|
|
48933
49649
|
params,
|
|
48934
|
-
requiredParams: ['
|
|
48935
|
-
pathParams: ['
|
|
49650
|
+
requiredParams: ['parent'],
|
|
49651
|
+
pathParams: ['parent'],
|
|
48936
49652
|
context: this.context,
|
|
48937
49653
|
};
|
|
48938
49654
|
if (callback) {
|
|
48939
|
-
createAPIRequest<Schema$
|
|
49655
|
+
createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
|
|
48940
49656
|
parameters,
|
|
48941
49657
|
callback as BodyResponseCallback<unknown>
|
|
48942
49658
|
);
|
|
48943
49659
|
} else {
|
|
48944
|
-
return createAPIRequest<Schema$
|
|
49660
|
+
return createAPIRequest<Schema$GoogleCloudDiscoveryengineV1betaServingConfig>(
|
|
48945
49661
|
parameters
|
|
48946
49662
|
);
|
|
48947
49663
|
}
|
|
@@ -49859,6 +50575,7 @@ export namespace discoveryengine_v1beta {
|
|
|
49859
50575
|
* // "rankingExpression": "my_rankingExpression",
|
|
49860
50576
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
49861
50577
|
* // "regionCode": "my_regionCode",
|
|
50578
|
+
* // "relevanceFilterSpec": {},
|
|
49862
50579
|
* // "relevanceScoreSpec": {},
|
|
49863
50580
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
49864
50581
|
* // "safeSearch": false,
|
|
@@ -50077,6 +50794,7 @@ export namespace discoveryengine_v1beta {
|
|
|
50077
50794
|
* // "rankingExpression": "my_rankingExpression",
|
|
50078
50795
|
* // "rankingExpressionBackend": "my_rankingExpressionBackend",
|
|
50079
50796
|
* // "regionCode": "my_regionCode",
|
|
50797
|
+
* // "relevanceFilterSpec": {},
|
|
50080
50798
|
* // "relevanceScoreSpec": {},
|
|
50081
50799
|
* // "relevanceThreshold": "my_relevanceThreshold",
|
|
50082
50800
|
* // "safeSearch": false,
|
|
@@ -50414,6 +51132,21 @@ export namespace discoveryengine_v1beta {
|
|
|
50414
51132
|
*/
|
|
50415
51133
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest;
|
|
50416
51134
|
}
|
|
51135
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Create extends StandardParameters {
|
|
51136
|
+
/**
|
|
51137
|
+
* Required. Full resource name of parent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}`
|
|
51138
|
+
*/
|
|
51139
|
+
parent?: string;
|
|
51140
|
+
/**
|
|
51141
|
+
* 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+/.
|
|
51142
|
+
*/
|
|
51143
|
+
servingConfigId?: string;
|
|
51144
|
+
|
|
51145
|
+
/**
|
|
51146
|
+
* Request body metadata
|
|
51147
|
+
*/
|
|
51148
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig;
|
|
51149
|
+
}
|
|
50417
51150
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
50418
51151
|
/**
|
|
50419
51152
|
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|