num_results_arg_name() — langchain Function Reference

Architecture documentation for the num_results_arg_name() function in retrievers.py from the langchain codebase.

Function python LangChainCore Runnables

Entity Profile

LangChainCore→ Runnables→ num_results_arg_name() — langchain Function Reference

Dependency Diagram

graph TD
  5b35e19e_9b3e_d1c6_aaa8_cc0ac8aa3ea2["num_results_arg_name()"]
  832b9ba1_75e8_ad0c_71b4_3f5c6d4c0825["RetrieversIntegrationTests"]
  5b35e19e_9b3e_d1c6_aaa8_cc0ac8aa3ea2 -->|defined in| 832b9ba1_75e8_ad0c_71b4_3f5c6d4c0825
  style 5b35e19e_9b3e_d1c6_aaa8_cc0ac8aa3ea2 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

libs/standard-tests/langchain_tests/integration_tests/retrievers.py lines 33–39

    def num_results_arg_name(self) -> str:
        """Returns the name of the parameter for the number of results returned.

        Usually something like `k` or `top_k`.

        """
        return "k"