Skip to content

Commit 546f220

Browse files
committed
Add missing BlockReason and FinishReason enum values
1 parent 01f36ea commit 546f220

File tree

4 files changed

+37
-2
lines changed

4 files changed

+37
-2
lines changed

.changeset/fifty-pans-fail.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@firebase/vertexai': patch
3+
---
4+
5+
Added missing `BlockReason` and `FinishReason` enum values.

common/api-review/vertexai.api.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,13 @@ export interface BaseParams {
2828

2929
// @public
3030
export enum BlockReason {
31+
// (undocumented)
32+
BLOCKLIST = "BLOCKLIST",
3133
// (undocumented)
3234
OTHER = "OTHER",
3335
// (undocumented)
36+
PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
37+
// (undocumented)
3438
SAFETY = "SAFETY"
3539
}
3640

@@ -157,15 +161,23 @@ export interface FileDataPart {
157161

158162
// @public
159163
export enum FinishReason {
164+
// (undocumented)
165+
BLOCKLIST = "BLOCKLIST",
166+
// (undocumented)
167+
MALFORMED_FUNCTION_CALL = "MALFORMED_FUNCTION_CALL",
160168
// (undocumented)
161169
MAX_TOKENS = "MAX_TOKENS",
162170
// (undocumented)
163171
OTHER = "OTHER",
164172
// (undocumented)
173+
PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
174+
// (undocumented)
165175
RECITATION = "RECITATION",
166176
// (undocumented)
167177
SAFETY = "SAFETY",
168178
// (undocumented)
179+
SPII = "SPII",
180+
// (undocumented)
169181
STOP = "STOP"
170182
}
171183

docs-devsite/vertexai.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,9 @@ export declare enum BlockReason
231231

232232
| Member | Value | Description |
233233
| --- | --- | --- |
234+
| BLOCKLIST | <code>&quot;BLOCKLIST&quot;</code> | |
234235
| OTHER | <code>&quot;OTHER&quot;</code> | |
236+
| PROHIBITED\_CONTENT | <code>&quot;PROHIBITED_CONTENT&quot;</code> | |
235237
| SAFETY | <code>&quot;SAFETY&quot;</code> | |
236238

237239
## FinishReason
@@ -248,10 +250,14 @@ export declare enum FinishReason
248250

249251
| Member | Value | Description |
250252
| --- | --- | --- |
253+
| BLOCKLIST | <code>&quot;BLOCKLIST&quot;</code> | |
254+
| MALFORMED\_FUNCTION\_CALL | <code>&quot;MALFORMED_FUNCTION_CALL&quot;</code> | |
251255
| MAX\_TOKENS | <code>&quot;MAX_TOKENS&quot;</code> | |
252256
| OTHER | <code>&quot;OTHER&quot;</code> | |
257+
| PROHIBITED\_CONTENT | <code>&quot;PROHIBITED_CONTENT&quot;</code> | |
253258
| RECITATION | <code>&quot;RECITATION&quot;</code> | |
254259
| SAFETY | <code>&quot;SAFETY&quot;</code> | |
260+
| SPII | <code>&quot;SPII&quot;</code> | |
255261
| STOP | <code>&quot;STOP&quot;</code> | |
256262

257263
## FunctionCallingMode

packages/vertexai/src/types/enums.ts

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,11 @@ export enum BlockReason {
101101
// Content was blocked by safety settings.
102102
SAFETY = 'SAFETY',
103103
// Content was blocked, but the reason is uncategorized.
104-
OTHER = 'OTHER'
104+
OTHER = 'OTHER',
105+
// Content was blocked because it contained terms from the terminology blocklist.
106+
BLOCKLIST = 'BLOCKLIST',
107+
// Content was blocked due to prohibited content.
108+
PROHIBITED_CONTENT = 'PROHIBITED_CONTENT'
105109
}
106110

107111
/**
@@ -118,7 +122,15 @@ export enum FinishReason {
118122
// The candidate content was flagged for recitation reasons.
119123
RECITATION = 'RECITATION',
120124
// Unknown reason.
121-
OTHER = 'OTHER'
125+
OTHER = 'OTHER',
126+
// The candidate content contained forbidden terms.
127+
BLOCKLIST = 'BLOCKLIST',
128+
// The candidate content potentially contained prohibited content.
129+
PROHIBITED_CONTENT = 'PROHIBITED_CONTENT',
130+
// The candidate content potentially contained Sensitive Personally Identifiable Information (SPII).
131+
SPII = 'SPII',
132+
// The function call generated by the model was invalid.
133+
MALFORMED_FUNCTION_CALL = 'MALFORMED_FUNCTION_CALL'
122134
}
123135

124136
/**

0 commit comments

Comments
 (0)