feat: Added phish filtering feature.

PiperOrigin-RevId: 826528945

Author: BenjaminKazemi

api-report/genai-node.api.md

@@ -888,6 +888,7 @@ export enum EndSensitivity {
 
 // @public
 export interface EnterpriseWebSearch {
+    blockingConfidence?: PhishBlockThreshold;
     excludeDomains?: string[];
 }
 
@@ -1492,6 +1493,7 @@ export interface GoogleRpcStatus {
 
 // @public
 export interface GoogleSearch {
+    blockingConfidence?: PhishBlockThreshold;
     excludeDomains?: string[];
     timeRangeFilter?: Interval;
 }
@@ -2413,6 +2415,17 @@ export enum PersonGeneration {
     DONT_ALLOW = "DONT_ALLOW"
 }
 
+// @public
+export enum PhishBlockThreshold {
+    BLOCK_HIGH_AND_ABOVE = "BLOCK_HIGH_AND_ABOVE",
+    BLOCK_HIGHER_AND_ABOVE = "BLOCK_HIGHER_AND_ABOVE",
+    BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
+    BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
+    BLOCK_ONLY_EXTREMELY_HIGH = "BLOCK_ONLY_EXTREMELY_HIGH",
+    BLOCK_VERY_HIGH_AND_ABOVE = "BLOCK_VERY_HIGH_AND_ABOVE",
+    PHISH_BLOCK_THRESHOLD_UNSPECIFIED = "PHISH_BLOCK_THRESHOLD_UNSPECIFIED"
+}
+
 // @public
 export interface PrebuiltVoiceConfig {
     voiceName?: string;

api-report/genai-web.api.md

@@ -888,6 +888,7 @@ export enum EndSensitivity {
 
 // @public
 export interface EnterpriseWebSearch {
+    blockingConfidence?: PhishBlockThreshold;
     excludeDomains?: string[];
 }
 
@@ -1492,6 +1493,7 @@ export interface GoogleRpcStatus {
 
 // @public
 export interface GoogleSearch {
+    blockingConfidence?: PhishBlockThreshold;
     excludeDomains?: string[];
     timeRangeFilter?: Interval;
 }
@@ -2413,6 +2415,17 @@ export enum PersonGeneration {
     DONT_ALLOW = "DONT_ALLOW"
 }
 
+// @public
+export enum PhishBlockThreshold {
+    BLOCK_HIGH_AND_ABOVE = "BLOCK_HIGH_AND_ABOVE",
+    BLOCK_HIGHER_AND_ABOVE = "BLOCK_HIGHER_AND_ABOVE",
+    BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
+    BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
+    BLOCK_ONLY_EXTREMELY_HIGH = "BLOCK_ONLY_EXTREMELY_HIGH",
+    BLOCK_VERY_HIGH_AND_ABOVE = "BLOCK_VERY_HIGH_AND_ABOVE",
+    PHISH_BLOCK_THRESHOLD_UNSPECIFIED = "PHISH_BLOCK_THRESHOLD_UNSPECIFIED"
+}
+
 // @public
 export interface PrebuiltVoiceConfig {
     voiceName?: string;

api-report/genai.api.md

@@ -888,6 +888,7 @@ export enum EndSensitivity {
 
 // @public
 export interface EnterpriseWebSearch {
+    blockingConfidence?: PhishBlockThreshold;
     excludeDomains?: string[];
 }
 
@@ -1492,6 +1493,7 @@ export interface GoogleRpcStatus {
 
 // @public
 export interface GoogleSearch {
+    blockingConfidence?: PhishBlockThreshold;
     excludeDomains?: string[];
     timeRangeFilter?: Interval;
 }
@@ -2413,6 +2415,17 @@ export enum PersonGeneration {
     DONT_ALLOW = "DONT_ALLOW"
 }
 
+// @public
+export enum PhishBlockThreshold {
+    BLOCK_HIGH_AND_ABOVE = "BLOCK_HIGH_AND_ABOVE",
+    BLOCK_HIGHER_AND_ABOVE = "BLOCK_HIGHER_AND_ABOVE",
+    BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
+    BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
+    BLOCK_ONLY_EXTREMELY_HIGH = "BLOCK_ONLY_EXTREMELY_HIGH",
+    BLOCK_VERY_HIGH_AND_ABOVE = "BLOCK_VERY_HIGH_AND_ABOVE",
+    PHISH_BLOCK_THRESHOLD_UNSPECIFIED = "PHISH_BLOCK_THRESHOLD_UNSPECIFIED"
+}
+
 // @public
 export interface PrebuiltVoiceConfig {
     voiceName?: string;

src/converters/_batches_converters.ts

@@ -1253,6 +1253,12 @@ export function googleSearchToMldev(
     throw new Error('excludeDomains parameter is not supported in Gemini API.');
   }
 
+  if (common.getValueByPath(fromObject, ['blockingConfidence']) !== undefined) {
+    throw new Error(
+      'blockingConfidence parameter is not supported in Gemini API.',
+    );
+  }
+
   const fromTimeRangeFilter = common.getValueByPath(fromObject, [
     'timeRangeFilter',
   ]);

src/converters/_caches_converters.ts

@@ -442,6 +442,12 @@ export function googleSearchToMldev(
     throw new Error('excludeDomains parameter is not supported in Gemini API.');
   }
 
+  if (common.getValueByPath(fromObject, ['blockingConfidence']) !== undefined) {
+    throw new Error(
+      'blockingConfidence parameter is not supported in Gemini API.',
+    );
+  }
+
   const fromTimeRangeFilter = common.getValueByPath(fromObject, [
     'timeRangeFilter',
   ]);

src/converters/_live_converters.ts

@@ -332,6 +332,12 @@ export function googleSearchToMldev(
     throw new Error('excludeDomains parameter is not supported in Gemini API.');
   }
 
+  if (common.getValueByPath(fromObject, ['blockingConfidence']) !== undefined) {
+    throw new Error(
+      'blockingConfidence parameter is not supported in Gemini API.',
+    );
+  }
+
   const fromTimeRangeFilter = common.getValueByPath(fromObject, [
     'timeRangeFilter',
   ]);

src/converters/_models_converters.ts

@@ -3177,6 +3177,12 @@ export function googleSearchToMldev(
     throw new Error('excludeDomains parameter is not supported in Gemini API.');
   }
 
+  if (common.getValueByPath(fromObject, ['blockingConfidence']) !== undefined) {
+    throw new Error(
+      'blockingConfidence parameter is not supported in Gemini API.',
+    );
+  }
+
   const fromTimeRangeFilter = common.getValueByPath(fromObject, [
     'timeRangeFilter',
   ]);

src/converters/_tokens_converters.ts

@@ -186,6 +186,12 @@ export function googleSearchToMldev(
     throw new Error('excludeDomains parameter is not supported in Gemini API.');
   }
 
+  if (common.getValueByPath(fromObject, ['blockingConfidence']) !== undefined) {
+    throw new Error(
+      'blockingConfidence parameter is not supported in Gemini API.',
+    );
+  }
+
   const fromTimeRangeFilter = common.getValueByPath(fromObject, [
     'timeRangeFilter',
   ]);

src/types.ts

@@ -157,6 +157,38 @@ export enum ApiSpec {
   ELASTIC_SEARCH = 'ELASTIC_SEARCH',
 }
 
+/** Sites with confidence level chosen & above this value will be blocked from the search results. This enum is not supported in Gemini API. */
+export enum PhishBlockThreshold {
+  /**
+   * Defaults to unspecified.
+   */
+  PHISH_BLOCK_THRESHOLD_UNSPECIFIED = 'PHISH_BLOCK_THRESHOLD_UNSPECIFIED',
+  /**
+   * Blocks Low and above confidence URL that is risky.
+   */
+  BLOCK_LOW_AND_ABOVE = 'BLOCK_LOW_AND_ABOVE',
+  /**
+   * Blocks Medium and above confidence URL that is risky.
+   */
+  BLOCK_MEDIUM_AND_ABOVE = 'BLOCK_MEDIUM_AND_ABOVE',
+  /**
+   * Blocks High and above confidence URL that is risky.
+   */
+  BLOCK_HIGH_AND_ABOVE = 'BLOCK_HIGH_AND_ABOVE',
+  /**
+   * Blocks Higher and above confidence URL that is risky.
+   */
+  BLOCK_HIGHER_AND_ABOVE = 'BLOCK_HIGHER_AND_ABOVE',
+  /**
+   * Blocks Very high and above confidence URL that is risky.
+   */
+  BLOCK_VERY_HIGH_AND_ABOVE = 'BLOCK_VERY_HIGH_AND_ABOVE',
+  /**
+   * Blocks Extremely high confidence URL that is risky.
+   */
+  BLOCK_ONLY_EXTREMELY_HIGH = 'BLOCK_ONLY_EXTREMELY_HIGH',
+}
+
 /** Harm category. */
 export enum HarmCategory {
   /**
@@ -1739,6 +1771,8 @@ export declare interface ToolCodeExecution {}
 export declare interface EnterpriseWebSearch {
   /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. */
   excludeDomains?: string[];
+  /** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. */
+  blockingConfidence?: PhishBlockThreshold;
 }
 
 /** Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. */
@@ -1753,6 +1787,8 @@ export declare interface Interval {
 export declare interface GoogleSearch {
   /** Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"]. This field is not supported in Gemini API. */
   excludeDomains?: string[];
+  /** Optional. Sites with confidence level chosen & above this value will be blocked from the search results. This field is not supported in Gemini API. */
+  blockingConfidence?: PhishBlockThreshold;
   /** Optional. Filter search results to a specific time range. If customers set a start time, they must set an end time (and vice versa). This field is not supported in Vertex AI. */
   timeRangeFilter?: Interval;
 }