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,
  fireworksApiKey: "YOUR-API-KEY",
});

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

Hierarchy

ChatOpenAI<ChatFireworksCallOptions>
- ChatFireworks

Constructors

constructor

new ChatFireworks(fields?): ChatFireworks
Parameters
- Optional fields: Partial<Omit<OpenAIChatInput, "openAIApiKey" | FireworksUnsupportedArgs>> & BaseLanguageModelParams & {
  fireworksApiKey?: string;
  }
Returns ChatFireworks
Overrides ChatOpenAI.constructor
- Defined in docs/api_refs/langchain/src/chat_models/fireworks.ts:62

Properties

CallOptions

CallOptions: Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

ParsedCallOptions

ParsedCallOptions: Omit<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>, never>

caller

caller: AsyncCaller

The async caller should be used by subclasses to make any async calls, which will thus benefit from the concurrency and retry logic.

frequencyPenalty

frequencyPenalty: number = 0

Penalizes repeated tokens according to frequency

modelName

modelName: string = "gpt-3.5-turbo"

Model name to use

n

n: number = 1

Number of completions to generate for each prompt

presencePenalty

presencePenalty: number = 0

Penalizes repeated tokens

streaming

streaming: boolean = false

Whether to stream the results or not. Enabling disables tokenUsage reporting

temperature

temperature: number = 1

Sampling temperature to use

topP

topP: number = 1

Total probability mass of tokens to consider at each step

verbose

verbose: boolean

Whether to print out response text.

`Optional` azureOpenAIApiDeploymentName

azureOpenAIApiDeploymentName?: string

Azure OpenAI API deployment name to use for completions when making requests to Azure OpenAI. This is the name of the deployment you created in the Azure portal. e.g. "my-openai-deployment" this will be used in the endpoint URL: https://{InstanceName}.openai.azure.com/openai/deployments/my-openai-deployment/

`Optional` azureOpenAIApiInstanceName

azureOpenAIApiInstanceName?: string

Azure OpenAI API instance name to use when making requests to Azure OpenAI. this is the name of the instance you created in the Azure portal. e.g. "my-openai-instance" this will be used in the endpoint URL: https://my-openai-instance.openai.azure.com/openai/deployments/{DeploymentName}/

`Optional` azureOpenAIApiKey

azureOpenAIApiKey?: string

API key to use when making requests to Azure OpenAI.

`Optional` azureOpenAIApiVersion

azureOpenAIApiVersion?: string

API version to use when making requests to Azure OpenAI.

`Optional` azureOpenAIBasePath

azureOpenAIBasePath?: string

Custom endpoint for Azure OpenAI API. This is useful in case you have a deployment in another region. e.g. setting this value to "https://westeurope.api.cognitive.microsoft.com/openai/deployments" will be result in the endpoint URL: https://westeurope.api.cognitive.microsoft.com/openai/deployments/{DeploymentName}/

`Optional` cache

cache?: BaseCache<Generation[]>

`Optional` callbacks

callbacks?: Callbacks

`Optional` fireworksApiKey

fireworksApiKey?: string

`Optional` logitBias

logitBias?: Record<string, number>

Dictionary used to adjust the probability of specific tokens being generated

`Optional` maxTokens

maxTokens?: number

Maximum number of tokens to generate in the completion. -1 returns as many tokens as possible given the prompt and the model's maximum context size.

`Optional` metadata

metadata?: Record<string, unknown>

`Optional` modelKwargs

modelKwargs?: Record<string, any>

Holds any additional parameters that are valid to pass to openai.createCompletion that are not explicitly specified on this class.

`Optional` openAIApiKey

openAIApiKey?: string

API key to use when making requests to OpenAI. Defaults to the value of OPENAI_API_KEY environment variable.

`Optional` organization

organization?: string

`Optional` stop

stop?: string[]

List of stop words to use when generating

`Optional` tags

tags?: string[]

`Optional` timeout

timeout?: number

Timeout to use when making requests to OpenAI.

`Optional` user

user?: string

Unique string identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Accessors

callKeys

get callKeys(): string[]
Keys that the language model accepts as call options.

Returns string[]
Inherited from ChatOpenAI.callKeys
- Defined in docs/api_refs/langchain/src/chat_models/openai.ts:223

Methods

batch

batch(inputs, options?, batchOptions?): Promise<BaseMessageChunk[]>
Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.
Parameters
- inputs: BaseLanguageModelInput[]
  
  Array of inputs to each batch call.
- Optional options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]
  
  Either a single call options object to apply to each batch call or an array for each call.
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions?: false;
  }
Returns Promise<BaseMessageChunk[]>
An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Inherited from ChatOpenAI.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:159
batch(inputs, options?, batchOptions?): Promise<(BaseMessageChunk | Error)[]>
Parameters
- inputs: BaseLanguageModelInput[]
- Optional options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(BaseMessageChunk | Error)[]>
Inherited from ChatOpenAI.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:165
batch(inputs, options?, batchOptions?): Promise<(BaseMessageChunk | Error)[]>
Parameters
- inputs: BaseLanguageModelInput[]
- Optional options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(BaseMessageChunk | Error)[]>
Inherited from ChatOpenAI.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:171

bind

bind(kwargs): Runnable<BaseLanguageModelInput, BaseMessageChunk, Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
Returns Runnable<BaseLanguageModelInput, BaseMessageChunk, Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from ChatOpenAI.bind
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:67

call

call(messages, options?, callbacks?): Promise<BaseMessage>
Makes a single call to the chat model.
Parameters
- messages: BaseMessageLike[]
  
  An array of BaseMessage instances.
- Optional options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>
  
  The call options or an array of stop sequences.
- Optional callbacks: Callbacks
  
  The callbacks for the language model.
Returns Promise<BaseMessage>
A Promise that resolves to a BaseMessage.
Inherited from ChatOpenAI.call
- Defined in docs/api_refs/langchain/src/chat_models/base.ts:434

callPrompt

callPrompt(promptValue, options?, callbacks?): Promise<BaseMessage>
Makes a single call to the chat model with a prompt value.
Parameters
- promptValue: BasePromptValue
  
  The value of the prompt.
- Optional options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>
  
  The call options or an array of stop sequences.
- Optional callbacks: Callbacks
  
  The callbacks for the language model.
Returns Promise<BaseMessage>
A Promise that resolves to a BaseMessage.
Inherited from ChatOpenAI.callPrompt
- Defined in docs/api_refs/langchain/src/chat_models/base.ts:455

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: OpenAICoreRequestOptions
  
  Optional configuration for the API call.
Returns Promise<AsyncIterable<ChatCompletionChunk>>
The response from the Fireworks API.
Overrides ChatOpenAI.completionWithRetry
- Defined in docs/api_refs/langchain/src/chat_models/fireworks.ts:105
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: OpenAICoreRequestOptions
  
  Optional configuration for the API call.
Returns Promise<ChatCompletion>
The response from the Fireworks API.
Overrides ChatOpenAI.completionWithRetry
- Defined in docs/api_refs/langchain/src/chat_models/fireworks.ts:110

generate

generate(messages, options?, callbacks?): Promise<LLMResult>
Generates chat based on the input messages.
Parameters
- messages: BaseMessageLike[][]
  
  An array of arrays of BaseMessage instances.
- Optional options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>
  
  The call options or an array of stop sequences.
- Optional callbacks: Callbacks
  
  The callbacks for the language model.
Returns Promise<LLMResult>
A Promise that resolves to an LLMResult.
Inherited from ChatOpenAI.generate
- Defined in docs/api_refs/langchain/src/chat_models/base.ts:306

generatePrompt

generatePrompt(promptValues, options?, callbacks?): Promise<LLMResult>
Generates a prompt based on the input prompt values.
Parameters
- promptValues: BasePromptValue[]
  
  An array of BasePromptValue instances.
- Optional options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>
  
  The call options or an array of stop sequences.
- Optional callbacks: Callbacks
  
  The callbacks for the language model.
Returns Promise<LLMResult>
A Promise that resolves to an LLMResult.
Inherited from ChatOpenAI.generatePrompt
- Defined in docs/api_refs/langchain/src/chat_models/base.ts:409

getNumTokens

getNumTokens(content): Promise<number>
Parameters
- content: MessageContent
Returns Promise<number>
Inherited from ChatOpenAI.getNumTokens
- Defined in docs/api_refs/langchain/src/base_language/index.ts:201

getNumTokensFromMessages

getNumTokensFromMessages(messages): Promise<{
countPerMessage: number[];
totalCount: number;
}>
Parameters
- messages: BaseMessage[]
Returns Promise<{
countPerMessage: number[];
totalCount: number;
}>
Inherited from ChatOpenAI.getNumTokensFromMessages
- Defined in docs/api_refs/langchain/src/chat_models/openai.ts:673

identifyingParams

identifyingParams(): Omit<ChatCompletionCreateParams, "messages"> & {
model_name: string;
} & ClientOptions
Get the identifying parameters for the model

