UNPKG

@langchain/community

Version:
50 lines (49 loc) 2.24 kB
import type { BaseChatModelParams, LangSmithParams } from "@langchain/core/language_models/chat_models"; import { type OpenAIClient, type ChatOpenAICallOptions, type OpenAIChatInput, type OpenAICoreRequestOptions, ChatOpenAI } from "@langchain/openai"; type FireworksUnsupportedArgs = "frequencyPenalty" | "presencePenalty" | "logitBias" | "functions"; type FireworksUnsupportedCallOptions = "functions" | "function_call"; export type ChatFireworksCallOptions = Partial<Omit<ChatOpenAICallOptions, FireworksUnsupportedCallOptions>>; /** * 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 * ```typescript * const model = new ChatFireworks({ * temperature: 0.9, * apiKey: "YOUR-API-KEY", * }); * * const response = await model.invoke("Hello, how are you?"); * console.log(response); * ``` */ export declare class ChatFireworks extends ChatOpenAI<ChatFireworksCallOptions> { static lc_name(): string; _llmType(): string; get lc_secrets(): { [key: string]: string; } | undefined; lc_serializable: boolean; fireworksApiKey?: string; apiKey?: string; constructor(fields?: Partial<Omit<OpenAIChatInput, "openAIApiKey" | FireworksUnsupportedArgs>> & BaseChatModelParams & { /** * Prefer `apiKey` */ fireworksApiKey?: string; /** * The Fireworks API key to use. */ apiKey?: string; }); getLsParams(options: this["ParsedCallOptions"]): LangSmithParams; toJSON(): import("@langchain/core/load/serializable").Serialized; completionWithRetry(request: OpenAIClient.Chat.ChatCompletionCreateParamsStreaming, options?: OpenAICoreRequestOptions): Promise<AsyncIterable<OpenAIClient.Chat.Completions.ChatCompletionChunk>>; completionWithRetry(request: OpenAIClient.Chat.ChatCompletionCreateParamsNonStreaming, options?: OpenAICoreRequestOptions): Promise<OpenAIClient.Chat.Completions.ChatCompletion>; } export {};