as_retriever

Returns: Retriever for this GraphVectorStore.

Examples:

.. code-block:: python

# Retrieve documents traversing edges
docsearch.as_retriever(
    search_type="traversal",
    search_kwargs={'k': 6, 'depth': 2}
)

# Retrieve documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr_traversal",
    search_kwargs={'k': 6, 'lambda_mult': 0.25, 'depth': 2}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr_traversal",
    search_kwargs={'k': 5, 'fetch_k': 50, 'depth': 2}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})