Returns Omit<ChatCompletionCreateParams, "messages"> & {
model_name: string;
} & ClientOptions
Inherited from ChatOpenAI.identifyingParams
- Defined in docs/api_refs/langchain/src/chat_models/openai.ts:512

invocationParams

invocationParams(options?): Omit<ChatCompletionCreateParams, "messages">
Get the parameters used to invoke the model
Parameters
- Optional options: Omit<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>, never>
Returns Omit<ChatCompletionCreateParams, "messages">
Inherited from ChatOpenAI.invocationParams
- Defined in docs/api_refs/langchain/src/chat_models/openai.ts:395

invoke

invoke(input, options?): Promise<BaseMessageChunk>
Invokes the chat model with a single input.
Parameters
- input: BaseLanguageModelInput
  
  The input for the language model.
- Optional options: Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>
  
  The call options.
Returns Promise<BaseMessageChunk>
A Promise that resolves to a BaseMessageChunk.
Inherited from ChatOpenAI.invoke
- Defined in docs/api_refs/langchain/src/chat_models/base.ts:120

map

map(): Runnable<BaseLanguageModelInput[], BaseMessageChunk[], Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

Returns Runnable<BaseLanguageModelInput[], BaseMessageChunk[], Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
Inherited from ChatOpenAI.map
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:78

pipe

pipe<NewRunOutput>(coerceable): RunnableSequence<BaseLanguageModelInput, Exclude<NewRunOutput, Error>>
Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.
Type Parameters
- NewRunOutput
Parameters
- coerceable: RunnableLike<BaseMessageChunk, NewRunOutput>
  
  A runnable, function, or object whose values are functions or runnables.
Returns RunnableSequence<BaseLanguageModelInput, Exclude<NewRunOutput, Error>>
A new runnable sequence.
Inherited from ChatOpenAI.pipe
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:461

predict

predict(text, options?, callbacks?): Promise<string>
Predicts the next message based on a text input.
Parameters
- text: string
  
  The text input.
- Optional options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>
  
  The call options or an array of stop sequences.
- Optional callbacks: Callbacks
  
  The callbacks for the language model.
Returns Promise<string>
A Promise that resolves to a string.
Inherited from ChatOpenAI.predict
- Defined in docs/api_refs/langchain/src/chat_models/base.ts:486

predictMessages

predictMessages(messages, options?, callbacks?): Promise<BaseMessage>
Predicts the next message based on the input messages.
Parameters
- messages: BaseMessage[]
  
  An array of BaseMessage instances.
- Optional options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>
  
  The call options or an array of stop sequences.
- Optional callbacks: Callbacks
  
  The callbacks for the language model.
Returns Promise<BaseMessage>
A Promise that resolves to a BaseMessage.
Inherited from ChatOpenAI.predictMessages
- Defined in docs/api_refs/langchain/src/chat_models/base.ts:471

serialize

serialize(): SerializedLLM
Returns SerializedLLM

Deprecated
Return a json-like object representing this LLM.
Inherited from ChatOpenAI.serialize
- Defined in docs/api_refs/langchain/src/chat_models/base.ts:394

stream

stream(input, options?): Promise<IterableReadableStream<BaseMessageChunk>>
Stream output in chunks.
Parameters
- input: BaseLanguageModelInput
- Optional options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
Returns Promise<IterableReadableStream<BaseMessageChunk>>
A readable stream that is also an iterable.
Inherited from ChatOpenAI.stream
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:225

streamLog

streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>
Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.
Parameters
- input: BaseLanguageModelInput
- Optional options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
- Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">
Returns AsyncGenerator<RunLogPatch, any, unknown>
Inherited from ChatOpenAI.streamLog
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:507

toJSON

toJSON(): Serialized
Returns Serialized
Overrides ChatOpenAI.toJSON
- Defined in docs/api_refs/langchain/src/chat_models/fireworks.ts:90

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from ChatOpenAI.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

transform

transform(generator, options): AsyncGenerator<BaseMessageChunk, any, unknown>
Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.
Parameters
- generator: AsyncGenerator<BaseLanguageModelInput, any, unknown>
- options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
Returns AsyncGenerator<BaseMessageChunk, any, unknown>
Inherited from ChatOpenAI.transform
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:478

withConfig

withConfig(config): RunnableBinding<BaseLanguageModelInput, BaseMessageChunk, Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: BaseCallbackConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<BaseLanguageModelInput, BaseMessageChunk, Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
A new RunnableBinding with a config matching what's passed.
Inherited from ChatOpenAI.withConfig
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:107

withFallbacks

