langchain.js
    Preparing search index...

    Type Alias ChatGroqCallOptions

    ChatGroqCallOptions: Pick<
        ChatCompletionsAPI.ChatCompletionCreateParamsBase,
        typeof CREATE_PARAMS_BASE_CALL_KEYS[number],
    > & BaseDynamicToolInput & {
        headers?: Record<string, string | null | undefined>;
        promptIndex?: number;
        stream_options?: { include_usage: boolean };
        tools?: ChatGroqToolType[];
    }

    Type Declaration

    • Optionalheaders?: Record<string, string | null | undefined>

      Additional headers to pass to the API.

    • OptionalpromptIndex?: number

      The index of the prompt in the list of prompts.

    • Optionalstream_options?: { include_usage: boolean }

      Additional options to pass to streamed completions. If provided takes precedence over "streamUsage" set at initialization time.

      • include_usage: boolean

        Whether or not to include token usage in the stream. If set to true, this will include an additional chunk at the end of the stream with the token usage.

        Defaults to true when streaming, false otherwise.

    • Optionaltools?: ChatGroqToolType[]

    Settings

    Member Visibility