langchain Architecture Docs
Home / File/ chat_models.py — langchain Source File

chat_models.py — langchain Source File

Architecture documentation for chat_models.py, a python file in the langchain codebase. 14 imports, 0 dependents.

File python CoreAbstractions MessageSchema 14 imports 2 functions 1 classes

Entity Profile

Dependency Diagram

graph LR
  2bc6b067_a2fb_3eef_c25f_813db66d509a["chat_models.py"]
  0c635125_6987_b8b3_7ff7_d60249aecde7["warnings"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> 0c635125_6987_b8b3_7ff7_d60249aecde7
  8e2034b7_ceb8_963f_29fc_2ea6b50ef9b3["typing"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> 8e2034b7_ceb8_963f_29fc_2ea6b50ef9b3
  45fc8fd3_e815_b442_a6d1_0dedc9327b62["openai"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> 45fc8fd3_e815_b442_a6d1_0dedc9327b62
  d758344f_537f_649e_f467_b9d7442e86df["langchain_core.messages"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> d758344f_537f_649e_f467_b9d7442e86df
  f4d905c6_a2b2_eb8f_be9b_7808b72f6a16["langchain_core.utils"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> f4d905c6_a2b2_eb8f_be9b_7808b72f6a16
  ef0b6fc5_6cf5_c982_78be_65b7adea64a3["langchain_openai.chat_models.base"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> ef0b6fc5_6cf5_c982_78be_65b7adea64a3
  6e58aaea_f08e_c099_3cc7_f9567bfb1ae7["pydantic"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> 6e58aaea_f08e_c099_3cc7_f9567bfb1ae7
  91721f45_4909_e489_8c1f_084f8bd87145["typing_extensions"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> 91721f45_4909_e489_8c1f_084f8bd87145
  c2208065_50f6_fa3a_c96d_5519363b45cf["langchain_xai.data._profiles"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> c2208065_50f6_fa3a_c96d_5519363b45cf
  cfe2bde5_180e_e3b0_df2b_55b3ebaca8e7["collections.abc"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> cfe2bde5_180e_e3b0_df2b_55b3ebaca8e7
  ba43b74d_3099_7e1c_aac3_cf594720469e["langchain_core.language_models"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> ba43b74d_3099_7e1c_aac3_cf594720469e
  2312f229_c199_ac88_c29f_62e2a2958404["langchain_core.language_models.chat_models"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> 2312f229_c199_ac88_c29f_62e2a2958404
  ac2a9b92_4484_491e_1b48_ec85e71e1d58["langchain_core.outputs"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> ac2a9b92_4484_491e_1b48_ec85e71e1d58
  2ceb1686_0f8c_8ae0_36d1_7c0b702fda1c["langchain_core.runnables"]
  2bc6b067_a2fb_3eef_c25f_813db66d509a --> 2ceb1686_0f8c_8ae0_36d1_7c0b702fda1c
  style 2bc6b067_a2fb_3eef_c25f_813db66d509a fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

"""Wrapper around xAI's Chat Completions API."""

from __future__ import annotations

import warnings
from typing import TYPE_CHECKING, Any, Literal, TypeAlias, cast

import openai
from langchain_core.messages import AIMessageChunk
from langchain_core.utils import secret_from_env
from langchain_openai.chat_models.base import BaseChatOpenAI
from pydantic import BaseModel, ConfigDict, Field, SecretStr, model_validator
from typing_extensions import Self

from langchain_xai.data._profiles import _PROFILES

if TYPE_CHECKING:
    from collections.abc import AsyncIterator, Iterator

    from langchain_core.language_models import (
        ModelProfile,
        ModelProfileRegistry,
    )
    from langchain_core.language_models.chat_models import (
        LangSmithParams,
        LanguageModelInput,
    )
    from langchain_core.outputs import ChatGenerationChunk, ChatResult
    from langchain_core.runnables import Runnable

_DictOrPydanticClass: TypeAlias = dict[str, Any] | type[BaseModel] | type
_DictOrPydantic: TypeAlias = dict | BaseModel


_MODEL_PROFILES = cast("ModelProfileRegistry", _PROFILES)


def _get_default_model_profile(model_name: str) -> ModelProfile:
    default = _MODEL_PROFILES.get(model_name) or {}
    return default.copy()


class ChatXAI(BaseChatOpenAI):  # type: ignore[override]
    r"""ChatXAI chat model.

    Refer to [xAI's documentation](https://docs.x.ai/docs/api-reference#chat-completions)
    for more nuanced details on the API's behavior and supported parameters.

    Setup:
        Install `langchain-xai` and set environment variable `XAI_API_KEY`.

        ```bash
        pip install -U langchain-xai
        export XAI_API_KEY="your-api-key"
        ```

    Key init args — completion params:
        model:
            Name of model to use.
        temperature:
// ... (675 more lines)

Domain

Subdomains

Functions

Classes

Dependencies

  • collections.abc
  • langchain_core.language_models
  • langchain_core.language_models.chat_models
  • langchain_core.messages
  • langchain_core.outputs
  • langchain_core.runnables
  • langchain_core.utils
  • langchain_openai.chat_models.base
  • langchain_xai.data._profiles
  • openai
  • pydantic
  • typing
  • typing_extensions
  • warnings

Source

Frequently Asked Questions

What does chat_models.py do?
chat_models.py is a source file in the langchain codebase, written in python. It belongs to the CoreAbstractions domain, MessageSchema subdomain.
What functions are defined in chat_models.py?
chat_models.py defines 2 function(s): _get_default_model_profile, collections.
What does chat_models.py depend on?
chat_models.py imports 14 module(s): collections.abc, langchain_core.language_models, langchain_core.language_models.chat_models, langchain_core.messages, langchain_core.outputs, langchain_core.runnables, langchain_core.utils, langchain_openai.chat_models.base, and 6 more.
Where is chat_models.py in the architecture?
chat_models.py is located at libs/partners/xai/langchain_xai/chat_models.py (domain: CoreAbstractions, subdomain: MessageSchema, directory: libs/partners/xai/langchain_xai).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free