LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • LangGraph Checkpoint
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    ⌘I

    LangChain Assistant

    Ask a question to get started

    Enter to send•Shift+Enter new line

    Menu

    LangGraph Checkpoint
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    Pythonlanggraph-clischemasIndexConfig
    Class●Since v0.4

    IndexConfig

    Copy
    IndexConfig()

    Bases

    TypedDict

    Used in Docs

    • How to use a custom store

    Constructors

    Attributes

    View source on GitHub
    constructor
    __init__
    NameType
    dimsint
    embedstr
    fieldslist[str] | None
    attribute
    dims: int

    Required. Dimensionality of the embedding vectors you will store.

    Must match the output dimension of your selected embedding model or custom embed function. If mismatched, you will likely encounter shape/size errors when inserting or querying vectors.

    attribute
    embed: str

    Required. Identifier or reference to the embedding model or a custom embedding function.

    attribute
    fields: list[str] | None

    Optional. List of JSON fields to extract before generating embeddings.

    Defaults to ["$"], which means the entire JSON object is embedded as one piece of text. If you provide multiple fields (e.g. ["title", "content"]), each is extracted and embedded separately, often saving token usage if you only care about certain parts of the data.

    Configuration for indexing documents for semantic search in the store.

    This governs how text is converted into embeddings and stored for vector-based lookups.