vertexai/lib

Interfaces

VertexAIOptions

Defined in: vertexai/lib/public-types.ts:34

Options when initializing the Vertex AI in Firebase SDK.

Properties

appCheck?

optional appCheck: AppCheck | null

Defined in: vertexai/lib/public-types.ts:36

auth?

optional auth: Module | null

Defined in: vertexai/lib/public-types.ts:37

location?

optional location: string

Defined in: vertexai/lib/public-types.ts:35

Type Aliases

VertexAI

VertexAI = AI

Defined in: vertexai/lib/public-types.ts:28

Deprecated

Use the new AI instead. The Vertex AI in Firebase SDK has been replaced with the Firebase AI SDK to accommodate the evolving set of supported features and services. For migration details, see the migration guide. An instance of the Vertex AI in Firebase SDK.

Variables

VERTEX_TYPE

const VERTEX_TYPE: "vertexAI" = 'vertexAI'

Defined in: vertexai/lib/public-types.ts:42

VertexAIError

const VertexAIError: typeof AIError = AIError

Defined in: vertexai/lib/index.ts:75

Deprecated

Use the new AIError instead. The Vertex AI in Firebase SDK has been replaced with the Firebase AI SDK to accommodate the evolving set of supported features and services. For migration details, see the migration guide.

Error class for the Firebase AI SDK.

VertexAIModel

const VertexAIModel: typeof AIModel = AIModel

Defined in: vertexai/lib/index.ts:64

Deprecated

Use the new AIModel instead. The Vertex AI in Firebase SDK has been replaced with the Firebase AI SDK to accommodate the evolving set of supported features and services. For migration details, see the migration guide.

Base class for Firebase AI model APIs.

Functions

getVertexAI()

getVertexAI(app?, options?): AI

Defined in: vertexai/lib/index.ts:42

Parameters

app?

FirebaseApp = ...

The @FirebaseApp to use.

options?

VertexAIOptions

The VertexAIOptions to use.

Returns

AI

Deprecated

Use the new getAI() instead. The Vertex AI in Firebase SDK has been replaced with the Firebase AI SDK to accommodate the evolving set of supported features and services. For migration details, see the migration guide.

Returns a VertexAI instance for the given app, configured to use the Vertex AI Gemini API. This instance will be configured to use the Vertex AI Gemini API.

Returns a VertexAI instance for the given app.

References

AI

Re-exports AI

AIError

Re-exports AIError

AIErrorCode

Re-exports AIErrorCode

AIModel

Re-exports AIModel

AIOptions

Re-exports AIOptions

ArraySchema

Re-exports ArraySchema

AudioTranscriptionConfig

Re-exports AudioTranscriptionConfig

Backend

Re-exports Backend

BackendType

Re-exports BackendType

BaseParams

Re-exports BaseParams

BlockReason

Re-exports BlockReason

BooleanSchema

Re-exports BooleanSchema

ChatSession

Re-exports ChatSession

Citation

Re-exports Citation

CitationMetadata

Re-exports CitationMetadata

Content

Re-exports Content

CountTokensRequest

Re-exports CountTokensRequest

CountTokensResponse

Re-exports CountTokensResponse

CustomErrorData

Re-exports CustomErrorData

Date

Re-exports Date

EnhancedGenerateContentResponse

Re-exports EnhancedGenerateContentResponse

ErrorDetails

Re-exports ErrorDetails

FileData

Re-exports FileData

FileDataPart

Re-exports FileDataPart

FinishReason

Re-exports FinishReason

FunctionCall

Re-exports FunctionCall

FunctionCallingConfig

Re-exports FunctionCallingConfig

FunctionCallingMode

Re-exports FunctionCallingMode

FunctionCallPart

Re-exports FunctionCallPart

FunctionDeclaration

Re-exports FunctionDeclaration

FunctionDeclarationsTool

Re-exports FunctionDeclarationsTool

FunctionResponse

Re-exports FunctionResponse

FunctionResponsePart

Re-exports FunctionResponsePart

GenerateContentCandidate

Re-exports GenerateContentCandidate

GenerateContentRequest

Re-exports GenerateContentRequest

GenerateContentResponse

Re-exports GenerateContentResponse

GenerateContentResult

Re-exports GenerateContentResult

GenerateContentStreamResult

Re-exports GenerateContentStreamResult

GenerationConfig

Re-exports GenerationConfig

GenerativeContentBlob

Re-exports GenerativeContentBlob

GenerativeModel

Re-exports GenerativeModel

getAI

Re-exports getAI

getGenerativeModel

Re-exports getGenerativeModel

getImagenModel

Re-exports getImagenModel

getLiveGenerativeModel

