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

Constructors

Properties

fireworksApiKey?: string

Methods

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

    Parameters

    • request: CompletionCreateParamsStreaming

      The request to send to the Fireworks API.

    • Optional options: OpenAICoreRequestOptions

      Optional configuration for the API call.

    Returns Promise<AsyncIterable<Completion>>

    The response from the Fireworks API.

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

    Parameters

    • request: CompletionCreateParamsNonStreaming

      The request to send to the Fireworks API.

    • Optional options: OpenAICoreRequestOptions

      Optional configuration for the API call.

    Returns Promise<Completion>

    The response from the Fireworks API.

Generated using TypeDoc