afrom_examples() — langchain Function Reference

Architecture documentation for the afrom_examples() function in semantic_similarity.py from the langchain codebase.

Function python PromptManagement ExampleSelection calls 2 called by 1

Entity Profile

PromptManagement→ ExampleSelection→ afrom_examples() — langchain Function Reference

Dependency Diagram

graph TD
  40de7d0c_a965_0d15_94bd_2599e2519f07["afrom_examples()"]
  58a1328b_1470_20ec_61bd_ea7fb1fc8fa0["SemanticSimilarityExampleSelector"]
  40de7d0c_a965_0d15_94bd_2599e2519f07 -->|defined in| 58a1328b_1470_20ec_61bd_ea7fb1fc8fa0
  5e0b1c7d_4654_751e_77ea_c58bf89a18b7["afrom_examples()"]
  5e0b1c7d_4654_751e_77ea_c58bf89a18b7 -->|calls| 40de7d0c_a965_0d15_94bd_2599e2519f07
  5e0b1c7d_4654_751e_77ea_c58bf89a18b7["afrom_examples()"]
  40de7d0c_a965_0d15_94bd_2599e2519f07 -->|calls| 5e0b1c7d_4654_751e_77ea_c58bf89a18b7
  06f73539_fe12_1c9c_b0b0_60530c6bf341["_example_to_text()"]
  40de7d0c_a965_0d15_94bd_2599e2519f07 -->|calls| 06f73539_fe12_1c9c_b0b0_60530c6bf341
  style 40de7d0c_a965_0d15_94bd_2599e2519f07 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/example_selectors/semantic_similarity.py lines 181–222

    async def afrom_examples(
        cls,
        examples: list[dict],
        embeddings: Embeddings,
        vectorstore_cls: type[VectorStore],
        k: int = 4,
        input_keys: list[str] | None = None,
        *,
        example_keys: list[str] | None = None,
        vectorstore_kwargs: dict | None = None,
        **vectorstore_cls_kwargs: Any,
    ) -> SemanticSimilarityExampleSelector:
        """Async create k-shot example selector using example list and embeddings.

        Reshuffles examples dynamically based on query similarity.

        Args:
            examples: List of examples to use in the prompt.
            embeddings: An initialized embedding API interface, e.g. OpenAIEmbeddings().
            vectorstore_cls: A vector store DB interface class, e.g. FAISS.
            k: Number of examples to select.
            input_keys: If provided, the search is based on the input variables
                instead of all variables.
            example_keys: If provided, keys to filter examples to.
            vectorstore_kwargs: Extra arguments passed to similarity_search function
                of the `VectorStore`.
            vectorstore_cls_kwargs: optional kwargs containing url for vector store

        Returns:
            The ExampleSelector instantiated, backed by a vector store.
        """
        string_examples = [cls._example_to_text(eg, input_keys) for eg in examples]
        vectorstore = await vectorstore_cls.afrom_texts(
            string_examples, embeddings, metadatas=examples, **vectorstore_cls_kwargs
        )
        return cls(
            vectorstore=vectorstore,
            k=k,
            input_keys=input_keys,
            example_keys=example_keys,
            vectorstore_kwargs=vectorstore_kwargs,
        )