Class AIModel`Abstract`

Base class for Firebase AI model APIs.

Instances of this class are associated with a specific Firebase AI Backend and provide methods for interacting with the configured generative model.

Hierarchy (View Summary)

AIModel

Index

Constructors

Methods

normalizeModelName

Properties

_apiSettings model

Constructors

`Protected`constructor

new AIModel(ai: AI, modelName: string): AIModel
Internal
Constructs a new instance of the AIModel class.

This constructor should only be called from subclasses that provide a model API.
Parameters
- ai: AI
  an AI instance.
- modelName: string
  The name of the model being used. It can be in one of the following formats:
  
  my-model (short name, will resolve to publishers/google/models/my-model)
  
  models/my-model (will resolve to publishers/google/models/my-model)
  
  publishers/my-publisher/models/my-model (fully qualified model name)
Returns AIModel
Throws
If the apiKey or projectId fields are missing in your Firebase config.
- Defined in models/ai-model.ts:59

Methods

`Static`normalizeModelName

normalizeModelName(modelName: string, backendType: BackendType): string
Internal
Normalizes the given model name to a fully qualified model resource name.
Parameters
- modelName: string
  The model name to normalize.
- backendType: BackendType
Returns string
The fully qualified model resource name.
- Defined in models/ai-model.ts:72

Properties

`Protected` `Internal`_apiSettings

_apiSettings: ApiSettings

`Readonly`model

model: string

The fully qualified model resource name to use for generating images (for example, publishers/google/models/imagen-3.0-generate-002).