@googleapis/discoveryengine 31.0.0 → 32.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.
@@ -2403,6 +2403,10 @@ export declare namespace discoveryengine_v1alpha {
2403
2403
  * Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
2404
2404
  */
2405
2405
  verdict?: string | null;
2406
+ /**
2407
+ * Output only. The source of the violation.
2408
+ */
2409
+ violationSource?: string | null;
2406
2410
  }
2407
2411
  /**
2408
2412
  * Customer policy enforcement result for the banned phrase policy.
@@ -3018,7 +3022,7 @@ export declare namespace discoveryengine_v1alpha {
3018
3022
  */
3019
3023
  deleteUnassignedUserLicenses?: boolean | null;
3020
3024
  /**
3021
- * The inline source for the input content for document embeddings.
3025
+ * The inline source for the input content for license assignment.
3022
3026
  */
3023
3027
  inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaBatchUpdateUserLicensesRequestInlineSource;
3024
3028
  }
@@ -4690,13 +4694,9 @@ export declare namespace discoveryengine_v1alpha {
4690
4694
  vpcscEnabled?: boolean | null;
4691
4695
  }
4692
4696
  /**
4693
- * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
4697
+ * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
4694
4698
  */
4695
4699
  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
4700
  /**
4701
4701
  * 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
4702
  */
