Class ChatFireworks

Wrapper around Fireworks API for large language models fine-tuned for chat

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.

Example

const model = new ChatFireworks({
  temperature: 0.9,
  apiKey: "YOUR-API-KEY",
});

const response = await model.invoke("Hello, how are you?");
console.log(response);

Hierarchy (view full)

Constructors

constructor

Properties

apiKey? fireworksApiKey?

Methods

completionWithRetry toJSON

Constructors

constructor

  • new ChatFireworks(fields?): ChatFireworks

  • Parameters

    • Optional fields: Partial<Omit<OpenAIChatInput, "functions" | "frequencyPenalty" | "presencePenalty" | "openAIApiKey" | "logitBias">> & BaseLanguageModelParams & {
          apiKey?: string;
          fireworksApiKey?: string;
      }

    Returns ChatFireworks

Properties

Optional apiKey

apiKey?: string

Optional fireworksApiKey

fireworksApiKey?: string

Methods

completionWithRetry

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

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

    Parameters

    • request: ChatCompletionCreateParamsStreaming

      The request to send to the Fireworks API.

    • Optional options: any

      Optional configuration for the API call.

    Returns Promise<AsyncIterable<ChatCompletionChunk>>

    The response from the Fireworks API.

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

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

    Parameters

    • request: ChatCompletionCreateParamsNonStreaming

      The request to send to the Fireworks API.

    • Optional options: any

      Optional configuration for the API call.

    Returns Promise<ChatCompletion>

    The response from the Fireworks API.

toJSON

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc