Interface ChatGroqInput

interface ChatGroqInput {
    apiKey?: string;
    baseUrl?: string;
    cache?: boolean | BaseCache<Generation[]>;
    callbackManager?: CallbackManager;
    callbacks?: Callbacks;
    defaultHeaders?: Record<string, string>;
    defaultQuery?: Record<string, string>;
    disableStreaming?: boolean;
    fetch?: ((...args: any) => any);
    frequencyPenalty?: number;
    httpAgent?: any;
    logitBias?: Record<string, number>;
    logprobs?: boolean;
    maxConcurrency?: number;
    maxRetries?: number;
    maxTokens?: number;
    metadata?: Record<string, unknown>;
    model: string;
    n?: number;
    onFailedAttempt?: FailedAttemptHandler;
    presencePenalty?: number;
    stop?: null | string | string[];
    stopSequences?: string[];
    streamUsage?: boolean;
    streaming?: boolean;
    tags?: string[];
    temperature?: number;
    timeout?: number;
    topLogprobs?: number;
    topP?: number;
    user?: string;
    verbose?: boolean;
}

Hierarchy

  • BaseChatModelParams
    • ChatGroqInput

Properties

apiKey? baseUrl? cache? callbackManager? callbacks? defaultHeaders? defaultQuery? disableStreaming? fetch? frequencyPenalty? httpAgent? logitBias? logprobs? maxConcurrency? maxRetries? maxTokens? metadata? model n? onFailedAttempt? presencePenalty? stop? stopSequences? streamUsage? streaming? tags? temperature? timeout? topLogprobs? topP? user? verbose?

Properties

OptionalapiKey

apiKey?: string

The Groq API key to use for requests.

Default

process.env.GROQ_API_KEY

OptionalbaseUrl

baseUrl?: string

Override the default base URL for the API

Optionalcache

cache?: boolean | BaseCache<Generation[]>

OptionalcallbackManager

callbackManager?: CallbackManager

Deprecated

Use callbacks instead

Optionalcallbacks

callbacks?: Callbacks

OptionaldefaultHeaders

defaultHeaders?: Record<string, string>

Default headers included with every request

OptionaldefaultQuery

defaultQuery?: Record<string, string>

Default query parameters included with every request

OptionaldisableStreaming

disableStreaming?: boolean

Whether to disable streaming.

If streaming is bypassed, then stream() will defer to invoke().

  • If true, will always bypass streaming case.
  • If false (default), will always use streaming case if available.

Optionalfetch

fetch?: ((...args: any) => any)

Custom fetch function implementation

OptionalfrequencyPenalty

frequencyPenalty?: number

Penalizes repeated tokens according to frequency

OptionalhttpAgent

httpAgent?: any

HTTP agent used to manage connections

OptionallogitBias

logitBias?: Record<string, number>

Dictionary used to adjust the probability of specific tokens being generated

Optionallogprobs

logprobs?: boolean

Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

OptionalmaxTokens

maxTokens?: number

The maximum number of tokens that the model can process in a single response. This limits ensures computational efficiency and resource management.

Optionalmetadata

metadata?: Record<string, unknown>

model

model: string

The name of the model to use.

Optionaln

n?: number

Number of completions to generate for each prompt

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

OptionalpresencePenalty

presencePenalty?: number

Penalizes repeated tokens

Optionalstop

stop?: null | string | string[]

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. Alias for stopSequences

OptionalstopSequences

stopSequences?: string[]

Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.

OptionalstreamUsage

streamUsage?: boolean

Whether or not to include token usage data in streamed chunks.

Default

true

Optionalstreaming

streaming?: boolean

Whether or not to stream responses.

Optionaltags

tags?: string[]

Optionaltemperature

temperature?: number

The temperature to use for sampling.

Default

0.7

Optionaltimeout

timeout?: number

The maximum amount of time (in milliseconds) the client will wait for a response

OptionaltopLogprobs

topLogprobs?: number

An integer between 0 and 5 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

OptionaltopP

topP?: number

Total probability mass of tokens to consider at each step

Optionaluser

user?: string

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

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties