@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.
@@ -3018,7 +3018,7 @@ export declare namespace discoveryengine_v1alpha {
3018
3018
  */
3019
3019
  deleteUnassignedUserLicenses?: boolean | null;
3020
3020
  /**
3021
- * The inline source for the input content for document embeddings.
3021
+ * The inline source for the input content for license assignment.
3022
3022
  */
3023
3023
  inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource;
3024
3024
  }
@@ -4690,13 +4690,9 @@ export declare namespace discoveryengine_v1alpha {
4690
4690
  vpcscEnabled?: boolean | null;
4691
4691
  }
4692
4692
  /**
4693
- * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
4693
+ * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
4694
4694
  */
4695
4695
  export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
4696
- /**
4697
- * 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.
4698
- */
4699
- authenticatedAccount?: string | null;
4700
4696
  /**
4701
4697
  * 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).
4702
4698
  */
@@ -5745,7 +5741,7 @@ export declare namespace discoveryengine_v1alpha {
5745
5741
  */
5746
5742
  displayName?: string | null;
5747
5743
  /**
5748
- * 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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
5744
+ * 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`
5749
5745
  */
5750
5746
  features?: {
5751
5747
  [key: string]: string;
@@ -12008,6 +12004,14 @@ export declare namespace discoveryengine_v1alpha {
12008
12004
  * Output only. The display name of the data source.
12009
12005
  */
12010
12006
  dataSourceDisplayName?: string | null;
12007
+ /**
12008
+ * Output only. The end-user-facing display name of the data source, sourced from `ConnectorSource.end_user_display_name`. When unset, clients fall back to `data_source_display_name`.
12009
+ */
12010
+ dataSourceEndUserDisplayName?: string | null;
12011
+ /**
12012
+ * Output only. The version of the connector definition backing this collection, mirroring `DataConnector.data_source_version`.
12013
+ */
12014
+ dataSourceVersion?: number | null;
12011
12015
  /**
12012
12016
  * For the data store collection, list of the children data stores.
12013
12017
  */
@@ -12020,6 +12024,14 @@ export declare namespace discoveryengine_v1alpha {
12020
12024
  * Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. For synthetic placeholder entries (see message-level comment) this is a synthetic placeholder id, not a real collection_id.
12021
12025
  */
12022
12026
  id?: string | null;
12027
+ /**
12028
+ * Output only. Whether this is a first-party (Google-owned) connector, as opposed to a third-party connector. Used by the frontend to group 1P vs 3P connectors. Sourced from `ConnectorSource.is_first_party` once that field is universally populated (b/534727761); until then derived from `ConnectorSource.connector_type == FIRST_PARTY`.
12029
+ */
12030
+ isFirstParty?: boolean | null;
12031
+ /**
12032
+ * Output only. User-facing connector metadata (`title`, `description`, `short_description`, `author`, `note`), retrieved from the registry `ConnectorSource.metadata` (joined by data source). Shown on the connector detail page.
12033
+ */
12034
+ metadata?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata;
12023
12035
  /**
12024
12036
  * The name of the collection. It should be collection resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}`. For APIs under WidgetService, such as WidgetService.LookupWidgetConfig, the project number and location part is erased in this field. For synthetic placeholder entries (see message-level comment) this carries a synthetic placeholder collection id that does not correspond to a real collection. Callers must not attempt to resolve / GET this resource until the user authorizes the connector.
12025
12037
  */
@@ -12259,7 +12271,7 @@ export declare namespace discoveryengine_v1alpha {
12259
12271
  */
12260
12272
  enableVisualContentSummary?: boolean | null;
12261
12273
  /**
12262
- * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
12274
+ * Output only. Feature config for the engine to opt in or opt out of features. Supported keys: * `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`
12263
12275
  */
12264
12276
  features?: {
12265
12277
  [key: string]: string;
@@ -13693,7 +13705,7 @@ export declare namespace discoveryengine_v1alpha {
13693
13705
  */
13694
13706
  displayName?: string | null;
13695
13707
  /**
13696
- * 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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
13708
+ * 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`
13697
13709
  */
13698
13710
  features?: {
13699
13711
  [key: string]: string;
@@ -16279,13 +16291,9 @@ export declare namespace discoveryengine_v1alpha {
16279
16291
  vpcscEnabled?: boolean | null;
16280
16292
  }
16281
16293
  /**
16282
- * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
16294
+ * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
16283
16295
  */
16284
16296
  export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
16285
- /**
16286
- * 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.
16287
- */
16288
- authenticatedAccount?: string | null;
16289
16297
  /**
16290
16298
  * 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).
16291
16299
  */
@@ -17022,7 +17030,7 @@ export declare namespace discoveryengine_v1alpha {
17022
17030
  */
17023
17031
  displayName?: string | null;
17024
17032
  /**
17025
- * 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` * `disable-skills` * `disable-projects` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence`
17033
+ * 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`
17026
17034
  */
17027
17035
  features?: {
17028
17036
  [key: string]: string;
@@ -20440,6 +20448,84 @@ export declare namespace discoveryengine_v1alpha {
20440
20448
  obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
20441
20449
  obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
20442
20450
  obtainCrawlRate(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
20451
+ /**
20452
+ * 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.
20453
+ * @example
20454
+ * ```js
20455
+ * // Before running the sample:
20456
+ * // - Enable the API at:
20457
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
20458
+ * // - Login into gcloud by running:
20459
+ * // ```sh
20460
+ * // $ gcloud auth application-default login
20461
+ * // ```
20462
+ * // - Install the npm module by running:
20463
+ * // ```sh
20464
+ * // $ npm install googleapis
20465
+ * // ```
20466
+ *
20467
+ * const {google} = require('googleapis');
20468
+ * const discoveryengine = google.discoveryengine('v1alpha');
20469
+ *
20470
+ * async function main() {
20471
+ * const auth = new google.auth.GoogleAuth({
20472
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
20473
+ * scopes: [
20474
+ * 'https://www.googleapis.com/auth/cloud-platform',
20475
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
20476
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
20477
+ * ],
20478
+ * });
20479
+ *
20480
+ * // Acquire an auth client, and bind it to all future calls
20481
+ * const authClient = await auth.getClient();
20482
+ * google.options({auth: authClient});
20483
+ *
20484
+ * // Do the magic
20485
+ * const res = await discoveryengine.projects.locations.provision({
20486
+ * // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
20487
+ * name: 'projects/my-project/locations/my-location',
20488
+ *
20489
+ * // Request body metadata
20490
+ * requestBody: {
20491
+ * // request body parameters
20492
+ * // {
20493
+ * // "acceptDataUseTerms": false,
20494
+ * // "dataUseTermsVersion": "my_dataUseTermsVersion",
20495
+ * // "saasParams": {}
20496
+ * // }
20497
+ * },
20498
+ * });
20499
+ * console.log(res.data);
20500
+ *
20501
+ * // Example response
20502
+ * // {
20503
+ * // "done": false,
20504
+ * // "error": {},
20505
+ * // "metadata": {},
20506
+ * // "name": "my_name",
20507
+ * // "response": {}
20508
+ * // }
20509
+ * }
20510
+ *
20511
+ * main().catch(e => {
20512
+ * console.error(e);
20513
+ * throw e;
20514
+ * });
20515
+ *
20516
+ * ```
20517
+ *
20518
+ * @param params - Parameters for request
20519
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
20520
+ * @param callback - Optional callback that handles the response.
20521
+ * @returns A promise if used with async/await, or void if used with a callback.
20522
+ */
20523
+ provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
20524
+ provision(params?: Params$Resource$Projects$Locations$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
20525
+ provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
20526
+ provision(params: Params$Resource$Projects$Locations$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
20527
+ provision(params: Params$Resource$Projects$Locations$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
20528
+ provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
20443
20529
  /**
20444
20530
  * Queries configurable pricing usage stats for a project.
20445
20531
  * @example
@@ -21101,6 +21187,16 @@ export declare namespace discoveryengine_v1alpha {
21101
21187
  */
21102
21188
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest;
21103
21189
  }
21190
+ export interface Params$Resource$Projects$Locations$Provision extends StandardParameters {
21191
+ /**
21192
+ * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
21193
+ */
21194
+ name?: string;
21195
+ /**
21196
+ * Request body metadata
21197
+ */
21198
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest;
21199
+ }
21104
21200
  export interface Params$Resource$Projects$Locations$Queryconfigurablepricingusagestats extends StandardParameters {
21105
21201
  /**
21106
21202
  * Required. The location to query usage stats for.
package/build/v1alpha.js CHANGED
@@ -533,6 +533,38 @@ var discoveryengine_v1alpha;
533
533
  return (0, googleapis_common_1.createAPIRequest)(parameters);
534
534
  }
535
535
  }
536
+ provision(paramsOrCallback, optionsOrCallback, callback) {
537
+ let params = (paramsOrCallback ||
538
+ {});
539
+ let options = (optionsOrCallback || {});
540
+ if (typeof paramsOrCallback === 'function') {
541
+ callback = paramsOrCallback;
542
+ params = {};
543
+ options = {};
544
+ }
545
+ if (typeof optionsOrCallback === 'function') {
546
+ callback = optionsOrCallback;
547
+ options = {};
548
+ }
549
+ const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
550
+ const parameters = {
551
+ options: Object.assign({
552
+ url: (rootUrl + '/v1alpha/{+name}:provision').replace(/([^:]\/)\/+/g, '$1'),
553
+ method: 'POST',
554
+ apiVersion: '',
555
+ }, options),
556
+ params,
557
+ requiredParams: ['name'],
558
+ pathParams: ['name'],
559
+ context: this.context,
560
+ };
561
+ if (callback) {
562
+ (0, googleapis_common_1.createAPIRequest)(parameters, callback);
563
+ }
564
+ else {
565
+ return (0, googleapis_common_1.createAPIRequest)(parameters);
566
+ }
567
+ }
536
568
  queryConfigurablePricingUsageStats(paramsOrCallback, optionsOrCallback, callback) {
537
569
  let params = (paramsOrCallback ||
538
570
  {});