Documentation
¶
Overview ¶
Package fireworks provides a Fireworks AI provider implementation. Fireworks uses an OpenAI-compatible API.
Index ¶
- type FireworksImageModel
- type Options
- type Provider
- func (p *Provider) EmbeddingModel(modelID string) model.EmbeddingModel
- func (p *Provider) ID() string
- func (p *Provider) ImageModel(modelID string) model.ImageModel
- func (p *Provider) LanguageModel(modelID string) model.LanguageModel
- func (p *Provider) Model(modelID string) stream.Model
- func (p *Provider) Models() []string
- func (p *Provider) RerankingModel(modelID string) model.RerankingModel
- func (p *Provider) SpeechModel(modelID string) model.SpeechModel
- func (p *Provider) TranscriptionModel(modelID string) model.TranscriptionModel
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FireworksImageModel ¶
type FireworksImageModel struct {
// contains filtered or unexported fields
}
FireworksImageModel implements model.ImageModel for Fireworks image generation and editing endpoints. Mirrors ai-sdk's FireworksImageModel. See: ai-sdk/packages/fireworks/src/fireworks-image-model.ts
func (*FireworksImageModel) Generate ¶
func (m *FireworksImageModel) Generate(ctx context.Context, opts model.ImageCallOptions) (*model.ImageResult, error)
Generate generates images based on the provided options.
func (*FireworksImageModel) ID ¶
func (m *FireworksImageModel) ID() string
ID returns the model identifier.
func (*FireworksImageModel) MaxImagesPerCall ¶
func (m *FireworksImageModel) MaxImagesPerCall() int
MaxImagesPerCall returns the maximum number of images that can be generated in a single call. Mirrors ai-sdk (1).
func (*FireworksImageModel) Provider ¶
func (m *FireworksImageModel) Provider() string
Provider returns "fireworks".
type Options ¶
type Options struct {
APIKey string
BaseURL string
Headers map[string]string
// PollIntervalMS overrides the async image polling interval. Defaults
// to 500ms when zero. Mirrors ai-sdk's pollIntervalMillis.
PollIntervalMS int
// PollTimeoutMS overrides the async image polling timeout. Defaults
// to 120000ms (2 minutes) when zero. Mirrors ai-sdk's pollTimeoutMillis.
PollTimeoutMS int
}
Options contains configuration for the Fireworks provider.
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider implements the Fireworks provider.
func (*Provider) EmbeddingModel ¶
func (p *Provider) EmbeddingModel(modelID string) model.EmbeddingModel
func (*Provider) ImageModel ¶
func (p *Provider) ImageModel(modelID string) model.ImageModel
ImageModel returns a FireworksImageModel wired to the workflows / image_generation endpoints. Mirrors ai-sdk's FireworksImageModel.
func (*Provider) LanguageModel ¶
func (p *Provider) LanguageModel(modelID string) model.LanguageModel
func (*Provider) Models ¶
Models returns the Fireworks chat-model catalog. Mirrors ai-sdk's FireworksChatModelId union in packages/fireworks/src/fireworks-chat-options.ts.
func (*Provider) RerankingModel ¶
func (p *Provider) RerankingModel(modelID string) model.RerankingModel
func (*Provider) SpeechModel ¶
func (p *Provider) SpeechModel(modelID string) model.SpeechModel
func (*Provider) TranscriptionModel ¶
func (p *Provider) TranscriptionModel(modelID string) model.TranscriptionModel
Source Files