withFallbacks(fields): RunnableWithFallbacks<BaseLanguageModelInput, BaseMessageChunk>
Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
Parameters
- fields: {
  fallbacks: Runnable<BaseLanguageModelInput, BaseMessageChunk, BaseCallbackConfig>[];
  }
  - fallbacks: Runnable<BaseLanguageModelInput, BaseMessageChunk, BaseCallbackConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<BaseLanguageModelInput, BaseMessageChunk>
A new RunnableWithFallbacks.
Inherited from ChatOpenAI.withFallbacks
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:124

withRetry

withRetry(fields?): RunnableRetry<BaseLanguageModelInput, BaseMessageChunk, Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<BaseLanguageModelInput, BaseMessageChunk, Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from ChatOpenAI.withRetry
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:88

`Static` deserialize

deserialize(data): Promise<BaseLanguageModel<any, BaseLanguageModelCallOptions>>
Parameters
- data: SerializedLLM
Returns Promise<BaseLanguageModel<any, BaseLanguageModelCallOptions>>

Deprecated
Load an LLM from a json-like object describing it.
Inherited from ChatOpenAI.deserialize
- Defined in docs/api_refs/langchain/src/base_language/index.ts:295

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, BaseCallbackConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, BaseCallbackConfig>
Inherited from ChatOpenAI.isRunnable
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:557

Class ChatFireworks

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional fields: Partial<Omit<OpenAIChatInput, "openAIApiKey" | FireworksUnsupportedArgs>> & BaseLanguageModelParams & { fireworksApiKey?: string; }

Returns ChatFireworks

Properties

CallOptions

ParsedCallOptions

caller

frequencyPenalty

modelName

n

presencePenalty

streaming

temperature

topP

verbose

Optional azureOpenAIApiDeploymentName

Optional azureOpenAIApiInstanceName

Optional azureOpenAIApiKey

Optional azureOpenAIApiVersion

Optional azureOpenAIBasePath

Optional cache

Optional callbacks

Optional fireworksApiKey

Optional logitBias

Optional maxTokens

Optional metadata

Optional modelKwargs

Optional openAIApiKey

Optional organization

Optional stop

Optional tags

Optional timeout

Optional user

Accessors

callKeys

Returns string[]

Methods

batch

Parameters

inputs: BaseLanguageModelInput[]

Optional options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions?: false; }

Returns Promise<BaseMessageChunk[]>

Parameters

inputs: BaseLanguageModelInput[]

Optional options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(BaseMessageChunk | Error)[]>

Parameters

inputs: BaseLanguageModelInput[]

Optional options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(BaseMessageChunk | Error)[]>

bind

Parameters

kwargs: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>

Returns Runnable<BaseLanguageModelInput, BaseMessageChunk, Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>

call

Parameters

messages: BaseMessageLike[]

Optional options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

Optional callbacks: Callbacks

Returns Promise<BaseMessage>

callPrompt

Parameters

promptValue: BasePromptValue

Optional options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

Optional callbacks: Callbacks

Returns Promise<BaseMessage>

completionWithRetry

`Optional` fields: Partial<Omit<OpenAIChatInput, "openAIApiKey" | FireworksUnsupportedArgs>> & BaseLanguageModelParams & {
fireworksApiKey?: string;
}

`Optional` azureOpenAIApiDeploymentName

`Optional` azureOpenAIApiInstanceName

`Optional` azureOpenAIApiKey

`Optional` azureOpenAIApiVersion

`Optional` azureOpenAIBasePath

`Optional` cache

`Optional` callbacks

`Optional` fireworksApiKey

`Optional` logitBias

`Optional` maxTokens

`Optional` metadata

`Optional` modelKwargs

`Optional` openAIApiKey

`Optional` organization

`Optional` stop

`Optional` tags

`Optional` timeout

`Optional` user

`Optional` options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions?: false;
}

`Optional` options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>> | Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>[]

`Optional` batchOptions: RunnableBatchOptions

`Optional` options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

`Optional` callbacks: Callbacks

`Optional` options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

`Optional` callbacks: Callbacks

`Optional` options: OpenAICoreRequestOptions

`Optional` options: OpenAICoreRequestOptions

`Optional` options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

`Optional` callbacks: Callbacks

`Optional` options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

`Optional` callbacks: Callbacks

Returns Promise<{
countPerMessage: number[];
totalCount: number;
}>

Returns Omit<ChatCompletionCreateParams, "messages"> & {
model_name: string;
} & ClientOptions

`Optional` options: Omit<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>, never>

`Optional` options: Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

`Optional` options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

`Optional` callbacks: Callbacks

`Optional` options: string[] | Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>

`Optional` callbacks: Callbacks

`Optional` options: Partial<Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>>