@googleapis/discoveryengine 31.0.0 → 32.0.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 +11 -0
- package/build/tsconfig.tsbuildinfo +1 -1
- package/build/v1.d.ts +111 -15
- package/build/v1.js +32 -0
- package/build/v1.js.map +1 -1
- package/build/v1alpha.d.ts +111 -15
- package/build/v1alpha.js +32 -0
- package/build/v1alpha.js.map +1 -1
- package/build/v1beta.d.ts +94 -14
- package/build/v1beta.js +32 -0
- package/build/v1beta.js.map +1 -1
- package/package.json +1 -1
- package/v1.ts +193 -15
- package/v1alpha.ts +193 -15
- package/v1beta.ts +176 -14
package/build/v1beta.d.ts
CHANGED
|
@@ -2471,13 +2471,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
2471
2471
|
vpcscEnabled?: boolean | null;
|
|
2472
2472
|
}
|
|
2473
2473
|
/**
|
|
2474
|
-
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author,
|
|
2474
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
|
|
2475
2475
|
*/
|
|
2476
2476
|
export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
|
|
2477
|
-
/**
|
|
2478
|
-
* Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.
|
|
2479
|
-
*/
|
|
2480
|
-
authenticatedAccount?: string | null;
|
|
2481
2477
|
/**
|
|
2482
2478
|
* Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).
|
|
2483
2479
|
*/
|
|
@@ -3317,7 +3313,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
3317
3313
|
*/
|
|
3318
3314
|
displayName?: string | null;
|
|
3319
3315
|
/**
|
|
3320
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `
|
|
3316
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
3321
3317
|
*/
|
|
3322
3318
|
features?: {
|
|
3323
3319
|
[key: string]: string;
|
|
@@ -8155,7 +8151,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
8155
8151
|
*/
|
|
8156
8152
|
deleteUnassignedUserLicenses?: boolean | null;
|
|
8157
8153
|
/**
|
|
8158
|
-
* The inline source for the input content for
|
|
8154
|
+
* The inline source for the input content for license assignment.
|
|
8159
8155
|
*/
|
|
8160
8156
|
inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource;
|
|
8161
8157
|
}
|
|
@@ -9896,7 +9892,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
9896
9892
|
*/
|
|
9897
9893
|
displayName?: string | null;
|
|
9898
9894
|
/**
|
|
9899
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `
|
|
9895
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
9900
9896
|
*/
|
|
9901
9897
|
features?: {
|
|
9902
9898
|
[key: string]: string;
|
|
@@ -14982,13 +14978,9 @@ export declare namespace discoveryengine_v1beta {
|
|
|
14982
14978
|
vpcscEnabled?: boolean | null;
|
|
14983
14979
|
}
|
|
14984
14980
|
/**
|
|
14985
|
-
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author,
|
|
14981
|
+
* User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
|
|
14986
14982
|
*/
|
|
14987
14983
|
export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
|
|
14988
|
-
/**
|
|
14989
|
-
* Optional. The end user's account as authenticated to the connector, so the end user can see which account is connected. May be an email, a username, or any identifier the connector/third party provides.
|
|
14990
|
-
*/
|
|
14991
|
-
authenticatedAccount?: string | null;
|
|
14992
14984
|
/**
|
|
14993
14985
|
* Optional. The party that authored the connector, e.g. "Google" or a third-party provider name. Lets end users see who authored a connector (future: third-party-authored connectors).
|
|
14994
14986
|
*/
|
|
@@ -15725,7 +15717,7 @@ export declare namespace discoveryengine_v1beta {
|
|
|
15725
15717
|
*/
|
|
15726
15718
|
displayName?: string | null;
|
|
15727
15719
|
/**
|
|
15728
|
-
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `
|
|
15720
|
+
* Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `canvas-workspace` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications`
|
|
15729
15721
|
*/
|
|
15730
15722
|
features?: {
|
|
15731
15723
|
[key: string]: string;
|
|
@@ -17963,6 +17955,84 @@ export declare namespace discoveryengine_v1beta {
|
|
|
17963
17955
|
obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>): void;
|
|
17964
17956
|
obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>): void;
|
|
17965
17957
|
obtainCrawlRate(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>): void;
|
|
17958
|
+
/**
|
|
17959
|
+
* Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
|
|
17960
|
+
* @example
|
|
17961
|
+
* ```js
|
|
17962
|
+
* // Before running the sample:
|
|
17963
|
+
* // - Enable the API at:
|
|
17964
|
+
* // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
|
|
17965
|
+
* // - Login into gcloud by running:
|
|
17966
|
+
* // ```sh
|
|
17967
|
+
* // $ gcloud auth application-default login
|
|
17968
|
+
* // ```
|
|
17969
|
+
* // - Install the npm module by running:
|
|
17970
|
+
* // ```sh
|
|
17971
|
+
* // $ npm install googleapis
|
|
17972
|
+
* // ```
|
|
17973
|
+
*
|
|
17974
|
+
* const {google} = require('googleapis');
|
|
17975
|
+
* const discoveryengine = google.discoveryengine('v1beta');
|
|
17976
|
+
*
|
|
17977
|
+
* async function main() {
|
|
17978
|
+
* const auth = new google.auth.GoogleAuth({
|
|
17979
|
+
* // Scopes can be specified either as an array or as a single, space-delimited string.
|
|
17980
|
+
* scopes: [
|
|
17981
|
+
* 'https://www.googleapis.com/auth/cloud-platform',
|
|
17982
|
+
* 'https://www.googleapis.com/auth/discoveryengine.readwrite',
|
|
17983
|
+
* 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
|
|
17984
|
+
* ],
|
|
17985
|
+
* });
|
|
17986
|
+
*
|
|
17987
|
+
* // Acquire an auth client, and bind it to all future calls
|
|
17988
|
+
* const authClient = await auth.getClient();
|
|
17989
|
+
* google.options({auth: authClient});
|
|
17990
|
+
*
|
|
17991
|
+
* // Do the magic
|
|
17992
|
+
* const res = await discoveryengine.projects.locations.provision({
|
|
17993
|
+
* // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
17994
|
+
* name: 'projects/my-project/locations/my-location',
|
|
17995
|
+
*
|
|
17996
|
+
* // Request body metadata
|
|
17997
|
+
* requestBody: {
|
|
17998
|
+
* // request body parameters
|
|
17999
|
+
* // {
|
|
18000
|
+
* // "acceptDataUseTerms": false,
|
|
18001
|
+
* // "dataUseTermsVersion": "my_dataUseTermsVersion",
|
|
18002
|
+
* // "saasParams": {}
|
|
18003
|
+
* // }
|
|
18004
|
+
* },
|
|
18005
|
+
* });
|
|
18006
|
+
* console.log(res.data);
|
|
18007
|
+
*
|
|
18008
|
+
* // Example response
|
|
18009
|
+
* // {
|
|
18010
|
+
* // "done": false,
|
|
18011
|
+
* // "error": {},
|
|
18012
|
+
* // "metadata": {},
|
|
18013
|
+
* // "name": "my_name",
|
|
18014
|
+
* // "response": {}
|
|
18015
|
+
* // }
|
|
18016
|
+
* }
|
|
18017
|
+
*
|
|
18018
|
+
* main().catch(e => {
|
|
18019
|
+
* console.error(e);
|
|
18020
|
+
* throw e;
|
|
18021
|
+
* });
|
|
18022
|
+
*
|
|
18023
|
+
* ```
|
|
18024
|
+
*
|
|
18025
|
+
* @param params - Parameters for request
|
|
18026
|
+
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
18027
|
+
* @param callback - Optional callback that handles the response.
|
|
18028
|
+
* @returns A promise if used with async/await, or void if used with a callback.
|
|
18029
|
+
*/
|
|
18030
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
|
|
18031
|
+
provision(params?: Params$Resource$Projects$Locations$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
|
|
18032
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
|
|
18033
|
+
provision(params: Params$Resource$Projects$Locations$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
18034
|
+
provision(params: Params$Resource$Projects$Locations$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
18035
|
+
provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
|
|
17966
18036
|
/**
|
|
17967
18037
|
* Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.
|
|
17968
18038
|
* @example
|
|
@@ -18302,6 +18372,16 @@ export declare namespace discoveryengine_v1beta {
|
|
|
18302
18372
|
*/
|
|
18303
18373
|
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest;
|
|
18304
18374
|
}
|
|
18375
|
+
export interface Params$Resource$Projects$Locations$Provision extends StandardParameters {
|
|
18376
|
+
/**
|
|
18377
|
+
* Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
|
|
18378
|
+
*/
|
|
18379
|
+
name?: string;
|
|
18380
|
+
/**
|
|
18381
|
+
* Request body metadata
|
|
18382
|
+
*/
|
|
18383
|
+
requestBody?: Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest;
|
|
18384
|
+
}
|
|
18305
18385
|
export interface Params$Resource$Projects$Locations$Removededicatedcrawlrate extends StandardParameters {
|
|
18306
18386
|
/**
|
|
18307
18387
|
* Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}`
|
package/build/v1beta.js
CHANGED
|
@@ -302,6 +302,38 @@ var discoveryengine_v1beta;
|
|
|
302
302
|
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
303
303
|
}
|
|
304
304
|
}
|
|
305
|
+
provision(paramsOrCallback, optionsOrCallback, callback) {
|
|
306
|
+
let params = (paramsOrCallback ||
|
|
307
|
+
{});
|
|
308
|
+
let options = (optionsOrCallback || {});
|
|
309
|
+
if (typeof paramsOrCallback === 'function') {
|
|
310
|
+
callback = paramsOrCallback;
|
|
311
|
+
params = {};
|
|
312
|
+
options = {};
|
|
313
|
+
}
|
|
314
|
+
if (typeof optionsOrCallback === 'function') {
|
|
315
|
+
callback = optionsOrCallback;
|
|
316
|
+
options = {};
|
|
317
|
+
}
|
|
318
|
+
const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
|
|
319
|
+
const parameters = {
|
|
320
|
+
options: Object.assign({
|
|
321
|
+
url: (rootUrl + '/v1beta/{+name}:provision').replace(/([^:]\/)\/+/g, '$1'),
|
|
322
|
+
method: 'POST',
|
|
323
|
+
apiVersion: '',
|
|
324
|
+
}, options),
|
|
325
|
+
params,
|
|
326
|
+
requiredParams: ['name'],
|
|
327
|
+
pathParams: ['name'],
|
|
328
|
+
context: this.context,
|
|
329
|
+
};
|
|
330
|
+
if (callback) {
|
|
331
|
+
(0, googleapis_common_1.createAPIRequest)(parameters, callback);
|
|
332
|
+
}
|
|
333
|
+
else {
|
|
334
|
+
return (0, googleapis_common_1.createAPIRequest)(parameters);
|
|
335
|
+
}
|
|
336
|
+
}
|
|
305
337
|
removeDedicatedCrawlRate(paramsOrCallback, optionsOrCallback, callback) {
|
|
306
338
|
let params = (paramsOrCallback ||
|
|
307
339
|
{});
|