Skip to content

Commit cbf0dd4

Browse files
hsubox76hsubox76
committed
Fix docs
1 parent d314d63 commit cbf0dd4

File tree

11 files changed

+513
-361
lines changed

11 files changed

+513
-361
lines changed

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

Lines changed: 144 additions & 106 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,24 @@ export class AIError extends FirebaseError {
2727
}
2828

2929
// @public
30-
const enum AIErrorCode {
31-
API_NOT_ENABLED = "api-not-enabled",
32-
ERROR = "error",
33-
FETCH_ERROR = "fetch-error",
34-
INVALID_CONTENT = "invalid-content",
35-
INVALID_SCHEMA = "invalid-schema",
36-
NO_API_KEY = "no-api-key",
37-
NO_APP_ID = "no-app-id",
38-
NO_MODEL = "no-model",
39-
NO_PROJECT_ID = "no-project-id",
40-
PARSE_FAILED = "parse-failed",
41-
REQUEST_ERROR = "request-error",
42-
RESPONSE_ERROR = "response-error",
43-
UNSUPPORTED = "unsupported"
44-
}
30+
const AIErrorCode: {
31+
readonly ERROR: "error";
32+
readonly REQUEST_ERROR: "request-error";
33+
readonly RESPONSE_ERROR: "response-error";
34+
readonly FETCH_ERROR: "fetch-error";
35+
readonly INVALID_CONTENT: "invalid-content";
36+
readonly API_NOT_ENABLED: "api-not-enabled";
37+
readonly INVALID_SCHEMA: "invalid-schema";
38+
readonly NO_API_KEY: "no-api-key";
39+
readonly NO_APP_ID: "no-app-id";
40+
readonly NO_MODEL: "no-model";
41+
readonly NO_PROJECT_ID: "no-project-id";
42+
readonly PARSE_FAILED: "parse-failed";
43+
readonly UNSUPPORTED: "unsupported";
44+
};
45+
46+
// @public
47+
type AIErrorCode = (typeof AIErrorCode)[keyof typeof AIErrorCode];
4548

4649
export { AIErrorCode }
4750

@@ -98,12 +101,15 @@ export interface BaseParams {
98101
}
99102

100103
// @public
101-
export enum BlockReason {
102-
BLOCKLIST = "BLOCKLIST",
103-
OTHER = "OTHER",
104-
PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
105-
SAFETY = "SAFETY"
106-
}
104+
export const BlockReason: {
105+
readonly SAFETY: "SAFETY";
106+
readonly OTHER: "OTHER";
107+
readonly BLOCKLIST: "BLOCKLIST";
108+
readonly PROHIBITED_CONTENT: "PROHIBITED_CONTENT";
109+
};
110+
111+
// @public
112+
export type BlockReason = (typeof BlockReason)[keyof typeof BlockReason];
107113

