mirror of
https://github.com/hwchase17/langchain
synced 2024-11-06 03:20:49 +00:00
7cf2d2759d
Added missed docstrings. Format docstings to the consistent form.
40 lines
1.1 KiB
Python
40 lines
1.1 KiB
Python
from typing import Any, List
|
|
|
|
from langchain_core.callbacks import (
|
|
AsyncCallbackManagerForRetrieverRun,
|
|
CallbackManagerForRetrieverRun,
|
|
)
|
|
from langchain_core.documents import Document
|
|
from langchain_core.retrievers import BaseRetriever
|
|
|
|
from langchain_community.utilities import YouSearchAPIWrapper
|
|
|
|
|
|
class YouRetriever(BaseRetriever, YouSearchAPIWrapper):
|
|
"""You.com Search API retriever.
|
|
|
|
It wraps results() to get_relevant_documents
|
|
It uses all YouSearchAPIWrapper arguments without any change.
|
|
"""
|
|
|
|
def _get_relevant_documents(
|
|
self,
|
|
query: str,
|
|
*,
|
|
run_manager: CallbackManagerForRetrieverRun,
|
|
**kwargs: Any,
|
|
) -> List[Document]:
|
|
return self.results(query, run_manager=run_manager.get_child(), **kwargs)
|
|
|
|
async def _aget_relevant_documents(
|
|
self,
|
|
query: str,
|
|
*,
|
|
run_manager: AsyncCallbackManagerForRetrieverRun,
|
|
**kwargs: Any,
|
|
) -> List[Document]:
|
|
results = await self.results_async(
|
|
query, run_manager=run_manager.get_child(), **kwargs
|
|
)
|
|
return results
|