ayield_keys() — langchain Function Reference

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

Function python LangChainCore ApiManagement

Entity Profile

LangChainCore→ ApiManagement→ ayield_keys() — langchain Function Reference

Dependency Diagram

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

Relationship Graph

Source Code

libs/langchain/langchain_classic/storage/encoder_backed.py lines 165–181

    async def ayield_keys(
        self,
        *,
        prefix: str | None = None,
    ) -> AsyncIterator[K] | AsyncIterator[str]:
        """Async 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.
        async for key in self.store.ayield_keys(prefix=prefix):
            yield key