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);
    httpAgent?: any;
    maxConcurrency?: number;
    maxRetries?: number;
    maxTokens?: number;
    metadata?: Record<string, unknown>;
    model: string;
    onFailedAttempt?: FailedAttemptHandler;
    stop?: null | string | string[];
    stopSequences?: string[];
    streaming?: boolean;
    tags?: string[];
    temperature?: number;
    timeout?: number;
    verbose?: boolean;
}

Hierarchy

  • BaseChatModelParams
    • ChatGroqInput

Properties

apiKey? baseUrl? cache? callbackManager? callbacks? defaultHeaders? defaultQuery? disableStreaming? fetch? httpAgent? maxConcurrency? maxRetries? maxTokens? metadata? model onFailedAttempt? stop? stopSequences? streaming? tags? temperature? timeout? 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

OptionalhttpAgent

httpAgent?: any

HTTP agent used to manage connections

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.

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.

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.

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

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties