StructuredQuery Class — langchain Architecture

Architecture documentation for the StructuredQuery class in structured_query.py from the langchain codebase.

Class python

Entity Profile

Dependency Diagram

graph TD
  42424acc_ea0c_27ce_8240_958de462ee07["StructuredQuery"]
  ce7f9330_c85c_8cab_391e_08d83c35d973["Expr"]
  42424acc_ea0c_27ce_8240_958de462ee07 -->|extends| ce7f9330_c85c_8cab_391e_08d83c35d973
  2910db70_4057_4517_fbc4_a618465c787c["structured_query.py"]
  42424acc_ea0c_27ce_8240_958de462ee07 -->|defined in| 2910db70_4057_4517_fbc4_a618465c787c
  68ea126f_2f56_debe_189a_d09f7df86867["__init__()"]
  42424acc_ea0c_27ce_8240_958de462ee07 -->|method| 68ea126f_2f56_debe_189a_d09f7df86867

Relationship Graph

Source Code

libs/core/langchain_core/structured_query.py lines 176–203

class StructuredQuery(Expr):
    """Structured query."""

    query: str
    """Query string."""

    filter: FilterDirective | None
    """Filtering expression."""

    limit: int | None
    """Limit on the number of results."""

    def __init__(
        self,
        query: str,
        filter: FilterDirective | None,  # noqa: A002
        limit: int | None = None,
        **kwargs: Any,
    ) -> None:
        """Create a StructuredQuery.

        Args:
            query: The query string.
            filter: The filtering expression.
            limit: The limit on the number of results.
        """
        # super exists from BaseModel
        super().__init__(query=query, filter=filter, limit=limit, **kwargs)