108114
// @public
109115
export class BooleanSchema extends Schema {
@@ -230,17 +236,20 @@ export interface FileDataPart {
230236
}
231237

232238
// @public
233-
export enum FinishReason {
234-
BLOCKLIST = "BLOCKLIST",
235-
MALFORMED_FUNCTION_CALL = "MALFORMED_FUNCTION_CALL",
236-
MAX_TOKENS = "MAX_TOKENS",
237-
OTHER = "OTHER",
238-
PROHIBITED_CONTENT = "PROHIBITED_CONTENT",
239-
RECITATION = "RECITATION",
240-
SAFETY = "SAFETY",
241-
SPII = "SPII",
242-
STOP = "STOP"
243-
}
239+
export const FinishReason: {
240+
readonly STOP: "STOP";
241+
readonly MAX_TOKENS: "MAX_TOKENS";
242+
readonly SAFETY: "SAFETY";
243+
readonly RECITATION: "RECITATION";
244+
readonly OTHER: "OTHER";
245+
readonly BLOCKLIST: "BLOCKLIST";
246+
readonly PROHIBITED_CONTENT: "PROHIBITED_CONTENT";
247+
readonly SPII: "SPII";
248+
readonly MALFORMED_FUNCTION_CALL: "MALFORMED_FUNCTION_CALL";
249+
};
250+
251+
// @public
252+
export type FinishReason = (typeof FinishReason)[keyof typeof FinishReason];
244253

245254
// @public
246255
export interface FunctionCall {
@@ -259,11 +268,14 @@ export interface FunctionCallingConfig {
259268
}
260269

261270
// @public (undocumented)
262-
export enum FunctionCallingMode {
263-
ANY = "ANY",
264-
AUTO = "AUTO",
265-
NONE = "NONE"
266-
}
271+
export const FunctionCallingMode: {
272+
readonly AUTO: "AUTO";
273+
readonly ANY: "ANY";
274+
readonly NONE: "NONE";
275+
};
276+
277+
// @public (undocumented)
278+
export type FunctionCallingMode = (typeof FunctionCallingMode)[keyof typeof FunctionCallingMode];
267279

268280
// @public
269281
export interface FunctionCallPart {
@@ -509,57 +521,71 @@ export interface GroundingMetadata {
509521
}
510522

511523
// @public
512-
export enum HarmBlockMethod {
513-
PROBABILITY = "PROBABILITY",
514-
SEVERITY = "SEVERITY"
515-
}
524+
export const HarmBlockMethod: {
525+
readonly SEVERITY: "SEVERITY";
526+
readonly PROBABILITY: "PROBABILITY";
527+
};
516528

517529
// @public
518-
export enum HarmBlockThreshold {
519-
BLOCK_LOW_AND_ABOVE = "BLOCK_LOW_AND_ABOVE",
520-
BLOCK_MEDIUM_AND_ABOVE = "BLOCK_MEDIUM_AND_ABOVE",
521-
BLOCK_NONE = "BLOCK_NONE",
522-
BLOCK_ONLY_HIGH = "BLOCK_ONLY_HIGH",
523-
OFF = "OFF"
524-
}
530+
export type HarmBlockMethod = (typeof HarmBlockMethod)[keyof typeof HarmBlockMethod];
525531

526532
// @public
527-
export enum HarmCategory {
528-
// (undocumented)
529-
HARM_CATEGORY_DANGEROUS_CONTENT = "HARM_CATEGORY_DANGEROUS_CONTENT",
530-
// (undocumented)
531-
HARM_CATEGORY_HARASSMENT = "HARM_CATEGORY_HARASSMENT",
532-
// (undocumented)
533-
HARM_CATEGORY_HATE_SPEECH = "HARM_CATEGORY_HATE_SPEECH",
534-
// (undocumented)
535-
HARM_CATEGORY_SEXUALLY_EXPLICIT = "HARM_CATEGORY_SEXUALLY_EXPLICIT"
536-
}
533+
export const HarmBlockThreshold: {
534+
readonly BLOCK_LOW_AND_ABOVE: "BLOCK_LOW_AND_ABOVE";
535+
readonly BLOCK_MEDIUM_AND_ABOVE: "BLOCK_MEDIUM_AND_ABOVE";
536+
readonly BLOCK_ONLY_HIGH: "BLOCK_ONLY_HIGH";
537+
readonly BLOCK_NONE: "BLOCK_NONE";
538+
readonly OFF: "OFF";
539+
};
537540

538541
// @public
539-
export enum HarmProbability {
540-
HIGH = "HIGH",
541-
LOW = "LOW",
542-
MEDIUM = "MEDIUM",
543-
NEGLIGIBLE = "NEGLIGIBLE"
544-
}
542+
export type HarmBlockThreshold = (typeof HarmBlockThreshold)[keyof typeof HarmBlockThreshold];
545543

546544
// @public
547-
export enum HarmSeverity {
548-
HARM_SEVERITY_HIGH = "HARM_SEVERITY_HIGH",
549-
HARM_SEVERITY_LOW = "HARM_SEVERITY_LOW",
550-
HARM_SEVERITY_MEDIUM = "HARM_SEVERITY_MEDIUM",
551-
HARM_SEVERITY_NEGLIGIBLE = "HARM_SEVERITY_NEGLIGIBLE",
552-
HARM_SEVERITY_UNSUPPORTED = "HARM_SEVERITY_UNSUPPORTED"
553-
}
545+
export const HarmCategory: {
546+
readonly HARM_CATEGORY_HATE_SPEECH: "HARM_CATEGORY_HATE_SPEECH";
547+
readonly HARM_CATEGORY_SEXUALLY_EXPLICIT: "HARM_CATEGORY_SEXUALLY_EXPLICIT";
548+
readonly HARM_CATEGORY_HARASSMENT: "HARM_CATEGORY_HARASSMENT";
549+
readonly HARM_CATEGORY_DANGEROUS_CONTENT: "HARM_CATEGORY_DANGEROUS_CONTENT";
550+
};
551+
552+
// @public
553+
export type HarmCategory = (typeof HarmCategory)[keyof typeof HarmCategory];
554+
555+
// @public
556+
export const HarmProbability: {
557+
readonly NEGLIGIBLE: "NEGLIGIBLE";
558+
readonly LOW: "LOW";
559+
readonly MEDIUM: "MEDIUM";
560+
readonly HIGH: "HIGH";
561+
};
562+
563+
// @public
564+
export type HarmProbability = (typeof HarmProbability)[keyof typeof HarmProbability];
565+
566+
// @public
567+
export const HarmSeverity: {
568+
readonly HARM_SEVERITY_NEGLIGIBLE: "HARM_SEVERITY_NEGLIGIBLE";
569+
readonly HARM_SEVERITY_LOW: "HARM_SEVERITY_LOW";
570+
readonly HARM_SEVERITY_MEDIUM: "HARM_SEVERITY_MEDIUM";
571+
readonly HARM_SEVERITY_HIGH: "HARM_SEVERITY_HIGH";
572+
readonly HARM_SEVERITY_UNSUPPORTED: "HARM_SEVERITY_UNSUPPORTED";
573+
};
574+
575+
// @public
576+
export type HarmSeverity = (typeof HarmSeverity)[keyof typeof HarmSeverity];
554577

555578
// @beta
556-
export enum ImagenAspectRatio {
557-
LANDSCAPE_16x9 = "16:9",
558-
LANDSCAPE_3x4 = "3:4",
559-
PORTRAIT_4x3 = "4:3",
560-
PORTRAIT_9x16 = "9:16",
561-
SQUARE = "1:1"
562-
}
579+
export const ImagenAspectRatio: {
580+
readonly SQUARE: "1:1";
581+
readonly LANDSCAPE_3x4: "3:4";
582+
readonly PORTRAIT_4x3: "4:3";
583+
readonly LANDSCAPE_16x9: "16:9";
584+
readonly PORTRAIT_9x16: "9:16";
585+
};
586+
587+
// @beta
588+
export type ImagenAspectRatio = (typeof ImagenAspectRatio)[keyof typeof ImagenAspectRatio];
563589

564590
// @public
565591
export interface ImagenGCSImage {
@@ -616,19 +642,25 @@ export interface ImagenModelParams {
616642
}
617643

618644
// @beta
619-
export enum ImagenPersonFilterLevel {
620-
ALLOW_ADULT = "allow_adult",
621-
ALLOW_ALL = "allow_all",
622-
BLOCK_ALL = "dont_allow"
623-
}
645+
export const ImagenPersonFilterLevel: {
646+
readonly BLOCK_ALL: "dont_allow";
647+
readonly ALLOW_ADULT: "allow_adult";
648+
readonly ALLOW_ALL: "allow_all";
649+
};
624650

625651
// @beta
626-
export enum ImagenSafetyFilterLevel {
627-
BLOCK_LOW_AND_ABOVE = "block_low_and_above",
628-
BLOCK_MEDIUM_AND_ABOVE = "block_medium_and_above",
629-
BLOCK_NONE = "block_none",
630-
BLOCK_ONLY_HIGH = "block_only_high"
631-
}
652+
export type ImagenPersonFilterLevel = (typeof ImagenPersonFilterLevel)[keyof typeof ImagenPersonFilterLevel];
653+
654+
// @beta
655+
export const ImagenSafetyFilterLevel: {
656+
readonly BLOCK_LOW_AND_ABOVE: "block_low_and_above";
657+
readonly BLOCK_MEDIUM_AND_ABOVE: "block_medium_and_above";
658+
readonly BLOCK_ONLY_HIGH: "block_only_high";
659+
readonly BLOCK_NONE: "block_none";
660+
};
661+
662+
// @beta
663+
export type ImagenSafetyFilterLevel = (typeof ImagenSafetyFilterLevel)[keyof typeof ImagenSafetyFilterLevel];
632664

633665
// @beta
634666
export interface ImagenSafetySettings {
@@ -655,14 +687,17 @@ export class IntegerSchema extends Schema {
655687
}
656688

657689
// @public
658-
export enum Modality {
659-
AUDIO = "AUDIO",
660-
DOCUMENT = "DOCUMENT",
661-
IMAGE = "IMAGE",
662-
MODALITY_UNSPECIFIED = "MODALITY_UNSPECIFIED",
663-
TEXT = "TEXT",
664-
VIDEO = "VIDEO"
665-
}
690+
export const Modality: {
691+
readonly MODALITY_UNSPECIFIED: "MODALITY_UNSPECIFIED";
692+
readonly TEXT: "TEXT";
693+
readonly IMAGE: "IMAGE";
694+
readonly VIDEO: "VIDEO";
695+
readonly AUDIO: "AUDIO";
696+
readonly DOCUMENT: "DOCUMENT";
697+
};
698+
699+
// @public
700+
export type Modality = (typeof Modality)[keyof typeof Modality];
666701

667702
// @public
668703
export interface ModalityTokenCount {
@@ -707,7 +742,7 @@ export interface ObjectSchemaInterface extends SchemaInterface {
707742
// (undocumented)
708743
optionalProperties?: string[];
709744
// (undocumented)
710-
type: SchemaType.OBJECT;
745+
type: 'object';
711746
}
712747

713748
// @public
@@ -849,14 +884,17 @@ export interface SchemaShared<T> {
849884
}
850885

851886
// @public
852-
export enum SchemaType {
853-
ARRAY = "array",
854-
BOOLEAN = "boolean",
855-
INTEGER = "integer",
856-
NUMBER = "number",
857-
OBJECT = "object",
858-
STRING = "string"
859-
}
887+
export const SchemaType: {
888+
readonly STRING: "string";
889+
readonly NUMBER: "number";
890+
readonly INTEGER: "integer";
891+
readonly BOOLEAN: "boolean";
892+
readonly ARRAY: "array";
893+
readonly OBJECT: "object";
894+
};
895+
896+
// @public
897+
export type SchemaType = (typeof SchemaType)[keyof typeof SchemaType];
860898

861899
// @public (undocumented)
862900
export interface Segment {

0 commit comments

Comments
 (0)