Class ChatGroq

libs/partners/groq/langchain_groq/chat_models.py:82–1050

`Groq` Chat large language models API. To use, you should have the environment variable ``GROQ_API_KEY`` set with your API key. Any parameters that are valid to be passed to the groq.create call can be passed in, even if not explicitly saved on this class. Example: ..

class ChatGroq(BaseChatModel):
    """`Groq` Chat large language models API.

    To use, you should have the
    environment variable ``GROQ_API_KEY`` set with your API key.

    Any parameters that are valid to be passed to the groq.create call
    can be passed in, even if not explicitly saved on this class.

    Example:
        .. code-block:: python

            from langchain_groq import ChatGroq

            model = ChatGroq(model_name="mixtral-8x7b-32768")

    Setup:
        Install ``langchain-groq`` and set environment variable
        ``GROQ_API_KEY``.

        .. code-block:: bash

            pip install -U langchain-groq
            export GROQ_API_KEY="your-api-key"

    Key init args — completion params:
        model: str
            Name of Groq model to use. E.g. "mixtral-8x7b-32768".
        temperature: float
            Sampling temperature. Ranges from 0.0 to 1.0.
        max_tokens: Optional[int]
            Max number of tokens to generate.
        model_kwargs: Dict[str, Any]
            Holds any model parameters valid for create call not
            explicitly specified.

    Key init args — client params:
        timeout: Union[float, Tuple[float, float], Any, None]
            Timeout for requests.
        max_retries: int
            Max number of retries.
        api_key: Optional[str]
            Groq API key. If not passed in will be read from env var GROQ_API_KEY.
        base_url: Optional[str]
            Base URL path for API requests, leave blank if not using a proxy
            or service emulator.
        custom_get_token_ids: Optional[Callable[[str], List[int]]]
            Optional encoder to use for counting tokens.

    See full list of supported init args and their descriptions in the params
    section.

    Instantiate:
        .. code-block:: python

            from langchain_groq import ChatGroq

            model = ChatGroq(