Class: FireworksLLM

Unified language model interface

Extends

• OpenAI

Constructors

new FireworksLLM()

new FireworksLLM(init?): FireworksLLM

Parameters

• init?: Omit<Partial<OpenAI>, "session">

Returns

FireworksLLM

Overrides

OpenAI.constructor

Defined in

packages/llamaindex/src/llm/fireworks.ts:5

Properties

additionalChatOptions?

optional additionalChatOptions: OpenAIAdditionalChatOptions

Inherited from

OpenAI.additionalChatOptions

Defined in

packages/providers/openai/dist/index.d.ts:309

---

additionalSessionOptions?

optional additionalSessionOptions: Omit<Partial<ClientOptions>, "apiKey" | "maxRetries" | "timeout">

Inherited from

OpenAI.additionalSessionOptions

Defined in

packages/providers/openai/dist/index.d.ts:313

---

apiKey?

optional apiKey: string

Inherited from

OpenAI.apiKey

Defined in

packages/providers/openai/dist/index.d.ts:310

---

lazySession()

lazySession: () => Promise<LLMInstance>

Returns

Promise<LLMInstance>

Inherited from

OpenAI.lazySession

Defined in

packages/providers/openai/dist/index.d.ts:314

---

maxRetries

maxRetries: number

Inherited from

OpenAI.maxRetries

Defined in

packages/providers/openai/dist/index.d.ts:311

---

maxTokens?

optional maxTokens: number

Inherited from

OpenAI.maxTokens

Defined in

packages/providers/openai/dist/index.d.ts:308

---

model

model: string & object | ChatModel

Inherited from

OpenAI.model

Defined in

packages/providers/openai/dist/index.d.ts:305

---

temperature

temperature: number

Inherited from

OpenAI.temperature

Defined in

packages/providers/openai/dist/index.d.ts:306

---

timeout?

optional timeout: number

Inherited from

OpenAI.timeout

Defined in

packages/providers/openai/dist/index.d.ts:312

---

topP

topP: number

Inherited from

OpenAI.topP

Defined in

packages/providers/openai/dist/index.d.ts:307

Accessors

metadata

get metadata(): LLMMetadata

Returns

LLMMetadata

Inherited from

OpenAI.metadata

Defined in

packages/providers/openai/dist/index.d.ts:321

---

session

get session(): Promise<LLMInstance>

Returns

Promise<LLMInstance>

Inherited from

OpenAI.session

Defined in

packages/providers/openai/dist/index.d.ts:315

---

supportToolCall

get supportToolCall(): boolean

Returns

boolean

Inherited from

OpenAI.supportToolCall

Defined in

packages/providers/openai/dist/index.d.ts:320

Methods

chat()

chat(params)

chat(params): Promise<AsyncIterable<ChatResponseChunk<ToolCallLLMMessageOptions>, any, any>>

Get a chat response from the LLM

Parameters

• params: LLMChatParamsStreaming<OpenAIAdditionalChatOptions, ToolCallLLMMessageOptions>

Returns

Promise<AsyncIterable<ChatResponseChunk<ToolCallLLMMessageOptions>, any, any>>

Inherited from

OpenAI.chat

Defined in

packages/providers/openai/dist/index.d.ts:324

chat(params)

chat(params): Promise<ChatResponse<ToolCallLLMMessageOptions>>

Get a chat response from the LLM

Parameters

• params: LLMChatParamsNonStreaming<OpenAIAdditionalChatOptions, ToolCallLLMMessageOptions>

Returns

Promise<ChatResponse<ToolCallLLMMessageOptions>>

Inherited from

OpenAI.chat

Defined in

packages/providers/openai/dist/index.d.ts:325

---

complete()

complete(params)

complete(params): Promise<AsyncIterable<CompletionResponse, any, any>>

Get a prompt completion from the LLM

Parameters

• params: LLMCompletionParamsStreaming

Returns

Promise<AsyncIterable<CompletionResponse, any, any>>

Inherited from

OpenAI.complete

Defined in

packages/core/llms/dist/index.d.ts:168

complete(params)

complete(params): Promise<CompletionResponse>

Get a prompt completion from the LLM

Parameters

• params: LLMCompletionParamsNonStreaming

Returns

Promise<CompletionResponse>

Inherited from

OpenAI.complete

Defined in

packages/core/llms/dist/index.d.ts:169

---

streamChat()

protected streamChat(baseRequestParams): AsyncIterable<ChatResponseChunk<ToolCallLLMMessageOptions>, any, any>

Parameters

• baseRequestParams: ChatCompletionCreateParams

Returns

AsyncIterable<ChatResponseChunk<ToolCallLLMMessageOptions>, any, any>

Inherited from

OpenAI.streamChat

Defined in

packages/providers/openai/dist/index.d.ts:326

---

toOpenAIMessage()

static toOpenAIMessage(messages): ChatCompletionMessageParam[]

Parameters

• messages: ChatMessage<ToolCallLLMMessageOptions>[]

Returns

ChatCompletionMessageParam[]

Inherited from

OpenAI.toOpenAIMessage

Defined in

packages/providers/openai/dist/index.d.ts:323

---

toOpenAIRole()

static toOpenAIRole(messageType): ChatCompletionRole

Parameters

• messageType: MessageType

Returns

ChatCompletionRole

Inherited from

OpenAI.toOpenAIRole

Defined in

packages/providers/openai/dist/index.d.ts:322

---

toTool()

static toTool(tool): ChatCompletionTool

Parameters

• tool: BaseTool<any>

Returns

ChatCompletionTool

Inherited from

OpenAI.toTool

Defined in

packages/providers/openai/dist/index.d.ts:327