yield_keys() — langchain Function Reference

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

Function python LangChainCore MessageInterface

Entity Profile

LangChainCore→ MessageInterface→ yield_keys() — langchain Function Reference

Dependency Diagram

graph TD
  ca5522dc_f6ce_ec62_d9f3_03ab997a8865["yield_keys()"]
  735a81c9_6f78_0114_db70_cd34c4599651["EncoderBackedStore"]
  ca5522dc_f6ce_ec62_d9f3_03ab997a8865 -->|defined in| 735a81c9_6f78_0114_db70_cd34c4599651
  style ca5522dc_f6ce_ec62_d9f3_03ab997a8865 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/langchain/langchain_classic/storage/encoder_backed.py lines 148–163

    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:
            Keys that match the given prefix.
        """
        # For the time being this does not return K, but str
        # it's for debugging purposes. Should fix this.
        yield from self.store.yield_keys(prefix=prefix)