@googleapis/discoveryengine 31.0.0 → 32.1.0

package/build/v1beta.d.ts

@@ -1418,6 +1418,10 @@ export declare namespace discoveryengine_v1beta {
          * Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
          */
         verdict?: string | null;
+        /**
+         * Output only. The source of the violation.
+         */
+        violationSource?: string | null;
     }
     /**
      * Customer policy enforcement result for the banned phrase policy.
@@ -2471,13 +2475,9 @@ export declare namespace discoveryengine_v1beta {
         vpcscEnabled?: boolean | null;
     }
     /**
-     * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
+     * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
      */
     export interface Schema$GoogleCloudDiscoveryengineV1alphaDataConnectorConnectorMetadata {
-        /**
-         * 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.
-         */
-        authenticatedAccount?: string | null;
         /**
          * 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).
          */
@@ -3317,7 +3317,7 @@ export declare namespace discoveryengine_v1beta {
          */
         displayName?: string | null;
         /**
-         * 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`
+         * 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`
          */
         features?: {
             [key: string]: string;
@@ -7643,6 +7643,10 @@ export declare namespace discoveryengine_v1beta {
          * Final verdict of the customer policy enforcement. If only one policy blocked the processing, the verdict is BLOCK.
          */
         verdict?: string | null;
+        /**
+         * Output only. The source of the violation.
+         */
+        violationSource?: string | null;
     }
     /**
      * Customer policy enforcement result for the banned phrase policy.
@@ -8155,7 +8159,7 @@ export declare namespace discoveryengine_v1beta {
          */
         deleteUnassignedUserLicenses?: boolean | null;
         /**
-         * The inline source for the input content for document embeddings.
+         * The inline source for the input content for license assignment.
          */
         inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaBatchUpdateUserLicensesRequestInlineSource;
     }
@@ -9896,7 +9900,7 @@ export declare namespace discoveryengine_v1beta {
          */
         displayName?: string | null;
         /**
-         * 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`
+         * 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`
          */
         features?: {
             [key: string]: string;
@@ -12976,7 +12980,7 @@ export declare namespace discoveryengine_v1beta {
      */
     export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponse {
         /**
-         * Controls applied as part of the Control service.
+         * Optional. Controls applied as part of the Control service.
          */
         appliedControls?: string[] | null;
         /**
@@ -13306,6 +13310,10 @@ export declare namespace discoveryengine_v1beta {
          * Optional. A set of ranking signals associated with the result.
          */
         rankSignals?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRankSignals;
+        /**
+         * Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds.
+         */
+        retrievalSignals?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRetrievalSignals;
     }
     /**
      * A set of ranking signals.
@@ -13365,6 +13373,19 @@ export declare namespace discoveryengine_v1beta {
          */
         value?: number | null;
     }
+    /**
+     * Contains a set of signals used by the relevance filter.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResultRetrievalSignals {
+        /**
+         * Optional. Indicates how the result was retrieved.
+         */
+        retrievalSources?: string[] | null;
+        /**
+         * Optional. Relevance score used by the filter when semantic_relevance_threshold is set.
+         */
+        semanticRelevanceScore?: number | null;
+    }
     /**
      * Information about the session.
      */
@@ -14982,13 +15003,9 @@ export declare namespace discoveryengine_v1beta {
         vpcscEnabled?: boolean | null;
     }
     /**
-     * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, authenticated_account, note).
+     * User-facing metadata for the connector, shown on the connector detail page (title, description, short_description, author, note).
      */
     export interface Schema$GoogleCloudDiscoveryengineV1DataConnectorConnectorMetadata {
-        /**
-         * 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.
-         */
-        authenticatedAccount?: string | null;
         /**
          * 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).
          */
@@ -15725,7 +15742,7 @@ export declare namespace discoveryengine_v1beta {
          */
         displayName?: string | null;
         /**
-         * 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`
+         * 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`
          */
         features?: {
             [key: string]: string;
@@ -17963,6 +17980,84 @@ export declare namespace discoveryengine_v1beta {
         obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, options: MethodOptions | BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>): void;
         obtainCrawlRate(params: Params$Resource$Projects$Locations$Obtaincrawlrate, callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>): void;
         obtainCrawlRate(callback: BodyResponseCallback<Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateResponse>): void;
+        /**
+         * 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.
+         * @example
+         * ```js
+         * // Before running the sample:
+         * // - Enable the API at:
+         * //   https://console.developers.google.com/apis/api/discoveryengine.googleapis.com
+         * // - Login into gcloud by running:
+         * //   ```sh
+         * //   $ gcloud auth application-default login
+         * //   ```
+         * // - Install the npm module by running:
+         * //   ```sh
+         * //   $ npm install googleapis
+         * //   ```
+         *
+         * const {google} = require('googleapis');
+         * const discoveryengine = google.discoveryengine('v1beta');
+         *
+         * async function main() {
+         *   const auth = new google.auth.GoogleAuth({
+         *     // Scopes can be specified either as an array or as a single, space-delimited string.
+         *     scopes: [
+         *       'https://www.googleapis.com/auth/cloud-platform',
+         *       'https://www.googleapis.com/auth/discoveryengine.readwrite',
+         *       'https://www.googleapis.com/auth/discoveryengine.serving.readwrite',
+         *     ],
+         *   });
+         *
+         *   // Acquire an auth client, and bind it to all future calls
+         *   const authClient = await auth.getClient();
+         *   google.options({auth: authClient});
+         *
+         *   // Do the magic
+         *   const res = await discoveryengine.projects.locations.provision({
+         *     // Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
+         *     name: 'projects/my-project/locations/my-location',
+         *
+         *     // Request body metadata
+         *     requestBody: {
+         *       // request body parameters
+         *       // {
+         *       //   "acceptDataUseTerms": false,
+         *       //   "dataUseTermsVersion": "my_dataUseTermsVersion",
+         *       //   "saasParams": {}
+         *       // }
+         *     },
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "done": false,
+         *   //   "error": {},
+         *   //   "metadata": {},
+         *   //   "name": "my_name",
+         *   //   "response": {}
+         *   // }
+         * }
+         *
+         * main().catch(e => {
+         *   console.error(e);
+         *   throw e;
+         * });
+         *
+         * ```
+         *
+         * @param params - Parameters for request
+         * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+         * @param callback - Optional callback that handles the response.
+         * @returns A promise if used with async/await, or void if used with a callback.
+         */
+        provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        provision(params?: Params$Resource$Projects$Locations$Provision, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
+        provision(params: Params$Resource$Projects$Locations$Provision, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        provision(params: Params$Resource$Projects$Locations$Provision, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
+        provision(params: Params$Resource$Projects$Locations$Provision, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
+        provision(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
         /**
          * 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.
          * @example
@@ -18302,6 +18397,16 @@ export declare namespace discoveryengine_v1beta {
          */
         requestBody?: Schema$GoogleCloudDiscoveryengineV1betaObtainCrawlRateRequest;
     }
+    export interface Params$Resource$Projects$Locations$Provision extends StandardParameters {
+        /**
+         * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`.
+         */
+        name?: string;
+        /**
+         * Request body metadata
+         */
+        requestBody?: Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest;
+    }
     export interface Params$Resource$Projects$Locations$Removededicatedcrawlrate extends StandardParameters {
         /**
          * Required. The location resource where crawl rate management will be performed. Format: `projects/{project\}/locations/{location\}`

package/build/v1beta.js

@@ -302,6 +302,38 @@ var discoveryengine_v1beta;
                 return (0, googleapis_common_1.createAPIRequest)(parameters);
             }
         }
+        provision(paramsOrCallback, optionsOrCallback, callback) {
+            let params = (paramsOrCallback ||
+                {});
+            let options = (optionsOrCallback || {});
+            if (typeof paramsOrCallback === 'function') {
+                callback = paramsOrCallback;
+                params = {};
+                options = {};
+            }
+            if (typeof optionsOrCallback === 'function') {
+                callback = optionsOrCallback;
+                options = {};
+            }
+            const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/';
+            const parameters = {
+                options: Object.assign({
+                    url: (rootUrl + '/v1beta/{+name}:provision').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'POST',
+                    apiVersion: '',
+                }, options),
+                params,
+                requiredParams: ['name'],
+                pathParams: ['name'],
+                context: this.context,
+            };
+            if (callback) {
+                (0, googleapis_common_1.createAPIRequest)(parameters, callback);
+            }
+            else {
+                return (0, googleapis_common_1.createAPIRequest)(parameters);
+            }
+        }
         removeDedicatedCrawlRate(paramsOrCallback, optionsOrCallback, callback) {
             let params = (paramsOrCallback ||
                 {});