@googleapis/discoveryengine 37.0.0 → 37.2.0

package/build/v1.d.ts

@@ -2297,6 +2297,12 @@ export declare namespace discoveryengine_v1 {
          * 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.
          */
@@ -3376,7 +3382,7 @@ export declare namespace discoveryengine_v1 {
          */
         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;
         /**
@@ -5018,6 +5024,10 @@ export declare namespace discoveryengine_v1 {
          * 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.
          */
@@ -5287,6 +5297,10 @@ export declare namespace discoveryengine_v1 {
          * Optional. Configuration for NotebookLM settings.
          */
         notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigNotebooklmConfig;
+        /**
+         * Optional. Resource-level access control config for Gemini Enterprise users.
+         */
+        resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig;
     }
     /**
      * Configuration for NotebookLM.
@@ -5340,6 +5354,15 @@ export declare namespace discoveryengine_v1 {
          */
         userPromptTemplate?: string | null;
     }
+    /**
+     * Controls resource-level access control for Gemini Enterprise users.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1alphaProjectCustomerProvidedConfigResourceAccessControlConfig {
+        /**
+         * Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
+         */
+        dataStoreAccessControlEnabled?: boolean | null;
+    }
     /**
      * Metadata about the terms of service.
      */
@@ -5585,6 +5608,10 @@ export declare namespace discoveryengine_v1 {
          * This field is expected to be a ui message in JSON format. As of Q1 2026, ui_json_payload is only supported for A2UI messages.
          */
         uiJsonPayload?: string | null;
+        /**
+         * Reference to a user-supplied file attached to a long-running-agent (Sobi) task. See `UserSuppliedSobiArtifactReference` above.
+         */
+        userSuppliedSobiArtifactReference?: Schema$GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference;
     }
     /**
      * Represents a document reference.
@@ -5677,6 +5704,19 @@ export declare namespace discoveryengine_v1 {
          */
         personId?: string | null;
     }
+    /**
+     * Reference to a user-supplied file attached to a long-running-agent (Sobi) task. Rendered by the client as an attachment chip on the user turn's bubble. The file itself is stored on the task's `AgentArtifact` list; the client resolves full metadata (source URI, size, ...) for download or preview by calling `GetTask` on the Sobi Task API and matching `AgentArtifact.name` against `file_name`. Only `file_name` and `mime_type` appear on this wire deliberately: the backing `gs://` or Drive URI is not exposed to conversation-history readers. Same variant is used for both byte-uploaded and Drive-picked files -- "user attached a file" is one concept regardless of source.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1alphaQueryPartUserSuppliedSobiArtifactReference {
+        /**
+         * Required. Client-supplied filename. Unique per task within the user-supplied artifact set (UI dedupes before upload). Doubles as the artifact identifier used to look up the artifact on `Task.artifacts`. The `_name` suffix is deliberate and the AIP-122 lint is suppressed: this field is not a resource name (which is what AIP-122 reserves the bare `name` for). It is the literal filename, and it serves as the join key against `AgentArtifact.name` on the backing Sobi task -- a structural role that `title` or `display_name` would not communicate to a client picking what to send. The internal mirror (`cloud/ml/discoveryengine/schema/assistant.proto`) uses the same field name so the round-trip converter stays name-for-name.
+         */
+        fileName?: string | null;
+        /**
+         * Optional. IANA MIME type. Used for icon/preview rendering.
+         */
+        mimeType?: string | null;
+    }
     /**
      * Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.
      */
@@ -6564,6 +6604,27 @@ export declare namespace discoveryengine_v1 {
          * The condition under which search as you type should occur. Default to Condition.DISABLED.
          */
         condition?: string | null;
+        /**
+         * Optional. The list of fields to be used for Search As You Type scoring.
+         */
+        fields?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField[];
+        /**
+         * Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
+         */
+        scoreThreshold?: number | null;
+    }
+    /**
+     * A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpecField {
+        /**
+         * Required. A field key that has been indexed for Search As You Type.
+         */
+        key?: string | null;
+        /**
+         * Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
+         */
+        weight?: number | null;
     }
     /**
      * Session specification.
@@ -7941,6 +8002,12 @@ export declare namespace discoveryengine_v1 {
          * 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.
          */
@@ -10359,6 +10426,10 @@ export declare namespace discoveryengine_v1 {
          * Optional. Configuration for NotebookLM settings.
          */
         notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigNotebooklmConfig;
+        /**
+         * Optional. Resource-level access control config for Gemini Enterprise users.
+         */
+        resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig;
     }
     /**
      * Configuration for NotebookLM.
@@ -10412,6 +10483,15 @@ export declare namespace discoveryengine_v1 {
          */
         userPromptTemplate?: string | null;
     }
