Class Fireworks

Wrapper around Fireworks API for large language models

Fireworks API is compatible to the OpenAI API with some limitations described in https://readme.fireworks.ai/docs/openai-compatibility.

To use, you should have the openai package installed and the FIREWORKS_API_KEY environment variable set.

Hierarchy (view full)

Constructors

constructor

Properties

fireworksApiKey?

Methods

completionWithRetry toJSON

Constructors

constructor

  • new Fireworks(fields?): Fireworks

  • Parameters

    • Optional fields: Partial<Omit<OpenAIInput, "frequencyPenalty" | "presencePenalty" | "openAIApiKey" | "bestOf" | "logitBias">> & BaseLLMParams & {
          fireworksApiKey?: string;
      }

    Returns Fireworks

Properties

Optional fireworksApiKey

fireworksApiKey?: string

Methods

completionWithRetry

  • completionWithRetry(request, options?): Promise<AsyncIterable<Completion>>

  • Calls the Fireworks API with retry logic in case of failures.

    Parameters

    • request: CompletionCreateParamsStreaming

      The request to send to the Fireworks API.

    • Optional options: any

      Optional configuration for the API call.

    Returns Promise<AsyncIterable<Completion>>

    The response from the Fireworks API.

  • completionWithRetry(request, options?): Promise<Completion>

  • Calls the Fireworks API with retry logic in case of failures.

    Parameters

    • request: CompletionCreateParamsNonStreaming

      The request to send to the Fireworks API.

    • Optional options: any

      Optional configuration for the API call.

    Returns Promise<Completion>

    The response from the Fireworks API.

toJSON

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc