LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • LangGraph Checkpoint
    LangGraph Store
    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
    LangGraph Store
    Checkpoint Postgres
    Store Postgres
    Checkpoint SQLite
    LangGraph Prebuilt
    LangGraph CLI
    LangGraph SDK
    LangGraph Supervisor
    LangGraph Swarm
    Language
    Theme
    Pythonlanggraph.storebasePutOpindex
    Attribute●Since v2.0

    index

    Controls how the item's fields are indexed for search operations.

    Copy
    index: Literal[False] | list[str] | None = None

    Indexing configuration determines how the item can be found through search:

    • None (default): Uses the store's default indexing configuration (if provided)
    • False: Disables indexing for this item
    • list[str]: Specifies which json path fields to index for search

    The item remains accessible through direct get() operations regardless of indexing. When indexed, fields can be searched using natural language queries through vector similarity search (if supported by the store implementation).

    Path Syntax:

    • Simple field access: "field"

    • Nested fields: "parent.child.grandchild"

    • Array indexing:

      • Specific index: "array[0]"
      • Last element: "array[-1]"
      • All elements (each individually): "array[*]"
    • None - Use store defaults (whole item)

    • list[str] - List of fields to index

    [
        "metadata.title",                    # Nested field access
        "context[*].content",                # Index content from all context as separate vectors
        "authors[0].name",                   # First author's name
        "revisions[-1].changes",             # Most recent revision's changes
        "sections[*].paragraphs[*].text",    # All text from all paragraphs in all sections
        "metadata.tags[*]",                  # All tags in metadata
    ]
    View source on GitHub