+    /**
+     * Controls resource-level access control for Gemini Enterprise users.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1betaProjectCustomerProvidedConfigResourceAccessControlConfig {
+        /**
+         * Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
+         */
+        dataStoreAccessControlEnabled?: boolean | null;
+    }
     /**
      * Metadata about the terms of service.
      */
@@ -11267,6 +11347,27 @@ export declare namespace discoveryengine_v1 {
          * The condition under which search as you type should occur. Default to Condition.DISABLED.
          */
         condition?: string | null;
+        /**
+         * Optional. The list of fields to be used for Search As You Type scoring.
+         */
+        fields?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField[];
+        /**
+         * Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
+         */
+        scoreThreshold?: number | null;
+    }
+    /**
+     * A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpecField {
+        /**
+         * Required. A field key that has been indexed for Search As You Type.
+         */
+        key?: string | null;
+        /**
+         * Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
+         */
+        weight?: number | null;
     }
     /**
      * Session specification.
@@ -12126,7 +12227,7 @@ export declare namespace discoveryengine_v1 {
          */
         selectedPosition?: number | null;
         /**
-         * End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
+         * Optional. End user selected CompleteQueryResponse.QuerySuggestion.suggestion.
          */
         selectedSuggestion?: string | null;
     }
@@ -12790,7 +12891,7 @@ export declare namespace discoveryengine_v1 {
          */
         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;
         /**
@@ -15151,6 +15252,10 @@ export declare namespace discoveryengine_v1 {
          * Optional. Configuration for NotebookLM settings.
          */
         notebooklmConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigNotebooklmConfig;
+        /**
+         * Optional. Resource-level access control config for Gemini Enterprise users.
+         */
+        resourceAccessControlConfig?: Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig;
     }
     /**
      * Configuration for NotebookLM.
@@ -15204,6 +15309,15 @@ export declare namespace discoveryengine_v1 {
          */
         userPromptTemplate?: string | null;
     }
+    /**
+     * Controls resource-level access control for Gemini Enterprise users.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1ProjectCustomerProvidedConfigResourceAccessControlConfig {
+        /**
+         * Optional. If `true`, the data stores and data connectors shown to Gemini Enterprise users are filtered to those the user has the required resource-level `.get` IAM permission on.
+         */
+        dataStoreAccessControlEnabled?: boolean | null;
+    }
     /**
      * Metadata about the terms of service.
      */
@@ -15702,7 +15816,7 @@ export declare namespace discoveryengine_v1 {
          */
         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;
     }
@@ -16316,6 +16430,27 @@ export declare namespace discoveryengine_v1 {
          * The condition under which search as you type should occur. Default to Condition.DISABLED.
          */
         condition?: string | null;
+        /**
+         * Optional. The list of fields to be used for Search As You Type scoring.
+         */
+        fields?: Schema$GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpecField[];
+        /**
+         * Optional. Search As You Type score threshold for filtering purpose. We keep the result if `score` \>= `score_threshold`.
+         */
+        scoreThreshold?: number | null;
+    }
+    /**
+     * A schema field to be used for Search As You Type scoring on this request. Overrides any data-store-level Search As You Type field configuration for the duration of the request.
+     */
+    export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpecField {
+        /**
+         * Required. A field key that has been indexed for Search As You Type.
+         */
+        key?: string | null;
+        /**
+         * Optional. Weight for scores from this field. Defaults to 1.0 if not specified.
+         */
+        weight?: number | null;
     }
     /**
      * Session specification.
@@ -17560,7 +17695,7 @@ export declare namespace discoveryengine_v1 {
      */
     export interface Schema$GoogleCloudDiscoveryengineV1UserEvent {
         /**
-         * 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$GoogleCloudDiscoveryengineV1CustomAttribute;
@@ -18024,6 +18159,10 @@ export declare namespace discoveryengine_v1 {
          * 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.
@@ -18373,6 +18512,10 @@ export declare namespace discoveryengine_v1 {
          * Output only. Localized display name of the model (e.g. `Gemini 3.1 Pro`). Localized server-side based on the LookupWidgetConfigRequest.language_code and LookupWidgetConfigRequest.region_code of the request.
          */
         displayName?: string | null;
+        /**
+         * Output only. Groups models that render together in the selector. Models sharing a value form one group; empty means the model belongs to no group. Compared for equality only -- never parsed, and never shown to a user, so it is not localized.
+         */
+        family?: string | null;
         /**
          * Output only. GM3-compatible icon token associated with the model (e.g. `rocket_launch`, `bolt`, `graph_5`).
          */