diff --git a/.changeset/stupid-apples-shave.md b/.changeset/stupid-apples-shave.md new file mode 100644 index 00000000000..a76a3808056 --- /dev/null +++ b/.changeset/stupid-apples-shave.md @@ -0,0 +1,6 @@ +--- +'@firebase/vertexai': minor +'firebase': minor +--- + +Added missing `BlockReason` and `FinishReason` enum values. diff --git a/common/api-review/vertexai.api.md b/common/api-review/vertexai.api.md index 041bc62451f..9799d4995d5 100644 --- a/common/api-review/vertexai.api.md +++ b/common/api-review/vertexai.api.md @@ -28,8 +28,10 @@ export interface BaseParams { // @public export enum BlockReason { + BLOCKLIST = "BLOCKLIST", // (undocumented) OTHER = "OTHER", + PROHIBITED_CONTENT = "PROHIBITED_CONTENT", // (undocumented) SAFETY = "SAFETY" } @@ -157,14 +159,18 @@ export interface FileDataPart { // @public export enum FinishReason { + BLOCKLIST = "BLOCKLIST", + MALFORMED_FUNCTION_CALL = "MALFORMED_FUNCTION_CALL", // (undocumented) MAX_TOKENS = "MAX_TOKENS", // (undocumented) OTHER = "OTHER", + PROHIBITED_CONTENT = "PROHIBITED_CONTENT", // (undocumented) RECITATION = "RECITATION", // (undocumented) SAFETY = "SAFETY", + SPII = "SPII", // (undocumented) STOP = "STOP" } diff --git a/docs-devsite/vertexai.md b/docs-devsite/vertexai.md index d9e26eabc5d..724d0f59b47 100644 --- a/docs-devsite/vertexai.md +++ b/docs-devsite/vertexai.md @@ -231,7 +231,9 @@ export declare enum BlockReason | Member | Value | Description | | --- | --- | --- | +| BLOCKLIST | "BLOCKLIST" | Content was blocked because it contained terms from the terminology blocklist. | | OTHER | "OTHER" | | +| PROHIBITED\_CONTENT | "PROHIBITED_CONTENT" | Content was blocked due to prohibited content. | | SAFETY | "SAFETY" | | ## FinishReason @@ -248,10 +250,14 @@ export declare enum FinishReason | Member | Value | Description | | --- | --- | --- | +| BLOCKLIST | "BLOCKLIST" | The candidate content contained forbidden terms. | +| MALFORMED\_FUNCTION\_CALL | "MALFORMED_FUNCTION_CALL" | The function call generated by the model was invalid. | | MAX\_TOKENS | "MAX_TOKENS" | | | OTHER | "OTHER" | | +| PROHIBITED\_CONTENT | "PROHIBITED_CONTENT" | The candidate content potentially contained prohibited content. | | RECITATION | "RECITATION" | | | SAFETY | "SAFETY" | | +| SPII | "SPII" | The candidate content potentially contained Sensitive Personally Identifiable Information (SPII). | | STOP | "STOP" | | ## FunctionCallingMode diff --git a/packages/vertexai/src/types/enums.ts b/packages/vertexai/src/types/enums.ts index 3e66bacc612..bdaa2d28939 100644 --- a/packages/vertexai/src/types/enums.ts +++ b/packages/vertexai/src/types/enums.ts @@ -101,7 +101,15 @@ export enum BlockReason { // Content was blocked by safety settings. SAFETY = 'SAFETY', // Content was blocked, but the reason is uncategorized. - OTHER = 'OTHER' + OTHER = 'OTHER', + /** + * Content was blocked because it contained terms from the terminology blocklist. + */ + BLOCKLIST = 'BLOCKLIST', + /** + * Content was blocked due to prohibited content. + */ + PROHIBITED_CONTENT = 'PROHIBITED_CONTENT' } /** @@ -118,7 +126,23 @@ export enum FinishReason { // The candidate content was flagged for recitation reasons. RECITATION = 'RECITATION', // Unknown reason. - OTHER = 'OTHER' + OTHER = 'OTHER', + /** + * The candidate content contained forbidden terms. + */ + BLOCKLIST = 'BLOCKLIST', + /** + * The candidate content potentially contained prohibited content. + */ + PROHIBITED_CONTENT = 'PROHIBITED_CONTENT', + /** + * The candidate content potentially contained Sensitive Personally Identifiable Information (SPII). + */ + SPII = 'SPII', + /** + * The function call generated by the model was invalid. + */ + MALFORMED_FUNCTION_CALL = 'MALFORMED_FUNCTION_CALL' } /**