@googleapis/discoveryengine 28.0.0 → 28.1.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 +7 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +233 -4
- package/build/v1.js +99 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +241 -3
- package/build/v1alpha.js +99 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +224 -3
- package/build/v1beta.js +99 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +461 -4
- package/v1alpha.ts +468 -3
- package/v1beta.ts +452 -3
package/v1alpha.ts
CHANGED
|
@@ -865,6 +865,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
865
865
|
* Optional. The code of the language of the text in the description, display_name and starter_prompts fields.
|
|
866
866
|
*/
|
|
867
867
|
languageCode?: string | null;
|
|
868
|
+
/**
|
|
869
|
+
* Optional. The behavior of the Google managed agent.
|
|
870
|
+
*/
|
|
871
|
+
managedAgentDefinition?: Schema$GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition;
|
|
868
872
|
/**
|
|
869
873
|
* Identifier. Resource name of the agent. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/assistants/{assistant\}/agents/{agent\}`
|
|
870
874
|
*/
|
|
@@ -6824,6 +6828,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
6824
6828
|
*/
|
|
6825
6829
|
userLicenses?: Schema$GoogleCloudDiscoveryengineV1alphaUserLicense[];
|
|
6826
6830
|
}
|
|
6831
|
+
/**
|
|
6832
|
+
* Stores the definition of a Google managed agent.
|
|
6833
|
+
*/
|
|
6834
|
+
export interface Schema$GoogleCloudDiscoveryengineV1alphaManagedAgentDefinition {}
|
|
6827
6835
|
/**
|
|
6828
6836
|
* Media-specific user event information.
|
|
6829
6837
|
*/
|
|
@@ -8169,7 +8177,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
8169
8177
|
*/
|
|
8170
8178
|
orderBy?: string | null;
|
|
8171
8179
|
/**
|
|
8172
|
-
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
8180
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
8173
8181
|
*/
|
|
8174
8182
|
pageCategories?: string[] | null;
|
|
8175
8183
|
/**
|
|
@@ -10134,7 +10142,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
10134
10142
|
*/
|
|
10135
10143
|
eventType?: string | null;
|
|
10136
10144
|
/**
|
|
10137
|
-
* The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
10145
|
+
* Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
|
|
10138
10146
|
*/
|
|
10139
10147
|
filter?: string | null;
|
|
10140
10148
|
/**
|
|
@@ -12878,7 +12886,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
12878
12886
|
*/
|
|
12879
12887
|
orderBy?: string | null;
|
|
12880
12888
|
/**
|
|
12881
|
-
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
12889
|
+
* Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. If the field contains more than one element, only the first element will be used. To represent full path of a category, use '\>' character to separate different hierarchies. If '\>' is part of the category name, replace it with other character(s). For example, `Graphics Cards \> RTX\>4090 \> Founders Edition` where "RTX \> 4090" represents one level, can be rewritten as `Graphics Cards \> RTX_4090 \> Founders Edition`
|
|
12882
12890
|
*/
|
|
12883
12891
|
pageCategories?: string[] | null;
|
|
12884
12892
|
/**
|
|
@@ -14363,6 +14371,10 @@ export namespace discoveryengine_v1alpha {
|
|
|
14363
14371
|
* Immutable. Identifier. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
|
|
14364
14372
|
*/
|
|
14365
14373
|
name?: string | null;
|
|
14374
|
+
/**
|
|
14375
|
+
* Optional. Configuration for Natural Language Query Understanding.
|
|
14376
|
+
*/
|
|
14377
|
+
naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig;
|
|
14366
14378
|
/**
|
|
14367
14379
|
* Optional. Stores serving config at DataStore level.
|
|
14368
14380
|
*/
|
|
@@ -15199,6 +15211,15 @@ export namespace discoveryengine_v1alpha {
|
|
|
15199
15211
|
*/
|
|
15200
15212
|
subscriptionTier?: string | null;
|
|
15201
15213
|
}
|
|
15214
|
+
/**
|
|
15215
|
+
* Configuration for Natural Language Query Understanding.
|
|
15216
|
+
*/
|
|
15217
|
+
export interface Schema$GoogleCloudDiscoveryengineV1NaturalLanguageQueryUnderstandingConfig {
|
|
15218
|
+
/**
|
|
15219
|
+
* Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.
|
|
15220
|
+
*/
|
|
15221
|
+
mode?: string | null;
|
|
15222
|
+
}
|
|
15202
15223
|
/**
|
|
15203
15224
|
* Metadata and configurations for a Google Cloud project in the service.
|
|
15204
15225
|
*/
|
|
@@ -33672,6 +33693,146 @@ export namespace discoveryengine_v1alpha {
|
|
|
33672
33693
|
}
|
|
33673
33694
|
}
|
|
33674
33695
|
|
|
33696
|
+
/**
|
|
33697
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
33698
|
+
* @example
|
|
33699
|
+
* ```js
|
|
33700
|
+
* // Before running the sample:
|
|
33701
|
+
* // - Enable the API at:
|
|
33702
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
33703
|
+
* // - Login into gcloud by running:
|
|
33704
|
+
* // ```sh
|
|
33705
|
+
* // $ gcloud auth application-default login
|
|
33706
|
+
* // ```
|
|
33707
|
+
* // - Install the npm module by running:
|
|
33708
|
+
* // ```sh
|
|
33709
|
+
* // $ npm install googleapis
|
|
33710
|
+
* // ```
|
|
33711
|
+
*
|
|
33712
|
+
* const {google} = require('googleapis');
|
|
33713
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
33714
|
+
*
|
|
33715
|
+
* async function main() {
|
|
33716
|
+
* const auth = new google.auth.GoogleAuth({
|
|
33717
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
33718
|
+
* scopes: [
|
|
33719
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
33720
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
33721
|
+
* ],
|
|
33722
|
+
* });
|
|
33723
|
+
*
|
|
33724
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
33725
|
+
* const authClient = await auth.getClient();
|
|
33726
|
+
* google.options({auth: authClient});
|
|
33727
|
+
*
|
|
33728
|
+
* // Do the magic
|
|
33729
|
+
* const res =
|
|
33730
|
+
* await discoveryengine.projects.locations.collections.dataStores.servingConfigs.delete(
|
|
33731
|
+
* {
|
|
33732
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
33733
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
33734
|
+
* },
|
|
33735
|
+
* );
|
|
33736
|
+
* console.log(res.data);
|
|
33737
|
+
*
|
|
33738
|
+
* // Example response
|
|
33739
|
+
* // {}
|
|
33740
|
+
* }
|
|
33741
|
+
*
|
|
33742
|
+
* main().catch(e => {
|
|
33743
|
+
* console.error(e);
|
|
33744
|
+
* throw e;
|
|
33745
|
+
* });
|
|
33746
|
+
*
|
|
33747
|
+
* ```
|
|
33748
|
+
*
|
|
33749
|
+
* @param params - Parameters for request
|
|
33750
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
33751
|
+
* @param callback - Optional callback that handles the response.
|
|
33752
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
33753
|
+
*/
|
|
33754
|
+
delete(
|
|
33755
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
33756
|
+
options: StreamMethodOptions
|
|
33757
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
33758
|
+
delete(
|
|
33759
|
+
params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
33760
|
+
options?: MethodOptions
|
|
33761
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
33762
|
+
delete(
|
|
33763
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
33764
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
33765
|
+
callback: BodyResponseCallback<Readable>
|
|
33766
|
+
): void;
|
|
33767
|
+
delete(
|
|
33768
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
33769
|
+
options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>,
|
|
33770
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
33771
|
+
): void;
|
|
33772
|
+
delete(
|
|
33773
|
+
params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete,
|
|
33774
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
33775
|
+
): void;
|
|
33776
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
33777
|
+
delete(
|
|
33778
|
+
paramsOrCallback?:
|
|
33779
|
+
| Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete
|
|
33780
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
33781
|
+
| BodyResponseCallback<Readable>,
|
|
33782
|
+
optionsOrCallback?:
|
|
33783
|
+
| MethodOptions
|
|
33784
|
+
| StreamMethodOptions
|
|
33785
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
33786
|
+
| BodyResponseCallback<Readable>,
|
|
33787
|
+
callback?:
|
|
33788
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
33789
|
+
| BodyResponseCallback<Readable>
|
|
33790
|
+
):
|
|
33791
|
+
| void
|
|
33792
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>
|
|
33793
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
33794
|
+
let params = (paramsOrCallback ||
|
|
33795
|
+
{}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete;
|
|
33796
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
33797
|
+
|
|
33798
|
+
if (typeof paramsOrCallback === 'function') {
|
|
33799
|
+
callback = paramsOrCallback;
|
|
33800
|
+
params =
|
|
33801
|
+
{} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete;
|
|
33802
|
+
options = {};
|
|
33803
|
+
}
|
|
33804
|
+
|
|
33805
|
+
if (typeof optionsOrCallback === 'function') {
|
|
33806
|
+
callback = optionsOrCallback;
|
|
33807
|
+
options = {};
|
|
33808
|
+
}
|
|
33809
|
+
|
|
33810
|
+
const rootUrl =
|
|
33811
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
33812
|
+
const parameters = {
|
|
33813
|
+
options: Object.assign(
|
|
33814
|
+
{
|
|
33815
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
33816
|
+
method: 'DELETE',
|
|
33817
|
+
apiVersion: '',
|
|
33818
|
+
},
|
|
33819
|
+
options
|
|
33820
|
+
),
|
|
33821
|
+
params,
|
|
33822
|
+
requiredParams: ['name'],
|
|
33823
|
+
pathParams: ['name'],
|
|
33824
|
+
context: this.context,
|
|
33825
|
+
};
|
|
33826
|
+
if (callback) {
|
|
33827
|
+
createAPIRequest<Schema$GoogleProtobufEmpty>(
|
|
33828
|
+
parameters,
|
|
33829
|
+
callback as BodyResponseCallback<unknown>
|
|
33830
|
+
);
|
|
33831
|
+
} else {
|
|
33832
|
+
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
|
|
33833
|
+
}
|
|
33834
|
+
}
|
|
33835
|
+
|
|
33675
33836
|
/**
|
|
33676
33837
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
33677
33838
|
* @example
|
|
@@ -35020,6 +35181,12 @@ export namespace discoveryengine_v1alpha {
|
|
|
35020
35181
|
*/
|
|
35021
35182
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
35022
35183
|
}
|
|
35184
|
+
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
35185
|
+
/**
|
|
35186
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
35187
|
+
*/
|
|
35188
|
+
name?: string;
|
|
35189
|
+
}
|
|
35023
35190
|
export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
35024
35191
|
/**
|
|
35025
35192
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -44450,6 +44617,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
44450
44617
|
* // "displayName": "my_displayName",
|
|
44451
44618
|
* // "icon": {},
|
|
44452
44619
|
* // "languageCode": "my_languageCode",
|
|
44620
|
+
* // "managedAgentDefinition": {},
|
|
44453
44621
|
* // "name": "my_name",
|
|
44454
44622
|
* // "rejectionReason": "my_rejectionReason",
|
|
44455
44623
|
* // "sharingConfig": {},
|
|
@@ -44476,6 +44644,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
44476
44644
|
* // "displayName": "my_displayName",
|
|
44477
44645
|
* // "icon": {},
|
|
44478
44646
|
* // "languageCode": "my_languageCode",
|
|
44647
|
+
* // "managedAgentDefinition": {},
|
|
44479
44648
|
* // "name": "my_name",
|
|
44480
44649
|
* // "rejectionReason": "my_rejectionReason",
|
|
44481
44650
|
* // "sharingConfig": {},
|
|
@@ -44800,6 +44969,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
44800
44969
|
* // "displayName": "my_displayName",
|
|
44801
44970
|
* // "icon": {},
|
|
44802
44971
|
* // "languageCode": "my_languageCode",
|
|
44972
|
+
* // "managedAgentDefinition": {},
|
|
44803
44973
|
* // "name": "my_name",
|
|
44804
44974
|
* // "rejectionReason": "my_rejectionReason",
|
|
44805
44975
|
* // "sharingConfig": {},
|
|
@@ -44973,6 +45143,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
44973
45143
|
* // "displayName": "my_displayName",
|
|
44974
45144
|
* // "icon": {},
|
|
44975
45145
|
* // "languageCode": "my_languageCode",
|
|
45146
|
+
* // "managedAgentDefinition": {},
|
|
44976
45147
|
* // "name": "my_name",
|
|
44977
45148
|
* // "rejectionReason": "my_rejectionReason",
|
|
44978
45149
|
* // "sharingConfig": {},
|
|
@@ -45146,6 +45317,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
45146
45317
|
* // "displayName": "my_displayName",
|
|
45147
45318
|
* // "icon": {},
|
|
45148
45319
|
* // "languageCode": "my_languageCode",
|
|
45320
|
+
* // "managedAgentDefinition": {},
|
|
45149
45321
|
* // "name": "my_name",
|
|
45150
45322
|
* // "rejectionReason": "my_rejectionReason",
|
|
45151
45323
|
* // "sharingConfig": {},
|
|
@@ -45796,6 +45968,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
45796
45968
|
* // "displayName": "my_displayName",
|
|
45797
45969
|
* // "icon": {},
|
|
45798
45970
|
* // "languageCode": "my_languageCode",
|
|
45971
|
+
* // "managedAgentDefinition": {},
|
|
45799
45972
|
* // "name": "my_name",
|
|
45800
45973
|
* // "rejectionReason": "my_rejectionReason",
|
|
45801
45974
|
* // "sharingConfig": {},
|
|
@@ -45822,6 +45995,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
45822
45995
|
* // "displayName": "my_displayName",
|
|
45823
45996
|
* // "icon": {},
|
|
45824
45997
|
* // "languageCode": "my_languageCode",
|
|
45998
|
+
* // "managedAgentDefinition": {},
|
|
45825
45999
|
* // "name": "my_name",
|
|
45826
46000
|
* // "rejectionReason": "my_rejectionReason",
|
|
45827
46001
|
* // "sharingConfig": {},
|
|
@@ -46153,6 +46327,7 @@ export namespace discoveryengine_v1alpha {
|
|
|
46153
46327
|
* // "displayName": "my_displayName",
|
|
46154
46328
|
* // "icon": {},
|
|
46155
46329
|
* // "languageCode": "my_languageCode",
|
|
46330
|
+
* // "managedAgentDefinition": {},
|
|
46156
46331
|
* // "name": "my_name",
|
|
46157
46332
|
* // "rejectionReason": "my_rejectionReason",
|
|
46158
46333
|
* // "sharingConfig": {},
|
|
@@ -50489,6 +50664,146 @@ export namespace discoveryengine_v1alpha {
|
|
|
50489
50664
|
}
|
|
50490
50665
|
}
|
|
50491
50666
|
|
|
50667
|
+
/**
|
|
50668
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
50669
|
+
* @example
|
|
50670
|
+
* ```js
|
|
50671
|
+
* // Before running the sample:
|
|
50672
|
+
* // - Enable the API at:
|
|
50673
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
50674
|
+
* // - Login into gcloud by running:
|
|
50675
|
+
* // ```sh
|
|
50676
|
+
* // $ gcloud auth application-default login
|
|
50677
|
+
* // ```
|
|
50678
|
+
* // - Install the npm module by running:
|
|
50679
|
+
* // ```sh
|
|
50680
|
+
* // $ npm install googleapis
|
|
50681
|
+
* // ```
|
|
50682
|
+
*
|
|
50683
|
+
* const {google} = require('googleapis');
|
|
50684
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
50685
|
+
*
|
|
50686
|
+
* async function main() {
|
|
50687
|
+
* const auth = new google.auth.GoogleAuth({
|
|
50688
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
50689
|
+
* scopes: [
|
|
50690
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
50691
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
50692
|
+
* ],
|
|
50693
|
+
* });
|
|
50694
|
+
*
|
|
50695
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
50696
|
+
* const authClient = await auth.getClient();
|
|
50697
|
+
* google.options({auth: authClient});
|
|
50698
|
+
*
|
|
50699
|
+
* // Do the magic
|
|
50700
|
+
* const res =
|
|
50701
|
+
* await discoveryengine.projects.locations.collections.engines.servingConfigs.delete(
|
|
50702
|
+
* {
|
|
50703
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
50704
|
+
* name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/servingConfigs/my-servingConfig',
|
|
50705
|
+
* },
|
|
50706
|
+
* );
|
|
50707
|
+
* console.log(res.data);
|
|
50708
|
+
*
|
|
50709
|
+
* // Example response
|
|
50710
|
+
* // {}
|
|
50711
|
+
* }
|
|
50712
|
+
*
|
|
50713
|
+
* main().catch(e => {
|
|
50714
|
+
* console.error(e);
|
|
50715
|
+
* throw e;
|
|
50716
|
+
* });
|
|
50717
|
+
*
|
|
50718
|
+
* ```
|
|
50719
|
+
*
|
|
50720
|
+
* @param params - Parameters for request
|
|
50721
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
50722
|
+
* @param callback - Optional callback that handles the response.
|
|
50723
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
50724
|
+
*/
|
|
50725
|
+
delete(
|
|
50726
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete,
|
|
50727
|
+
options: StreamMethodOptions
|
|
50728
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
50729
|
+
delete(
|
|
50730
|
+
params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete,
|
|
50731
|
+
options?: MethodOptions
|
|
50732
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
50733
|
+
delete(
|
|
50734
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete,
|
|
50735
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
50736
|
+
callback: BodyResponseCallback<Readable>
|
|
50737
|
+
): void;
|
|
50738
|
+
delete(
|
|
50739
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete,
|
|
50740
|
+
options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>,
|
|
50741
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
50742
|
+
): void;
|
|
50743
|
+
delete(
|
|
50744
|
+
params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete,
|
|
50745
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
50746
|
+
): void;
|
|
50747
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
50748
|
+
delete(
|
|
50749
|
+
paramsOrCallback?:
|
|
50750
|
+
| Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete
|
|
50751
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
50752
|
+
| BodyResponseCallback<Readable>,
|
|
50753
|
+
optionsOrCallback?:
|
|
50754
|
+
| MethodOptions
|
|
50755
|
+
| StreamMethodOptions
|
|
50756
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
50757
|
+
| BodyResponseCallback<Readable>,
|
|
50758
|
+
callback?:
|
|
50759
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
50760
|
+
| BodyResponseCallback<Readable>
|
|
50761
|
+
):
|
|
50762
|
+
| void
|
|
50763
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>
|
|
50764
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
50765
|
+
let params = (paramsOrCallback ||
|
|
50766
|
+
{}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete;
|
|
50767
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
50768
|
+
|
|
50769
|
+
if (typeof paramsOrCallback === 'function') {
|
|
50770
|
+
callback = paramsOrCallback;
|
|
50771
|
+
params =
|
|
50772
|
+
{} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete;
|
|
50773
|
+
options = {};
|
|
50774
|
+
}
|
|
50775
|
+
|
|
50776
|
+
if (typeof optionsOrCallback === 'function') {
|
|
50777
|
+
callback = optionsOrCallback;
|
|
50778
|
+
options = {};
|
|
50779
|
+
}
|
|
50780
|
+
|
|
50781
|
+
const rootUrl =
|
|
50782
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
50783
|
+
const parameters = {
|
|
50784
|
+
options: Object.assign(
|
|
50785
|
+
{
|
|
50786
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
50787
|
+
method: 'DELETE',
|
|
50788
|
+
apiVersion: '',
|
|
50789
|
+
},
|
|
50790
|
+
options
|
|
50791
|
+
),
|
|
50792
|
+
params,
|
|
50793
|
+
requiredParams: ['name'],
|
|
50794
|
+
pathParams: ['name'],
|
|
50795
|
+
context: this.context,
|
|
50796
|
+
};
|
|
50797
|
+
if (callback) {
|
|
50798
|
+
createAPIRequest<Schema$GoogleProtobufEmpty>(
|
|
50799
|
+
parameters,
|
|
50800
|
+
callback as BodyResponseCallback<unknown>
|
|
50801
|
+
);
|
|
50802
|
+
} else {
|
|
50803
|
+
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
|
|
50804
|
+
}
|
|
50805
|
+
}
|
|
50806
|
+
|
|
50492
50807
|
/**
|
|
50493
50808
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
50494
50809
|
* @example
|
|
@@ -51837,6 +52152,12 @@ export namespace discoveryengine_v1alpha {
|
|
|
51837
52152
|
*/
|
|
51838
52153
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
51839
52154
|
}
|
|
52155
|
+
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Delete extends StandardParameters {
|
|
52156
|
+
/**
|
|
52157
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
52158
|
+
*/
|
|
52159
|
+
name?: string;
|
|
52160
|
+
}
|
|
51840
52161
|
export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters {
|
|
51841
52162
|
/**
|
|
51842
52163
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
@@ -63120,6 +63441,144 @@ export namespace discoveryengine_v1alpha {
|
|
|
63120
63441
|
}
|
|
63121
63442
|
}
|
|
63122
63443
|
|
|
63444
|
+
/**
|
|
63445
|
+
* Deletes a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist.
|
|
63446
|
+
* @example
|
|
63447
|
+
* ```js
|
|
63448
|
+
* // Before running the sample:
|
|
63449
|
+
* // - Enable the API at:
|
|
63450
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
63451
|
+
* // - Login into gcloud by running:
|
|
63452
|
+
* // ```sh
|
|
63453
|
+
* // $ gcloud auth application-default login
|
|
63454
|
+
* // ```
|
|
63455
|
+
* // - Install the npm module by running:
|
|
63456
|
+
* // ```sh
|
|
63457
|
+
* // $ npm install googleapis
|
|
63458
|
+
* // ```
|
|
63459
|
+
*
|
|
63460
|
+
* const {google} = require('googleapis');
|
|
63461
|
+
* const discoveryengine = google.discoveryengine('v1alpha');
|
|
63462
|
+
*
|
|
63463
|
+
* async function main() {
|
|
63464
|
+
* const auth = new google.auth.GoogleAuth({
|
|
63465
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
63466
|
+
* scopes: [
|
|
63467
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
63468
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
63469
|
+
* ],
|
|
63470
|
+
* });
|
|
63471
|
+
*
|
|
63472
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
63473
|
+
* const authClient = await auth.getClient();
|
|
63474
|
+
* google.options({auth: authClient});
|
|
63475
|
+
*
|
|
63476
|
+
* // Do the magic
|
|
63477
|
+
* const res =
|
|
63478
|
+
* await discoveryengine.projects.locations.dataStores.servingConfigs.delete({
|
|
63479
|
+
* // Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
63480
|
+
* name: 'projects/my-project/locations/my-location/dataStores/my-dataStore/servingConfigs/my-servingConfig',
|
|
63481
|
+
* });
|
|
63482
|
+
* console.log(res.data);
|
|
63483
|
+
*
|
|
63484
|
+
* // Example response
|
|
63485
|
+
* // {}
|
|
63486
|
+
* }
|
|
63487
|
+
*
|
|
63488
|
+
* main().catch(e => {
|
|
63489
|
+
* console.error(e);
|
|
63490
|
+
* throw e;
|
|
63491
|
+
* });
|
|
63492
|
+
*
|
|
63493
|
+
* ```
|
|
63494
|
+
*
|
|
63495
|
+
* @param params - Parameters for request
|
|
63496
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
63497
|
+
* @param callback - Optional callback that handles the response.
|
|
63498
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
63499
|
+
*/
|
|
63500
|
+
delete(
|
|
63501
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete,
|
|
63502
|
+
options: StreamMethodOptions
|
|
63503
|
+
): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
63504
|
+
delete(
|
|
63505
|
+
params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete,
|
|
63506
|
+
options?: MethodOptions
|
|
63507
|
+
): Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>;
|
|
63508
|
+
delete(
|
|
63509
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete,
|
|
63510
|
+
options: StreamMethodOptions | BodyResponseCallback<Readable>,
|
|
63511
|
+
callback: BodyResponseCallback<Readable>
|
|
63512
|
+
): void;
|
|
63513
|
+
delete(
|
|
63514
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete,
|
|
63515
|
+
options: MethodOptions | BodyResponseCallback<Schema$GoogleProtobufEmpty>,
|
|
63516
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
63517
|
+
): void;
|
|
63518
|
+
delete(
|
|
63519
|
+
params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete,
|
|
63520
|
+
callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
63521
|
+
): void;
|
|
63522
|
+
delete(callback: BodyResponseCallback<Schema$GoogleProtobufEmpty>): void;
|
|
63523
|
+
delete(
|
|
63524
|
+
paramsOrCallback?:
|
|
63525
|
+
| Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete
|
|
63526
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
63527
|
+
| BodyResponseCallback<Readable>,
|
|
63528
|
+
optionsOrCallback?:
|
|
63529
|
+
| MethodOptions
|
|
63530
|
+
| StreamMethodOptions
|
|
63531
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
63532
|
+
| BodyResponseCallback<Readable>,
|
|
63533
|
+
callback?:
|
|
63534
|
+
| BodyResponseCallback<Schema$GoogleProtobufEmpty>
|
|
63535
|
+
| BodyResponseCallback<Readable>
|
|
63536
|
+
):
|
|
63537
|
+
| void
|
|
63538
|
+
| Promise<GaxiosResponseWithHTTP2<Schema$GoogleProtobufEmpty>>
|
|
63539
|
+
| Promise<GaxiosResponseWithHTTP2<Readable>> {
|
|
63540
|
+
let params = (paramsOrCallback ||
|
|
63541
|
+
{}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete;
|
|
63542
|
+
let options = (optionsOrCallback || {}) as MethodOptions;
|
|
63543
|
+
|
|
63544
|
+
if (typeof paramsOrCallback === 'function') {
|
|
63545
|
+
callback = paramsOrCallback;
|
|
63546
|
+
params =
|
|
63547
|
+
{} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete;
|
|
63548
|
+
options = {};
|
|
63549
|
+
}
|
|
63550
|
+
|
|
63551
|
+
if (typeof optionsOrCallback === 'function') {
|
|
63552
|
+
callback = optionsOrCallback;
|
|
63553
|
+
options = {};
|
|
63554
|
+
}
|
|
63555
|
+
|
|
63556
|
+
const rootUrl =
|
|
63557
|
+
options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
63558
|
+
const parameters = {
|
|
63559
|
+
options: Object.assign(
|
|
63560
|
+
{
|
|
63561
|
+
url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
63562
|
+
method: 'DELETE',
|
|
63563
|
+
apiVersion: '',
|
|
63564
|
+
},
|
|
63565
|
+
options
|
|
63566
|
+
),
|
|
63567
|
+
params,
|
|
63568
|
+
requiredParams: ['name'],
|
|
63569
|
+
pathParams: ['name'],
|
|
63570
|
+
context: this.context,
|
|
63571
|
+
};
|
|
63572
|
+
if (callback) {
|
|
63573
|
+
createAPIRequest<Schema$GoogleProtobufEmpty>(
|
|
63574
|
+
parameters,
|
|
63575
|
+
callback as BodyResponseCallback<unknown>
|
|
63576
|
+
);
|
|
63577
|
+
} else {
|
|
63578
|
+
return createAPIRequest<Schema$GoogleProtobufEmpty>(parameters);
|
|
63579
|
+
}
|
|
63580
|
+
}
|
|
63581
|
+
|
|
63123
63582
|
/**
|
|
63124
63583
|
* Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
|
|
63125
63584
|
* @example
|
|
@@ -64460,6 +64919,12 @@ export namespace discoveryengine_v1alpha {
|
|
|
64460
64919
|
*/
|
|
64461
64920
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest;
|
|
64462
64921
|
}
|
|
64922
|
+
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Delete extends StandardParameters {
|
|
64923
|
+
/**
|
|
64924
|
+
* Required. The resource name of the ServingConfig to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|
|
64925
|
+
*/
|
|
64926
|
+
name?: string;
|
|
64927
|
+
}
|
|
64463
64928
|
export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters {
|
|
64464
64929
|
/**
|
|
64465
64930
|
* Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}`
|