yield_keys() — langchain Function Reference

Architecture documentation for the yield_keys() function in stores.py from the langchain codebase.

Function python LangChainCore ApiManagement calls 1 called by 1

Entity Profile

LangChainCore→ ApiManagement→ yield_keys() — langchain Function Reference

Dependency Diagram

graph TD
  71f3c37a_5c31_eb54_b796_d14b5b7fa05c["yield_keys()"]
  0ebcc119_721f_59ac_fdad_f204128f9add["BaseStore"]
  71f3c37a_5c31_eb54_b796_d14b5b7fa05c -->|defined in| 0ebcc119_721f_59ac_fdad_f204128f9add
  230cc8f7_3d41_cad0_26d1_a2124eeca404["yield_keys()"]
  230cc8f7_3d41_cad0_26d1_a2124eeca404 -->|calls| 71f3c37a_5c31_eb54_b796_d14b5b7fa05c
  230cc8f7_3d41_cad0_26d1_a2124eeca404["yield_keys()"]
  71f3c37a_5c31_eb54_b796_d14b5b7fa05c -->|calls| 230cc8f7_3d41_cad0_26d1_a2124eeca404
  style 71f3c37a_5c31_eb54_b796_d14b5b7fa05c fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/stores.py lines 137–148

    def yield_keys(self, *, prefix: str | None = None) -> Iterator[K] | Iterator[str]:
        """Get an iterator over keys that match the given prefix.

        Args:
            prefix: The prefix to match.

        Yields:
            An iterator over keys that match the given prefix.

                This method is allowed to return an iterator over either K or str
                depending on what makes more sense for the given store.
        """