Home / Function/ _documents_to_examples() — langchain Function Reference

_documents_to_examples() — langchain Function Reference

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

Entity Profile

Dependency Diagram

graph TD
  27e09fc4_bf9b_d1a5_5626_387af543d2c7["_documents_to_examples()"]
  a80787c0_fd68_ab68_1e5d_400de9d4457f["_VectorStoreExampleSelector"]
  27e09fc4_bf9b_d1a5_5626_387af543d2c7 -->|defined in| a80787c0_fd68_ab68_1e5d_400de9d4457f
  d0986091_5176_ba9e_5c95_9bb7ca3162b9["select_examples()"]
  d0986091_5176_ba9e_5c95_9bb7ca3162b9 -->|calls| 27e09fc4_bf9b_d1a5_5626_387af543d2c7
  ff07acd4_d1e7_c5a7_504d_ed6733d8ee0d["aselect_examples()"]
  ff07acd4_d1e7_c5a7_504d_ed6733d8ee0d -->|calls| 27e09fc4_bf9b_d1a5_5626_387af543d2c7
  c03a4bd4_52ff_4d67_9b7b_92504d0181fb["select_examples()"]
  c03a4bd4_52ff_4d67_9b7b_92504d0181fb -->|calls| 27e09fc4_bf9b_d1a5_5626_387af543d2c7
  6e2cf8fc_7d12_860d_060c_d74b9a96affd["aselect_examples()"]
  6e2cf8fc_7d12_860d_060c_d74b9a96affd -->|calls| 27e09fc4_bf9b_d1a5_5626_387af543d2c7
  style 27e09fc4_bf9b_d1a5_5626_387af543d2c7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/core/langchain_core/example_selectors/semantic_similarity.py lines 57–64

    def _documents_to_examples(self, documents: list[Document]) -> list[dict]:
        # Get the examples from the metadata.
        # This assumes that examples are stored in metadata.
        examples = [dict(e.metadata) for e in documents]
        # If example keys are provided, filter examples to those keys.
        if self.example_keys:
            examples = [{k: eg[k] for k in self.example_keys} for eg in examples]
        return examples

Subdomains

Frequently Asked Questions

What does _documents_to_examples() do?
_documents_to_examples() is a function in the langchain codebase, defined in libs/core/langchain_core/example_selectors/semantic_similarity.py.
Where is _documents_to_examples() defined?
_documents_to_examples() is defined in libs/core/langchain_core/example_selectors/semantic_similarity.py at line 57.
What calls _documents_to_examples()?
_documents_to_examples() is called by 4 function(s): aselect_examples, aselect_examples, select_examples, select_examples.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free