@googleapis/discoveryengine 37.1.0 → 37.2.0

package/build/v1alpha.d.ts

@@ -2378,6 +2378,12 @@ export declare namespace discoveryengine_v1alpha {
          * Reasons for not answering the assist call.
          */
         assistSkippedReasons?: string[] | null;
+        /**
+         * Output only. Maps an internal connector agent name (the machine identifier embedded in tool names, e.g. `custom_mcp__agent`) to the connector's human-readable display name. Populated at serving time for custom MCP / agent gateway connectors so user-facing surfaces (e.g. the tool-call chip) can show the connector name instead of its internal identifier. Empty when there are no such connectors.
+         */
+        connectorDisplayNames?: {
+            [key: string]: string;
+        } | null;
         /**
          * Optional. The field contains information about the various policy checks' results like the banned phrases or the Model Armor checks. This field is populated only if the assist call was skipped due to a policy violation.
          */
@@ -2879,6 +2885,10 @@ export declare namespace discoveryengine_v1alpha {
          * Required. The URI the user is directed to when they need to authorize. Should include everything required for a successful authorization: OAuth ID, extra flags, etc. Example: `https://accounts.google.com/o/oauth2/v2/auth?client_id=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&response_type=code&access_type=offline&prompt=consent` The `redirect_uri` parameter will be overwritten by the Vertex AI Search frontend.
          */
         authorizationUri?: string | null;
+        /**
+         * Optional. Whether the OAuth token exchange uses HTTP Basic authentication (`client_secret_basic`) instead of sending the client credentials in the request body (`client_secret_post`). When `true`, the credentials (`client_id:client_secret`) are Base64 encoded and sent in the `Authorization` header. Some OAuth providers (e.g. Splunk) require `client_secret_basic`. When `false` or unset, the default `client_secret_post` is used.
+         */
+        basicAuthenticationEnabled?: boolean | null;
         /**
          * Required. The OAuth2 client ID.
          */
@@ -3880,7 +3890,7 @@ export declare namespace discoveryengine_v1alpha {
          */
         selectedPosition?: number | null;
         /**
-         * End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
+         * Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
          */
         selectedSuggestion?: string | null;
     }
@@ -4695,7 +4705,7 @@ export declare namespace discoveryengine_v1alpha {
          */
         syncMode?: string | null;
         /**
-         * Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
+         * Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. If the caller omits `tag`, the server auto-derives one from the collection_id (falling back to data_source, else a time-based `t-` sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
          */
         tag?: string | null;
         /**
@@ -6195,6 +6205,10 @@ export declare namespace discoveryengine_v1alpha {
          * Required. The output location of the data.
          */
         outputConfig?: Schema$GoogleCloudDiscoveryengineV1alphaOutputConfig;
+        /**
+         * Optional. The earliest date (inclusive), interpreted in the UTC time zone, whose metrics are included in the export. If unset, defaults to 30 days before the current UTC date. The value must be a valid calendar date that is not in the future and not older than 180 days (the source data retention window); otherwise the request fails with `INVALID_ARGUMENT`.
+         */
+        startDate?: Schema$GoogleTypeDate;
     }
     /**
      * Response of the ExportMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.
@@ -7346,6 +7360,10 @@ export declare namespace discoveryengine_v1alpha {
          * Optional. Whether the license config should be auto renewed when it reaches the end date.
          */
         autoRenew?: boolean | null;
+        /**
+         * Output only. The name of the BillingAccountLicenseConfig from which this LicenseConfig is assigned, if this field is set.
+         */
+        billingAccountLicenseConfig?: string | null;
         /**
          * Output only. Indication of whether the subscription is terminated earlier than the expiration date. This is usually terminated by pipeline once the subscription gets terminated from subsv3.
          */
@@ -9436,7 +9454,7 @@ export declare namespace discoveryengine_v1alpha {
          */
         orderBy?: string | null;
         /**
-         * The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
+         * Optional. The user's search query. See SearchRequest.query for definition. The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. At least one of search_query or PageInfo.page_category is required for `search` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
          */
         searchQuery?: string | null;
     }
@@ -11705,7 +11723,7 @@ export declare namespace discoveryengine_v1alpha {
      */
     export interface Schema$GoogleCloudDiscoveryengineV1alphaUserEvent {
         /**
-         * Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
+         * Optional. Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. If you provide custom attributes for ingested user events, also include them in the user events that you associate with prediction requests. Custom attribute formatting must be consistent between imported events and events provided with prediction requests. This lets the Discovery Engine API use those custom attributes when training models and serving predictions, which helps improve recommendation quality. This field needs to pass all below criteria, otherwise an `INVALID_ARGUMENT` error is returned: * The key must be a UTF-8 encoded string with a length limit of 5,000 characters. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. For product recommendations, an example of extra user information is `traffic_channel`, which is how a user arrives at the site. Users can arrive at the site by coming to the site directly, coming through Google search, or in other ways.
          */
         attributes?: {
             [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaCustomAttribute;
@@ -12206,6 +12224,10 @@ export declare namespace discoveryengine_v1alpha {
          * 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.
          */
         name?: string | null;
+        /**
+         * Output only. The version-independent label of the connector backing this collection, mirroring `DataConnector.tag`. Unlike the version-pinned data store id it survives a connector version upgrade, so an upgraded connector keeps the same tag. Not a unique key. As `DataConnector.tag` documents, several connectors may share a tag under the same (project, location, collection, data_source), and tag-based lookup resolves to the one with the greatest create_time. Clients must not treat this as a connector identifier. Empty when the connector was created before the tag-write launch, and for synthetic placeholder entries, which have no underlying `DataConnector`. Populated only when `ConnectorsFeature.enable_connector_tag` is on.
+         */
+        tag?: string | null;
     }
     /**
      * Read-only connector in CollectionComponent auth state.
@@ -16558,7 +16580,7 @@ export declare namespace discoveryengine_v1alpha {
          */
         syncMode?: string | null;
         /**
-         * Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
+         * Optional. Immutable. User-facing, version-independent label for this connector. May be shared by multiple connectors under the same (project, location, collection, data_source); tag-based lookup returns the one with the greatest create_time. Optional at Create time. If the caller omits `tag`, the server auto-derives one from the collection_id (falling back to data_source, else a time-based `t-` sentinel). The auto-derived tag is subject to the same immutability guarantee as a caller-supplied one, so callers who care about the exact tag value should provide it explicitly rather than relying on the server default. Agent Designer resolves connectors via (data_source, tag) when set, falling back to the legacy resource-name lookup when unset, so connectors created before the tag-write launch continue to work without a backfill.
          */
         tag?: string | null;
         /**
@@ -33965,6 +33987,7 @@ export declare namespace discoveryengine_v1alpha {
         context: APIRequestContext;
         analytics: Resource$Projects$Locations$Collections$Engines$Analytics;
         assistants: Resource$Projects$Locations$Collections$Engines$Assistants;
+        collaborativeProjects: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects;
         completionConfig: Resource$Projects$Locations$Collections$Engines$Completionconfig;
         controls: Resource$Projects$Locations$Collections$Engines$Controls;
         conversations: Resource$Projects$Locations$Collections$Engines$Conversations;
@@ -35283,7 +35306,8 @@ export declare namespace discoveryengine_v1alpha {
          *         requestBody: {
          *           // request body parameters
          *           // {
-         *           //   "outputConfig": {}
+         *           //   "outputConfig": {},
+         *           //   "startDate": {}
          *           // }
          *         },
          *       },
@@ -37242,6 +37266,97 @@ export declare namespace discoveryengine_v1alpha {
          */
         requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCannedQuery;
     }
+    export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects {
+        context: APIRequestContext;
+        knowledgeSpaces: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces;
+        constructor(context: APIRequestContext);
+    }
+    export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces {
+        context: APIRequestContext;
+        operations: Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations;
+        constructor(context: APIRequestContext);
+    }
+    export class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations {
+        context: APIRequestContext;
+        constructor(context: APIRequestContext);
+        /**
+         * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+         * @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('v1alpha');
+         *
+         * 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.collections.engines.collaborativeProjects.knowledgeSpaces.operations.get(
+         *       {
+         *         // The name of the operation resource.
+         *         name: 'projects/my-project/locations/my-location/collections/my-collection/engines/my-engine/collaborativeProjects/my-collaborativeProject/knowledgeSpaces/my-knowledgeSpace/operations/my-operation',
+         *       },
+         *     );
+         *   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.
+         */
+        get(params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
+        get(params?: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
+        get(params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
+        get(params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
+        get(params: Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
+        get(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
+    }
+    export interface Params$Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations$Get extends StandardParameters {
+        /**
+         * The name of the operation resource.
+         */
+        name?: string;
+    }
     export class Resource$Projects$Locations$Collections$Engines$Completionconfig {
         context: APIRequestContext;
         constructor(context: APIRequestContext);
@@ -52181,6 +52296,7 @@ export declare namespace discoveryengine_v1alpha {
          *       // {
          *       //   "alertPolicyResourceConfig": {},
          *       //   "autoRenew": false,
+         *       //   "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
          *       //   "earlyTerminated": false,
          *       //   "earlyTerminationDate": {},
          *       //   "endDate": {},
@@ -52202,6 +52318,7 @@ export declare namespace discoveryengine_v1alpha {
          *   // {
          *   //   "alertPolicyResourceConfig": {},
          *   //   "autoRenew": false,
+         *   //   "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
          *   //   "earlyTerminated": false,
          *   //   "earlyTerminationDate": {},
          *   //   "endDate": {},
@@ -52279,6 +52396,7 @@ export declare namespace discoveryengine_v1alpha {
          *   // {
          *   //   "alertPolicyResourceConfig": {},
          *   //   "autoRenew": false,
+         *   //   "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
          *   //   "earlyTerminated": false,
          *   //   "earlyTerminationDate": {},
          *   //   "endDate": {},
@@ -52429,6 +52547,7 @@ export declare namespace discoveryengine_v1alpha {
          *       // {
          *       //   "alertPolicyResourceConfig": {},
          *       //   "autoRenew": false,
+         *       //   "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
          *       //   "earlyTerminated": false,
          *       //   "earlyTerminationDate": {},
          *       //   "endDate": {},
@@ -52450,6 +52569,7 @@ export declare namespace discoveryengine_v1alpha {
          *   // {
          *   //   "alertPolicyResourceConfig": {},
          *   //   "autoRenew": false,
+         *   //   "billingAccountLicenseConfig": "my_billingAccountLicenseConfig",
          *   //   "earlyTerminated": false,
          *   //   "earlyTerminationDate": {},
          *   //   "endDate": {},

package/build/v1alpha.js

@@ -5391,6 +5391,7 @@ var discoveryengine_v1alpha;
         context;
         analytics;
         assistants;
+        collaborativeProjects;
         completionConfig;
         controls;
         conversations;
@@ -5404,6 +5405,8 @@ var discoveryengine_v1alpha;
                 new Resource$Projects$Locations$Collections$Engines$Analytics(this.context);
             this.assistants =
                 new Resource$Projects$Locations$Collections$Engines$Assistants(this.context);
+            this.collaborativeProjects =
+                new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects(this.context);
             this.completionConfig =
                 new Resource$Projects$Locations$Collections$Engines$Completionconfig(this.context);
             this.controls =
@@ -6597,6 +6600,66 @@ var discoveryengine_v1alpha;
         }
     }
     discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries = Resource$Projects$Locations$Collections$Engines$Assistants$Cannedqueries;
+    class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects {
+        context;
+        knowledgeSpaces;
+        constructor(context) {
+            this.context = context;
+            this.knowledgeSpaces =
+                new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces(this.context);
+        }
+    }
+    discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Collaborativeprojects = Resource$Projects$Locations$Collections$Engines$Collaborativeprojects;
+    class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces {
+        context;
+        operations;
+        constructor(context) {
+            this.context = context;
+            this.operations =
+                new Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations(this.context);
+        }
+    }
+    discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces = Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces;
+    class Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations {
+        context;
+        constructor(context) {
+            this.context = context;
+        }
+        get(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 + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'),
+                    method: 'GET',
+                    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);
+            }
+        }
+    }
+    discoveryengine_v1alpha.Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations = Resource$Projects$Locations$Collections$Engines$Collaborativeprojects$Knowledgespaces$Operations;
     class Resource$Projects$Locations$Collections$Engines$Completionconfig {
         context;
         constructor(context) {