Skip to content

Commit 08ccd4b

Browse files
committed
set SchemaShared to public
1 parent 9cec6ea commit 08ccd4b

File tree

3 files changed

+5742
-5013
lines changed

3 files changed

+5742
-5013
lines changed

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

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ export class ArraySchema extends Schema {
1414
constructor(schemaParams: SchemaParams, items: TypedSchema);
1515
// (undocumented)
1616
items: TypedSchema;
17-
// @internal (undocumented)
18-
toJSON(): _SchemaRequest;
17+
// (undocumented)
18+
toJSON(): SchemaRequest;
1919
}
2020

2121
// @public
@@ -310,7 +310,7 @@ export interface GenerationConfig {
310310
// (undocumented)
311311
presencePenalty?: number;
312312
responseMimeType?: string;
313-
responseSchema?: TypedSchema;
313+
responseSchema?: TypedSchema | SchemaRequest;
314314
// (undocumented)
315315
stopSequences?: string[];
316316
// (undocumented)
@@ -491,8 +491,8 @@ export class ObjectSchema extends Schema {
491491
properties: {
492492
[k: string]: TypedSchema;
493493
};
494-
// @internal (undocumented)
495-
toJSON(): _SchemaRequest;
494+
// (undocumented)
495+
toJSON(): SchemaRequest;
496496
}
497497

498498
// @public
@@ -593,8 +593,7 @@ export abstract class Schema implements SchemaInterface {
593593
}): ObjectSchema;
594594
// (undocumented)
595595
static string(stringParams?: SchemaParams): StringSchema;
596-
// Warning: (ae-incompatible-release-tags) The symbol "toJSON" is marked as @public, but its signature references "_SchemaRequest" which is marked as @internal
597-
toJSON(): _SchemaRequest;
596+
toJSON(): SchemaRequest;
598597
type: SchemaType;
599598
}
600599

@@ -607,13 +606,13 @@ export interface SchemaInterface extends SchemaShared<SchemaInterface> {
607606
export interface SchemaParams extends SchemaShared<SchemaInterface> {
608607
}
609608

610-
// @internal
611-
export interface _SchemaRequest extends SchemaShared<_SchemaRequest> {
609+
// @public
610+
export interface SchemaRequest extends SchemaShared<SchemaRequest> {
612611
required?: string[];
613612
type: SchemaType;
614613
}
615614

616-
// @public (undocumented)
615+
// @public
617616
export interface SchemaShared<T> {
618617
// (undocumented)
619618
[key: string]: unknown;
@@ -665,8 +664,8 @@ export class StringSchema extends Schema {
665664
constructor(schemaParams?: SchemaParams, enumValues?: string[]);
666665
// (undocumented)
667666
enum?: string[];
668-
// @internal (undocumented)
669-
toJSON(): _SchemaRequest;
667+
// (undocumented)
668+
toJSON(): SchemaRequest;
670669
}
671670

672671
// @public
@@ -714,6 +713,8 @@ export interface VertexAI {
714713
export class VertexAIError extends FirebaseError {
715714
constructor(code: VertexAIErrorCode, message: string, customErrorData?: CustomErrorData | undefined);
716715
// (undocumented)
716+
readonly code: VertexAIErrorCode;
717+
// (undocumented)
717718
readonly customErrorData?: CustomErrorData | undefined;
718719
}
719720

packages/vertexai/src/types/schema.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ export enum SchemaType {
3535
OBJECT = 'object'
3636
}
3737

38+
/**
39+
* Basic `Schema` properties shared across several Schema-related
40+
* types.
41+
* @public
42+
*/
3843
export interface SchemaShared<T> {
3944
/** Optional. The format of the property. */
4045
format?: string;

0 commit comments

Comments
 (0)