Re-exports getLiveGenerativeModel

getTemplateGenerativeModel

Re-exports getTemplateGenerativeModel

getTemplateImagenModel

Re-exports getTemplateImagenModel

GoogleAIBackend

Re-exports GoogleAIBackend

GoogleAICitationMetadata

Re-exports GoogleAICitationMetadata

GoogleAICountTokensRequest

Re-exports GoogleAICountTokensRequest

GoogleAIGenerateContentCandidate

Re-exports GoogleAIGenerateContentCandidate

GoogleAIGenerateContentResponse

Re-exports GoogleAIGenerateContentResponse

GoogleSearch

Re-exports GoogleSearch

GoogleSearchTool

Re-exports GoogleSearchTool

GroundingAttribution

Re-exports GroundingAttribution

GroundingChunk

Re-exports GroundingChunk

GroundingMetadata

Re-exports GroundingMetadata

GroundingSupport

Re-exports GroundingSupport

HarmBlockMethod

Re-exports HarmBlockMethod

HarmBlockThreshold

Re-exports HarmBlockThreshold

HarmCategory

Re-exports HarmCategory

HarmProbability

Re-exports HarmProbability

HarmSeverity

Re-exports HarmSeverity

ImagenAspectRatio

Re-exports ImagenAspectRatio

ImagenGCSImage

Re-exports ImagenGCSImage

ImagenGenerationConfig

Re-exports ImagenGenerationConfig

ImagenGenerationResponse

Re-exports ImagenGenerationResponse

ImagenImageFormat

Re-exports ImagenImageFormat

ImagenInlineImage

Re-exports ImagenInlineImage

ImagenModel

Re-exports ImagenModel

ImagenModelParams

Re-exports ImagenModelParams

ImagenPersonFilterLevel

Re-exports ImagenPersonFilterLevel

ImagenSafetyFilterLevel

Re-exports ImagenSafetyFilterLevel

ImagenSafetySettings

Re-exports ImagenSafetySettings

InferenceMode

Re-exports InferenceMode

InlineDataPart

Re-exports InlineDataPart

IntegerSchema

Re-exports IntegerSchema

LiveGenerationConfig

Re-exports LiveGenerationConfig

LiveGenerativeModel

Re-exports LiveGenerativeModel

LiveModelParams

Re-exports LiveModelParams

LiveResponseType

Re-exports LiveResponseType

LiveServerContent

Re-exports LiveServerContent

LiveServerToolCall

Re-exports LiveServerToolCall

LiveServerToolCallCancellation

Re-exports LiveServerToolCallCancellation

LiveSession

Re-exports LiveSession

Modality

Re-exports Modality

ModalityTokenCount

Re-exports ModalityTokenCount

ModelParams

Re-exports ModelParams

NumberSchema

Re-exports NumberSchema

ObjectSchema

Re-exports ObjectSchema

ObjectSchemaInterface

Re-exports ObjectSchemaInterface

Part

Re-exports Part

POSSIBLE_ROLES

Re-exports POSSIBLE_ROLES

PrebuiltVoiceConfig

Re-exports PrebuiltVoiceConfig

PromptFeedback

Re-exports PromptFeedback

RequestOptions

Re-exports RequestOptions

ResponseModality

Re-exports ResponseModality

RetrievedContextAttribution

Re-exports RetrievedContextAttribution

Role

Re-exports Role

SafetyRating

Re-exports SafetyRating

SafetySetting

Re-exports SafetySetting

Schema

Re-exports Schema

SchemaInterface

Re-exports SchemaInterface

SchemaParams

Re-exports SchemaParams

SchemaRequest

Re-exports SchemaRequest

SchemaShared

Re-exports SchemaShared

SchemaType

Re-exports SchemaType

Segment

Re-exports Segment

SpeechConfig

Re-exports SpeechConfig

StartChatParams

Re-exports StartChatParams

StringSchema

Re-exports StringSchema

TemplateGenerativeModel

Re-exports TemplateGenerativeModel

TemplateImagenModel

Re-exports TemplateImagenModel

TextPart

Re-exports TextPart

ThinkingConfig

Re-exports ThinkingConfig

Tool

Re-exports Tool

ToolConfig

Re-exports ToolConfig

Transcription

Re-exports Transcription

TypedSchema

Re-exports TypedSchema

UsageMetadata

Re-exports UsageMetadata

VertexAIBackend

Re-exports VertexAIBackend

VertexAIErrorCode

Renames and re-exports AIErrorCode

VideoMetadata

Re-exports VideoMetadata

VoiceConfig

Re-exports VoiceConfig

WebAttribution

Re-exports WebAttribution

WebGroundingChunk

Re-exports WebGroundingChunk