Skip to content

Commit 3fe4f4f

Browse files
hsubox76hsubox76
authored
[Vertex GA] Miscellaneous breaking changes for Vertex GA (#8514)
1 parent 245e65e commit 3fe4f4f

File tree

6 files changed

+18
-47
lines changed

6 files changed

+18
-47
lines changed

‎common/api-review/vertexai.api.md

Lines changed: 6 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,6 @@ export interface BaseParams {
2828

2929
// @public
3030
export enum BlockReason {
31-
// (undocumented)
32-
BLOCKED_REASON_UNSPECIFIED = "BLOCKED_REASON_UNSPECIFIED",
3331
// (undocumented)
3432
OTHER = "OTHER",
3533
// (undocumented)
@@ -159,8 +157,6 @@ export interface FileDataPart {
159157

160158
// @public
161159
export enum FinishReason {
162-
// (undocumented)
163-
FINISH_REASON_UNSPECIFIED = "FINISH_REASON_UNSPECIFIED",
164160
// (undocumented)
165161
MAX_TOKENS = "MAX_TOKENS",
166162
// (undocumented)
@@ -196,8 +192,6 @@ export enum FunctionCallingMode {
196192
// (undocumented)
197193
AUTO = "AUTO",
198194
// (undocumented)
199-
MODE_UNSPECIFIED = "MODE_UNSPECIFIED",
200-
// (undocumented)
201195
NONE = "NONE"
202196
}
203197

@@ -215,7 +209,7 @@ export interface FunctionCallPart {
215209

216210
// @public
217211
export interface FunctionDeclaration {
218-
description?: string;
212+
description: string;
219213
name: string;
220214
parameters?: ObjectSchemaInterface;
221215
}
@@ -381,8 +375,6 @@ export interface GroundingMetadata {
381375

382376
// @public (undocumented)
383377
export enum HarmBlockMethod {
384-
// (undocumented)
385-
HARM_BLOCK_METHOD_UNSPECIFIED = "HARM_BLOCK_METHOD_UNSPECIFIED",
386378
// (undocumented)
387379
PROBABILITY = "PROBABILITY",
388380
// (undocumented)
@@ -398,9 +390,7 @@ export enum HarmBlockThreshold {
398390
// (undocumented)
399391
BLOCK_NONE = "BLOCK_NONE",
400392
// (undocumented)
401-
BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH",
402-
// (undocumented)
403-
HARM_BLOCK_THRESHOLD_UNSPECIFIED = "HARM_BLOCK_THRESHOLD_UNSPECIFIED"
393+
BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH"
404394
}
405395

406396
// @public
@@ -412,15 +402,11 @@ export enum HarmCategory {
412402
// (undocumented)
413403
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
414404
// (undocumented)
415-
HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT",
416-
// (undocumented)
417-
HARM_CATEGORY_UNSPECIFIED = "HARM_CATEGORY_UNSPECIFIED"
405+
HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT"
418406
}
419407

420408
// @public
421409
export enum HarmProbability {
422-
// (undocumented)
423-
HARM_PROBABILITY_UNSPECIFIED = "HARM_PROBABILITY_UNSPECIFIED",
424410
// (undocumented)
425411
HIGH = "HIGH",
426412
// (undocumented)
@@ -440,9 +426,7 @@ export enum HarmSeverity {
440426
// (undocumented)
441427
HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
442428
// (undocumented)
443-
HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
444-
// (undocumented)
445-
HARM_SEVERITY_UNSPECIFIED = "HARM_SEVERITY_UNSPECIFIED"
429+
HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE"
446430
}
447431

448432
// @public
@@ -512,7 +496,7 @@ export const POSSIBLE_ROLES: readonly ["user", "model", "function", "system"];
512496
// @public
513497
export interface PromptFeedback {
514498
// (undocumented)
515-
blockReason: BlockReason;
499+
blockReason?: BlockReason;
516500
// (undocumented)
517501
blockReasonMessage?: string;
518502
// (undocumented)
@@ -687,7 +671,7 @@ export type Tool = FunctionDeclarationsTool;
687671
// @public
688672
export interface ToolConfig {
689673
// (undocumented)
690-
functionCallingConfig: FunctionCallingConfig;
674+
functionCallingConfig?: FunctionCallingConfig;
691675
}
692676

693677
// @public

‎packages/vertexai/src/requests/request.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ describe('request methods', () => {
244244
false,
245245
'',
246246
{
247-
timeout: 0
247+
timeout: 180000
248248
}
249249
);
250250
} catch (e) {

‎packages/vertexai/src/requests/request.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,11 +215,13 @@ export async function makeRequest(
215215
*/
216216
function buildFetchOptions(requestOptions?: RequestOptions): RequestInit {
217217
const fetchOptions = {} as RequestInit;
218+
let timeoutMillis = 180 * 1000; // default: 180 s
218219
if (requestOptions?.timeout && requestOptions?.timeout >= 0) {
219-
const abortController = new AbortController();
220-
const signal = abortController.signal;
221-
setTimeout(() => abortController.abort(), requestOptions.timeout);
222-
fetchOptions.signal = signal;
220+
timeoutMillis = requestOptions.timeout;
223221
}
222+
const abortController = new AbortController();
223+
const signal = abortController.signal;
224+
setTimeout(() => abortController.abort(), timeoutMillis);
225+
fetchOptions.signal = signal;
224226
return fetchOptions;
225227
}

‎packages/vertexai/src/types/enums.ts

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ export const POSSIBLE_ROLES = ['user', 'model', 'function', 'system'] as const;
3232
* @public
3333
*/
3434
export enum HarmCategory {
35-
HARM_CATEGORY_UNSPECIFIED = 'HARM_CATEGORY_UNSPECIFIED',
3635
HARM_CATEGORY_HATE_SPEECH = 'HARM_CATEGORY_HATE_SPEECH',
3736
HARM_CATEGORY_SEXUALLY_EXPLICIT = 'HARM_CATEGORY_SEXUALLY_EXPLICIT',
3837
HARM_CATEGORY_HARASSMENT = 'HARM_CATEGORY_HARASSMENT',
@@ -44,8 +43,6 @@ export enum HarmCategory {
4443
* @public
4544
*/
4645
export enum HarmBlockThreshold {
47-
// Threshold is unspecified.
48-
HARM_BLOCK_THRESHOLD_UNSPECIFIED = 'HARM_BLOCK_THRESHOLD_UNSPECIFIED',
4946
// Content with NEGLIGIBLE will be allowed.
5047
BLOCK_LOW_AND_ABOVE = 'BLOCK_LOW_AND_ABOVE',
5148
// Content with NEGLIGIBLE and LOW will be allowed.
@@ -60,8 +57,6 @@ export enum HarmBlockThreshold {
6057
* @public
6158
*/
6259
export enum HarmBlockMethod {
63-
// The harm block method is unspecified.
64-
HARM_BLOCK_METHOD_UNSPECIFIED = 'HARM_BLOCK_METHOD_UNSPECIFIED',
6560
// The harm block method uses both probability and severity scores.
6661
SEVERITY = 'SEVERITY',
6762
// The harm block method uses the probability score.
@@ -73,8 +68,6 @@ export enum HarmBlockMethod {
7368
* @public
7469
*/
7570
export enum HarmProbability {
76-
// Probability is unspecified.
77-
HARM_PROBABILITY_UNSPECIFIED = 'HARM_PROBABILITY_UNSPECIFIED',
7871
// Content has a negligible chance of being unsafe.
7972
NEGLIGIBLE = 'NEGLIGIBLE',
8073
// Content has a low chance of being unsafe.
@@ -90,8 +83,6 @@ export enum HarmProbability {
9083
* @public
9184
*/
9285
export enum HarmSeverity {
93-
// Harm severity unspecified.
94-
HARM_SEVERITY_UNSPECIFIED = 'HARM_SEVERITY_UNSPECIFIED',
9586
// Negligible level of harm severity.
9687
HARM_SEVERITY_NEGLIGIBLE = 'HARM_SEVERITY_NEGLIGIBLE',
9788
// Low level of harm severity.
@@ -107,8 +98,6 @@ export enum HarmSeverity {
10798
* @public
10899
*/
109100
export enum BlockReason {
110-
// A blocked reason was not specified.
111-
BLOCKED_REASON_UNSPECIFIED = 'BLOCKED_REASON_UNSPECIFIED',
112101
// Content was blocked by safety settings.
113102
SAFETY = 'SAFETY',
114103
// Content was blocked, but the reason is uncategorized.
@@ -120,8 +109,6 @@ export enum BlockReason {
120109
* @public
121110
*/
122111
export enum FinishReason {
123-
// Default value. This value is unused.
124-
FINISH_REASON_UNSPECIFIED = 'FINISH_REASON_UNSPECIFIED',
125112
// Natural stop point of the model or provided stop sequence.
126113
STOP = 'STOP',
127114
// The maximum number of tokens as specified in the request was reached.
@@ -138,8 +125,6 @@ export enum FinishReason {
138125
* @public
139126
*/
140127
export enum FunctionCallingMode {
141-
// Unspecified function calling mode. This value should not be used.
142-
MODE_UNSPECIFIED = 'MODE_UNSPECIFIED',
143128
// Default model behavior, model decides to predict either a function call
144129
// or a natural language response.
145130
AUTO = 'AUTO',

‎packages/vertexai/src/types/requests.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ export interface CountTokensRequest {
121121
*/
122122
export interface RequestOptions {
123123
/**
124-
* Request timeout in milliseconds.
124+
* Request timeout in milliseconds. Defaults to 180 seconds (180000ms).
125125
*/
126126
timeout?: number;
127127
/**
@@ -153,10 +153,10 @@ export declare interface FunctionDeclaration {
153153
*/
154154
name: string;
155155
/**
156-
* Optional. Description and purpose of the function. Model uses it to decide
156+
* Description and purpose of the function. Model uses it to decide
157157
* how and whether to call the function.
158158
*/
159-
description?: string;
159+
description: string;
160160
/**
161161
* Optional. Describes the parameters to this function in JSON Schema Object
162162
* format. Reflects the Open API 3.03 Parameter Object. Parameter names are
@@ -190,7 +190,7 @@ export declare interface FunctionDeclarationsTool {
190190
* @public
191191
*/
192192
export interface ToolConfig {
193-
functionCallingConfig: FunctionCallingConfig;
193+
functionCallingConfig?: FunctionCallingConfig;
194194
}
195195

196196
/**

‎packages/vertexai/src/types/responses.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ export interface UsageMetadata {
9191
* @public
9292
*/
9393
export interface PromptFeedback {
94-
blockReason: BlockReason;
94+
blockReason?: BlockReason;
9595
safetyRatings: SafetyRating[];
9696
blockReasonMessage?: string;
9797
}

0 commit comments

Comments
 (0)