@@ -5745,7 +5745,7 @@ export declare namespace discoveryengine_v1alpha {
5745
5745
  */
5746
5746
  displayName?: string | null;
5747
5747
  /**
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`
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` * `speech-to-text` * `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
5749
  */
5750
5750
  features?: {
5751
5751
  [key: string]: string;
@@ -10045,7 +10045,7 @@ export declare namespace discoveryengine_v1alpha {
10045
10045
  */
10046
10046
  export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponse {
10047
10047
  /**
10048
- * Controls applied as part of the Control service.
10048
+ * Optional. Controls applied as part of the Control service.
10049
10049
  */
10050
10050
  appliedControls?: string[] | null;
10051
10051
  /**
@@ -12008,6 +12008,14 @@ export declare namespace discoveryengine_v1alpha {
12008
12008
  * Output only. The display name of the data source.
12009
12009
  */
12010
12010
  dataSourceDisplayName?: string | null;
12011
+ /**
12012
+ * 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`.
12013
+ */
12014
+ dataSourceEndUserDisplayName?: string | null;
12015
+ /**
12016
+ * Output only. The version of the connector definition backing this collection, mirroring `DataConnector.data_source_version`.
12017
+ */
12018
+ dataSourceVersion?: number | null;
12011
12019
  /**
12012
12020
  * For the data store collection, list of the children data stores.
12013
12021
  */
@@ -12020,6 +12028,14 @@ export declare namespace discoveryengine_v1alpha {
12020
12028
  * 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
12029
  */
12022
12030
  id?: string | null;
12031
+ /**
12032
+ * 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`.
12033
+ */
12034
+ isFirstParty?: boolean | null;
12035
+ /**
12036
+ * 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.
12037
+ */
12038
+ metadata?: Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata;
12023
12039
  /**
12024
12040
  * 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
12041
  */
@@ -12259,7 +12275,7 @@ export declare namespace discoveryengine_v1alpha {
12259
12275
  */
12260
12276
  enableVisualContentSummary?: boolean | null;
12261
12277
  /**
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`
12278
+ * 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` * `speech-to-text` * `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
12279
  */
12264
12280
  features?: {
12265
12281
  [key: string]: string;
@@ -12385,6 +12401,10 @@ export declare namespace discoveryengine_v1alpha {
12385
12401
  * Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI.
12386
12402
  */
12387
12403
  isPreview?: boolean | null;
12404
+ /**
12405
+ * Output only. Short label shown in the compact selector bar chip (e.g. `3.x Flash`) as opposed to the full `display_name` (`Gemini 3.x Flash`). Falls back to `display_name` when the backend registry does not specify a distinct short label.
12406
+ */
12407
+ label?: string | null;
12388
12408
  /**
12389
12409
  * Output only. Unique identifier of the model (e.g. `gemini-2.5-flash`, `gemini-3.1-pro-preview`). This is the same identifier that clients pass back to the assistant service to select this model. Virtual / "pseudo" models (e.g. `gemini-fast`) are also valid values here; they are resolved to the underlying concrete model on the backend.
12390
12410
  */
@@ -13693,7 +13713,7 @@ export declare namespace discoveryengine_v1alpha {
13693
13713
  */
13694
13714
  displayName?: string | null;
13695
13715
  /**
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`
13716
+ * 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` * `speech-to-text` * `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
13717
  */
13698
13718
  features?: {
13699
13719
  [key: string]: string;
@@ -16279,13 +16299,9 @@ export declare namespace discoveryengine_v1alpha {
16279
16299
  vpcscEnabled?: boolean | null;
16280
16300
  }
16281
16301
  /**
16282
- * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
16302
+ * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
16283
16303
  */
16284
16304
  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
16305
  /**
16290
16306
  * 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
16307
  */
@@ -17022,7 +17038,7 @@ export declare namespace discoveryengine_v1alpha {
17022
17038
  */
17023
17039
  displayName?: string | null;
17024
17040
  /**
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`
17041
+ * 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` * `speech-to-text` * `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
17042
  */
17027
17043
  features?: {
17028
17044
  [key: string]: string;
@@ -20440,6 +20456,84 @@ export declare namespace discoveryengine_v1alpha {
20440
20456
  obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
20441
20457
  obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
20442
20458
  obtainCrawlRate(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse>): void;
20459
+ /**
20460
+ * 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.
20461
+ * @example
20462
+ * ```js
20463
+ * // Before running the sample:
20464
+ * // - Enable the API at:
20465
+ * // https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
20466
+ * // - Login into gcloud by running:
20467
+ * // ```sh
20468
+ * // $ gcloud auth application-default login
20469
+ * // ```
20470
+ * // - Install the npm module by running:
20471
+ * // ```sh
20472
+ * // $ npm install googleapis
20473
+ * // ```
20474
+ *
20475
+ * const {google} = require('googleapis');
20476
+ * const discoveryengine = google.discoveryengine('v1alpha');
20477
+ *
20478
+ * async function main() {
20479
+ * const auth = new google.auth.GoogleAuth({
20480
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
20481
+ * scopes: [
20482
+ * 'https://www.googleapis.com/auth/cloud-platform',
20483
+ * 'https://www.googleapis.com/auth/discoveryengine.readwrite',
20484
+ * 'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
20485
+ * ],
20486
+ * });
20487
+ *
20488
+ * // Acquire an auth client, and bind it to all future calls
20489
+ * const authClient = await auth.getClient();
20490
+ * google.options({auth: authClient});
20491
+ *
20492
+ * // Do the magic
20493
+ * const res = await discoveryengine.projects.locations.provision({
20494
+ * // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
20495
+ * name: 'projects/my-project/locations/my-location',
20496
+ *
20497
+ * // Request body metadata
20498
+ * requestBody: {
20499
+ * // request body parameters
20500
+ * // {
20501
+ * // "acceptDataUseTerms": false,
20502
+ * // "dataUseTermsVersion": "my_dataUseTermsVersion",
20503
+ * // "saasParams": {}
20504
+ * // }
20505
+ * },
20506
+ * });
20507
+ * console.log(res.data);
20508
+ *
20509
+ * // Example response
20510
+ * // {
20511
+ * // "done": false,
20512
+ * // "error": {},
20513
+ * // "metadata": {},
20514
+ * // "name": "my_name",
20515
+ * // "response": {}
20516
+ * // }
20517
+ * }
20518
+ *
20519
+ * main().catch(e => {
20520
+ * console.error(e);
20521
+ * throw e;
20522
+ * });
20523
+ *
20524
+ * ```
20525
+ *
20526
+ * @param params - Parameters for request
20527
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
20528
+ * @param callback - Optional callback that handles the response.
20529
+ * @returns A promise if used with async/await, or void if used with a callback.
20530
+ */
20531
+ provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
20532
+ provision(params?: Params$Resource$Projects$Locations$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
20533
+ provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
20534
+ provision(params: Params$Resource$Projects$Locations$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
20535
+ provision(params: Params$Resource$Projects$Locations$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
20536
+ provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
20443
20537
  /**
20444
20538
  * Queries configurable pricing usage stats for a project.
20445
20539
  * @example
@@ -21101,6 +21195,16 @@ export declare namespace discoveryengine_v1alpha {
21101
21195
  */
21102
21196
  requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest;
21103
21197
  }
21198
+ export interface Params$Resource$Projects$Locations$Provision extends StandardParameters {
21199
+ /**
21200
+ * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
21201
+ */
21202
+ name?: string;
21203
+ /**
21204
+ * Request body metadata
21205
+ */
21206
+ requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest;
21207
+ }
21104
21208
  export interface Params$Resource$Projects$Locations$Queryconfigurablepricingusagestats extends StandardParameters {
21105
21209
  /**
21106
21210
  * 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
  {});