mirror of
https://github.com/hwchase17/langchain.git
synced 2025-09-28 23:07:11 +00:00
bf5193bb99
Upgrade to using a literal for specifying the extra which is the
recommended approach in pydantic 2.
This works correctly also in pydantic v1.
```python
from pydantic.v1 import BaseModel
class Foo(BaseModel, extra="forbid"):
x: int
Foo(x=5, y=1)
```
And
```python
from pydantic.v1 import BaseModel
class Foo(BaseModel):
x: int
class Config:
extra = "forbid"
Foo(x=5, y=1)
```
## Enum -> literal using grit pattern:
```
engine marzano(0.1)
language python
or {
`extra=Extra.allow` => `extra="allow"`,
`extra=Extra.forbid` => `extra="forbid"`,
`extra=Extra.ignore` => `extra="ignore"`
}
```
Resorted attributes in config and removed doc-string in case we will
need to deal with going back and forth between pydantic v1 and v2 during
the 0.3 release. (This will reduce merge conflicts.)
## Sort attributes in Config:
```
engine marzano(0.1)
language python
function sort($values) js {
return $values.text.split(',').sort().join("\n");
}
class_definition($name, $body) as $C where {
$name <: `Config`,
$body <: block($statements),
$values = [],
$statements <: some bubble($values) assignment() as $A where {
$values += $A
},
$body => sort($values),
}
```
84 lines
2.4 KiB
Python
84 lines
2.4 KiB
Python
"""Tool for the SearxNG search API."""
|
|
|
|
from typing import Optional, Type
|
|
|
|
from langchain_core.callbacks import (
|
|
AsyncCallbackManagerForToolRun,
|
|
CallbackManagerForToolRun,
|
|
)
|
|
from langchain_core.pydantic_v1 import BaseModel, Field
|
|
from langchain_core.tools import BaseTool
|
|
|
|
from langchain_community.utilities.searx_search import SearxSearchWrapper
|
|
|
|
|
|
class SearxSearchQueryInput(BaseModel):
|
|
"""Input for the SearxSearch tool."""
|
|
|
|
query: str = Field(description="query to look up on searx")
|
|
|
|
|
|
class SearxSearchRun(BaseTool):
|
|
"""Tool that queries a Searx instance."""
|
|
|
|
name: str = "searx_search"
|
|
description: str = (
|
|
"A meta search engine."
|
|
"Useful for when you need to answer questions about current events."
|
|
"Input should be a search query."
|
|
)
|
|
wrapper: SearxSearchWrapper
|
|
kwargs: dict = Field(default_factory=dict)
|
|
args_schema: Type[BaseModel] = SearxSearchQueryInput
|
|
|
|
def _run(
|
|
self,
|
|
query: str,
|
|
run_manager: Optional[CallbackManagerForToolRun] = None,
|
|
) -> str:
|
|
"""Use the tool."""
|
|
return self.wrapper.run(query, **self.kwargs)
|
|
|
|
async def _arun(
|
|
self,
|
|
query: str,
|
|
run_manager: Optional[AsyncCallbackManagerForToolRun] = None,
|
|
) -> str:
|
|
"""Use the tool asynchronously."""
|
|
return await self.wrapper.arun(query, **self.kwargs)
|
|
|
|
|
|
class SearxSearchResults(BaseTool):
|
|
"""Tool that queries a Searx instance and gets back json."""
|
|
|
|
name: str = "searx_search_results"
|
|
description: str = (
|
|
"A meta search engine."
|
|
"Useful for when you need to answer questions about current events."
|
|
"Input should be a search query. Output is a JSON array of the query results"
|
|
)
|
|
wrapper: SearxSearchWrapper
|
|
num_results: int = 4
|
|
kwargs: dict = Field(default_factory=dict)
|
|
|
|
class Config:
|
|
extra = "allow"
|
|
|
|
def _run(
|
|
self,
|
|
query: str,
|
|
run_manager: Optional[CallbackManagerForToolRun] = None,
|
|
) -> str:
|
|
"""Use the tool."""
|
|
return str(self.wrapper.results(query, self.num_results, **self.kwargs))
|
|
|
|
async def _arun(
|
|
self,
|
|
query: str,
|
|
run_manager: Optional[AsyncCallbackManagerForToolRun] = None,
|
|
) -> str:
|
|
"""Use the tool asynchronously."""
|
|
return (
|
|
await self.wrapper.aresults(query, self.num_results, **self.kwargs)
|
|
).__str__()
|