@googleapis/discoveryengine 32.0.0 → 33.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@googleapis/discoveryengine",
-  "version": "32.0.0",
+  "version": "33.0.0",
   "description": "discoveryengine",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/v1.ts

@@ -2316,6 +2316,10 @@ export namespace discoveryengine_v1 {
      * 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.
@@ -2488,6 +2492,10 @@ export namespace discoveryengine_v1 {
    * Referenced content and related document metadata.
    */
   export interface Schema$GoogleCloudDiscoveryengineV1alphaAssistantGroundedContentTextGroundingMetadataReference {
+    /**
+     * Output only. Generic structured chunk metadata from upstream data source connectors.
+     */
+    chunkMetadata?: {[key: string]: any} | null;
     /**
      * Chunk of code snippet from the referenced document.
      */
@@ -4189,7 +4197,7 @@ export namespace discoveryengine_v1 {
      */
     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` * `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`
+     * 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} | null;
     /**
@@ -7870,6 +7878,10 @@ export namespace discoveryengine_v1 {
      * 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.
@@ -8162,6 +8174,10 @@ export namespace discoveryengine_v1 {
    * Referenced content and related document metadata.
    */
   export interface Schema$GoogleCloudDiscoveryengineV1AssistantGroundedContentTextGroundingMetadataReference {
+    /**
+     * Output only. Generic structured chunk metadata from upstream data source connectors.
+     */
+    chunkMetadata?: {[key: string]: any} | null;
     /**
      * Chunk of code snippet from the referenced document.
      */
@@ -9397,7 +9413,7 @@ export namespace discoveryengine_v1 {
      */
     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` * `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`
+     * 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} | null;
     /**
@@ -13513,7 +13529,7 @@ export namespace discoveryengine_v1 {
      */
     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` * `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`
+     * 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} | null;
     /**
@@ -15576,6 +15592,10 @@ export namespace discoveryengine_v1 {
      * Optional. The backend to use for the ranking expression evaluation.
      */
     rankingExpressionBackend?: string | null;
+    /**
+     * Optional. The granular relevance filtering specification. If not specified, the global `relevance_threshold` will be used for all sub-searches. If specified, this overrides the global `relevance_threshold` to use thresholds on a per sub-search basis. This feature is currently supported only for custom and site search.
+     */
+    relevanceFilterSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpec;
     /**
      * Optional. The specification for returning the relevance score.
      */
@@ -15977,6 +15997,32 @@ export namespace discoveryengine_v1 {
      */
     pinUnexpandedResults?: boolean | null;
   }
+  /**
+   * Relevance filtering specification.
+   */
+  export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpec {
+    /**
+     * Optional. Relevance filtering threshold specification for keyword search.
+     */
+    keywordSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
+    /**
+     * Optional. Relevance filtering threshold specification for semantic search.
+     */
+    semanticSearchThreshold?: Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec;
+  }
+  /**
+   * Specification for relevance filtering on a specific sub-search.
+   */
+  export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestRelevanceFilterSpecRelevanceThresholdSpec {
+    /**
+     * Pre-defined relevance threshold for the sub-search.
+     */
+    relevanceThreshold?: string | null;
+    /**
+     * Custom relevance threshold for the sub-search. The value must be in [0.0, 1.0].
+     */
+    semanticRelevanceThreshold?: number | null;
+  }
   /**
    * The specification for returning the document relevance score.
    */
@@ -16021,6 +16067,10 @@ export namespace discoveryengine_v1 {
    * Response message for SearchService.Search method.
    */
   export interface Schema$GoogleCloudDiscoveryengineV1SearchResponse {
+    /**
+     * Optional. Controls applied as part of the Control service.
+     */
+    appliedControls?: string[] | null;
     /**
      * A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.
      */
@@ -16283,6 +16333,10 @@ export namespace discoveryengine_v1 {
      * Optional. A set of ranking signals associated with the result.
      */
     rankSignals?: Schema$GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals;
+    /**
+     * Optional. A set of signals used by the relevance filter meant for use to fine-tune the relevance filter thresholds.
+     */
+    retrievalSignals?: Schema$GoogleCloudDiscoveryengineV1SearchResponseSearchResultRetrievalSignals;
   }
   /**
    * A set of ranking signals.
@@ -16342,6 +16396,19 @@ export namespace discoveryengine_v1 {
      */
     value?: number | null;
   }
+  /**
+   * Contains a set of signals used by the relevance filter.
+   */
+  export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseSearchResultRetrievalSignals {
+    /**
+     * 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.
    */
@@ -16766,6 +16833,10 @@ export namespace discoveryengine_v1 {
    * Request for the AssistantService.StreamAssist method.
    */
   export interface Schema$GoogleCloudDiscoveryengineV1StreamAssistRequest {
+    /**
+     * Optional. Specification of agents that are used to serve the request.
+     */
+    agentsSpec?: Schema$GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpec;
     /**
      * Optional. Specification of the generation configuration for the request.
      */
@@ -16787,6 +16858,24 @@ export namespace discoveryengine_v1 {
      */
     userMetadata?: Schema$GoogleCloudDiscoveryengineV1AssistUserMetadata;
   }
+  /**
+   * Specification of agents that are used to serve the request.
+   */
+  export interface Schema$GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpec {
+    /**
+     * Optional. Specification of agents that are used to serve the request.
+     */
+    agentSpecs?: Schema$GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpecAgentSpec[];
+  }
+  /**
+   * Specification of an agent.
+   */
+  export interface Schema$GoogleCloudDiscoveryengineV1StreamAssistRequestAgentsSpecAgentSpec {
+    /**
+     * Required. ID to identify the agent resource serving the request. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.
+     */
+    agentId?: string | null;
+  }
   /**
    * Assistant generation specification for the request. This allows to override the default generation configuration at the engine level.
    */
@@ -17620,7 +17709,7 @@ export namespace discoveryengine_v1 {
      */
     id?: string | null;
     /**
-     * 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`.
+     * 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.
      */
     isFirstParty?: boolean | null;
     /**
@@ -17856,7 +17945,7 @@ export namespace discoveryengine_v1 {
      */
     enableVisualContentSummary?: boolean | null;
     /**
-     * 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`
+     * 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`
      */
     features?: {[key: string]: string} | null;
     /**
@@ -17974,10 +18063,18 @@ export namespace discoveryengine_v1 {
      * Output only. Whether the model is currently in preview. Clients should surface this via a "Preview" badge in the selector UI.
      */
     isPreview?: boolean | null;
+    /**
+     * 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.
+     */
+    label?: string | null;
     /**
      * 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.
      */
     modelId?: string | null;
+    /**
+     * Output only. Whether this model should be promoted in the GE chat homepage banner.
+     */
+    promoted?: boolean | null;
   }
   /**
    * Admin-surface metadata. Populated only when the request originates from the Cloud Console admin "Feature Control" page; left unset for end-user surfaces (Web, Mobile). Lets the admin page render its toggle table directly from the backend instead of a hardcoded client-side registry.
@@ -31486,6 +31583,7 @@ export namespace discoveryengine_v1 {
      *           //   "queryExpansionSpec": {},
      *           //   "rankingExpression": "my_rankingExpression",
      *           //   "rankingExpressionBackend": "my_rankingExpressionBackend",
+     *           //   "relevanceFilterSpec": {},
      *           //   "relevanceScoreSpec": {},
      *           //   "relevanceThreshold": "my_relevanceThreshold",
      *           //   "safeSearch": false,
@@ -31504,6 +31602,7 @@ export namespace discoveryengine_v1 {
      *
      *   // Example response
      *   // {
+     *   //   "appliedControls": [],
      *   //   "attributionToken": "my_attributionToken",
      *   //   "correctedQuery": "my_correctedQuery",
      *   //   "facets": [],
@@ -31699,6 +31798,7 @@ export namespace discoveryengine_v1 {
      *           //   "queryExpansionSpec": {},
      *           //   "rankingExpression": "my_rankingExpression",
      *           //   "rankingExpressionBackend": "my_rankingExpressionBackend",
+     *           //   "relevanceFilterSpec": {},
      *           //   "relevanceScoreSpec": {},
      *           //   "relevanceThreshold": "my_relevanceThreshold",
      *           //   "safeSearch": false,
@@ -31717,6 +31817,7 @@ export namespace discoveryengine_v1 {
      *
      *   // Example response
      *   // {
+     *   //   "appliedControls": [],
      *   //   "attributionToken": "my_attributionToken",
      *   //   "correctedQuery": "my_correctedQuery",
      *   //   "facets": [],
@@ -40185,6 +40286,7 @@ export namespace discoveryengine_v1 {
      *         requestBody: {
      *           // request body parameters
      *           // {
+     *           //   "agentsSpec": {},
      *           //   "generationSpec": {},
      *           //   "query": {},
      *           //   "session": "my_session",
@@ -46314,6 +46416,7 @@ export namespace discoveryengine_v1 {
      *           //   "queryExpansionSpec": {},
      *           //   "rankingExpression": "my_rankingExpression",
      *           //   "rankingExpressionBackend": "my_rankingExpressionBackend",
+     *           //   "relevanceFilterSpec": {},
      *           //   "relevanceScoreSpec": {},
      *           //   "relevanceThreshold": "my_relevanceThreshold",
      *           //   "safeSearch": false,
@@ -46332,6 +46435,7 @@ export namespace discoveryengine_v1 {
      *
      *   // Example response
      *   // {
+     *   //   "appliedControls": [],
      *   //   "attributionToken": "my_attributionToken",
      *   //   "correctedQuery": "my_correctedQuery",
      *   //   "facets": [],
@@ -46527,6 +46631,7 @@ export namespace discoveryengine_v1 {
      *           //   "queryExpansionSpec": {},
      *           //   "rankingExpression": "my_rankingExpression",
      *           //   "rankingExpressionBackend": "my_rankingExpressionBackend",
+     *           //   "relevanceFilterSpec": {},
      *           //   "relevanceScoreSpec": {},
      *           //   "relevanceThreshold": "my_relevanceThreshold",
      *           //   "safeSearch": false,
@@ -46545,6 +46650,7 @@ export namespace discoveryengine_v1 {
      *
      *   // Example response
      *   // {
+     *   //   "appliedControls": [],
      *   //   "attributionToken": "my_attributionToken",
      *   //   "correctedQuery": "my_correctedQuery",
      *   //   "facets": [],
@@ -57568,6 +57674,7 @@ export namespace discoveryengine_v1 {
      *         //   "queryExpansionSpec": {},
      *         //   "rankingExpression": "my_rankingExpression",
      *         //   "rankingExpressionBackend": "my_rankingExpressionBackend",
+     *         //   "relevanceFilterSpec": {},
      *         //   "relevanceScoreSpec": {},
      *         //   "relevanceThreshold": "my_relevanceThreshold",
      *         //   "safeSearch": false,
@@ -57585,6 +57692,7 @@ export namespace discoveryengine_v1 {
      *
      *   // Example response
      *   // {
+     *   //   "appliedControls": [],
      *   //   "attributionToken": "my_attributionToken",
      *   //   "correctedQuery": "my_correctedQuery",
      *   //   "facets": [],
@@ -57780,6 +57888,7 @@ export namespace discoveryengine_v1 {
      *           //   "queryExpansionSpec": {},
      *           //   "rankingExpression": "my_rankingExpression",
      *           //   "rankingExpressionBackend": "my_rankingExpressionBackend",
+     *           //   "relevanceFilterSpec": {},
      *           //   "relevanceScoreSpec": {},
      *           //   "relevanceThreshold": "my_relevanceThreshold",
      *           //   "safeSearch": false,
@@ -57798,6 +57907,7 @@ export namespace discoveryengine_v1 {
      *
      *   // Example response
      *   // {
+     *   //   "appliedControls": [],
      *   //   "attributionToken": "my_attributionToken",
      *   //   "correctedQuery": "my_correctedQuery",
      *   //   "facets": [],