Class ChatGroq

Wrapper around Groq API for large language models fine-tuned for chat

Groq API is compatible to the OpenAI API with some limitations. View the full API ref at:

Link

To use, you should have the GROQ_API_KEY environment variable set.

Example

const model = new ChatGroq({
  temperature: 0.9,
  apiKey: process.env.GROQ_API_KEY,
});

const response = await model.invoke([new HumanMessage("Hello there!")]);
console.log(response);

Hierarchy

Constructors

constructor

Properties

client model modelName streaming temperature maxTokens? stop? stopSequences?

Methods

bindTools completionWithRetry invocationParams withStructuredOutput

Constructors

constructor

Properties

client

client: Groq

model

model: string = "mixtral-8x7b-32768"

modelName

modelName: string = "mixtral-8x7b-32768"

streaming

streaming: boolean = false

temperature

temperature: number = 0.7

Optional maxTokens

maxTokens?: number

Optional stop

stop?: string[]

Optional stopSequences

stopSequences?: string[]

Methods

bindTools

completionWithRetry

  • completionWithRetry(request, options?): Promise<AsyncIterable<ChatCompletionChunk>>

  • Parameters

    • request: ChatCompletionCreateParamsStreaming
    • Optional options: any

    Returns Promise<AsyncIterable<ChatCompletionChunk>>

  • completionWithRetry(request, options?): Promise<ChatCompletion>

  • Parameters

    • request: ChatCompletionCreateParamsNonStreaming
    • Optional options: any

    Returns Promise<ChatCompletion>

invocationParams

withStructuredOutput

  • withStructuredOutput<RunOutput>(outputSchema, config?): Runnable<BaseLanguageModelInput, RunOutput, RunnableConfig>

  • Type Parameters

    • RunOutput extends Record<string, any> = Record<string, any>

    Parameters

    • outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>
    • Optional config: StructuredOutputMethodOptions<false>

    Returns Runnable<BaseLanguageModelInput, RunOutput, RunnableConfig>

  • withStructuredOutput<RunOutput>(outputSchema, config?): Runnable<BaseLanguageModelInput, {
        parsed: RunOutput;
        raw: BaseMessage;
    }, RunnableConfig>

  • Type Parameters

    • RunOutput extends Record<string, any> = Record<string, any>

    Parameters

    • outputSchema: Record<string, any> | ZodType<RunOutput, ZodTypeDef, RunOutput>
    • Optional config: StructuredOutputMethodOptions<true>

    Returns Runnable<BaseLanguageModelInput, {
        parsed: RunOutput;
        raw: BaseMessage;
    }, RunnableConfig>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc