fireworks

package
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 16, 2026 License: Apache-2.0 Imports: 14 Imported by: 1

Documentation

Overview

Package fireworks provides a Fireworks AI provider implementation. Fireworks uses an OpenAI-compatible API.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChatOptions added in v0.1.7

type ChatOptions struct {
	PromptCacheKey   string           `json:"promptCacheKey,omitempty"`
	ServiceTier      string           `json:"serviceTier,omitempty"`
	Thinking         *ThinkingOptions `json:"thinking,omitempty"`
	ReasoningHistory string           `json:"reasoningHistory,omitempty"`
	ReasoningEffort  string           `json:"reasoningEffort,omitempty"`
}

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

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

	// HTTPClient sends language-model requests. Nil uses http.DefaultClient.
	HTTPClient *http.Client
}

Options contains configuration for the Fireworks provider.

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider implements the Fireworks provider.

func New

func New(opts Options) *Provider

New creates a new Fireworks provider.

func (*Provider) EmbeddingModel

func (p *Provider) EmbeddingModel(modelID string) model.EmbeddingModel

func (*Provider) ID

func (p *Provider) ID() string

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) Model

func (p *Provider) Model(modelID string) stream.Model

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

type ThinkingOptions added in v0.1.7

type ThinkingOptions struct {
	Type         string `json:"type,omitempty"`
	BudgetTokens *int   `json:"budgetTokens,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL