|
8 | 8 | "\n",
|
9 | 9 | ">[Valyu](https://www.valyu.network/) allows AI applications and agents to search the internet and proprietary data sources for relevant LLM ready information.\n",
|
10 | 10 | "\n",
|
11 |
| - "This notebook goes over how to use Valyu context tool in LangChain.\n", |
| 11 | + "This notebook goes over how to use Valyu deep search tool in LangChain.\n", |
12 | 12 | "\n",
|
13 |
| - "First, get an Valyu API key and add it as an environment variable. Get $10 free credit by [signing up here](https://exchange.valyu.network/).\n", |
| 13 | + "First, get an Valyu API key and add it as an environment variable. Get $10 free credit by [signing up here](https://platform.valyu.network/).\n", |
14 | 14 | "\n",
|
15 | 15 | "## Setup\n",
|
16 | 16 | "\n",
|
|
57 | 57 | " The number of top results to return for each query.\n",
|
58 | 58 | "\n",
|
59 | 59 | "- `search_type: str = \"all\"` \n",
|
60 |
| - " The type of search to perform. Options may include \"all\", \"web\", \"proprietary\", etc., depending on your use case.\n", |
| 60 | + " The type of search to perform: 'all', 'proprietary', or 'web'. Defaults to 'all'.\n", |
61 | 61 | "\n",
|
62 |
| - "- `similarity_threshold: float = 0.4` \n", |
63 |
| - " The minimum similarity score (between 0 and 1) required for a document to be considered relevant.\n", |
64 |
| - "\n", |
65 |
| - "- `query_rewrite: bool = False` \n", |
66 |
| - " Whether to enable automatic rewriting of the query to improve search results.\n", |
| 62 | + "- `relevance_threshold: float = 0.5` \n", |
| 63 | + " The minimum relevance score (between 0 and 1) required for a document to be considered relevant. Defaults to 0.5.\n", |
67 | 64 | " \n",
|
68 | 65 | "- `max_price: float = 20.0`\n",
|
69 |
| - " The maximum price (in USD) you are willing to spend per query.\n", |
| 66 | + " The maximum price (in USD) you are willing to spend per query. Defaults to 20.0.\n", |
| 67 | + "\n", |
| 68 | + "- `start_date: Optional[str] = None`\n", |
| 69 | + " Start date for time filtering in YYYY-MM-DD format (optional).\n", |
| 70 | + "\n", |
| 71 | + "- `end_date: Optional[str] = None`\n", |
| 72 | + " End date for time filtering in YYYY-MM-DD format (optional).\n", |
70 | 73 | "\n",
|
71 | 74 | "- `client: Optional[Valyu] = None` \n",
|
72 | 75 | " An optional custom Valyu client instance. If not provided, a new client will be created internally.\n",
|
73 | 76 | " \n",
|
74 | 77 | "- `valyu_api_key: Optional[str] = None` \n",
|
75 |
| - " Your Valyu API key. If not provided, the retriever will look for the `VALYU_API_KEY` environment variable.\n" |
| 78 | + " Your Valyu API key. If not provided, the retriever will look for the `VALYU_API_KEY` environment variable." |
76 | 79 | ]
|
77 | 80 | },
|
78 | 81 | {
|
|
81 | 84 | "metadata": {},
|
82 | 85 | "outputs": [],
|
83 | 86 | "source": [
|
84 |
| - "from langchain_valyu import ValyuContextRetriever\n", |
| 87 | + "from langchain_valyu import ValyuRetriever\n", |
85 | 88 | "\n",
|
86 |
| - "retriever = ValyuContextRetriever(\n", |
| 89 | + "retriever = ValyuRetriever(\n", |
87 | 90 | " k=5,\n",
|
88 | 91 | " search_type=\"all\",\n",
|
89 |
| - " similarity_threshold=0.4,\n", |
90 |
| - " query_rewrite=False,\n", |
| 92 | + " relevance_threshold=0.5,\n", |
91 | 93 | " max_price=20.0,\n",
|
| 94 | + " start_date=\"2024-01-01\",\n", |
| 95 | + " end_date=\"2024-12-31\",\n", |
92 | 96 | " client=None,\n",
|
93 | 97 | " valyu_api_key=os.environ[\"VALYU_API_KEY\"],\n",
|
94 | 98 | ")"
|
|
0 commit comments