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)

Toolkit<FireworksCallOptions>
- Fireworks

Index

Constructors

Properties

fireworksApiKey?

Methods

completionWithRetry toJSON

Constructors

constructor

new Fireworks(fields?): Fireworks
Parameters
- Optional fields: any
Returns Fireworks
Overrides OpenAI<FireworksCallOptions>.constructor
- Defined in libs/langchain-community/src/llms/fireworks.ts:51

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.
- Defined in libs/langchain-community/src/llms/fireworks.ts:93
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.
- Defined in libs/langchain-community/src/llms/fireworks.ts:98

toJSON

toJSON(): any
Returns any
- Defined in libs/langchain-community/src/llms/fireworks.ts:78

Generated using TypeDoc