mirror of
https://github.com/hwchase17/langchain.git
synced 2025-05-08 00:28:47 +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),
}
```
114 lines
3.5 KiB
Python
114 lines
3.5 KiB
Python
"""Util that calls AskNews api."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import datetime, timedelta
|
|
from typing import Any, Dict, Optional
|
|
|
|
from langchain_core.pydantic_v1 import BaseModel, root_validator
|
|
from langchain_core.utils import get_from_dict_or_env
|
|
|
|
|
|
class AskNewsAPIWrapper(BaseModel):
|
|
"""Wrapper for AskNews API."""
|
|
|
|
asknews_sync: Any #: :meta private:
|
|
asknews_async: Any #: :meta private:
|
|
asknews_client_id: Optional[str] = None
|
|
"""Client ID for the AskNews API."""
|
|
asknews_client_secret: Optional[str] = None
|
|
"""Client Secret for the AskNews API."""
|
|
|
|
class Config:
|
|
extra = "forbid"
|
|
|
|
@root_validator(pre=True)
|
|
def validate_environment(cls, values: Dict) -> Dict:
|
|
"""Validate that api credentials and python package exists in environment."""
|
|
|
|
asknews_client_id = get_from_dict_or_env(
|
|
values, "asknews_client_id", "ASKNEWS_CLIENT_ID"
|
|
)
|
|
asknews_client_secret = get_from_dict_or_env(
|
|
values, "asknews_client_secret", "ASKNEWS_CLIENT_SECRET"
|
|
)
|
|
|
|
try:
|
|
import asknews_sdk
|
|
|
|
except ImportError:
|
|
raise ImportError(
|
|
"AskNews python package not found. "
|
|
"Please install it with `pip install asknews`."
|
|
)
|
|
|
|
an_sync = asknews_sdk.AskNewsSDK(
|
|
client_id=asknews_client_id,
|
|
client_secret=asknews_client_secret,
|
|
scopes=["news"],
|
|
)
|
|
an_async = asknews_sdk.AsyncAskNewsSDK(
|
|
client_id=asknews_client_id,
|
|
client_secret=asknews_client_secret,
|
|
scopes=["news"],
|
|
)
|
|
|
|
values["asknews_sync"] = an_sync
|
|
values["asknews_async"] = an_async
|
|
values["asknews_client_id"] = asknews_client_id
|
|
values["asknews_client_secret"] = asknews_client_secret
|
|
|
|
return values
|
|
|
|
def search_news(
|
|
self, query: str, max_results: int = 10, hours_back: int = 0
|
|
) -> str:
|
|
"""Search news in AskNews API synchronously."""
|
|
if hours_back > 48:
|
|
method = "kw"
|
|
historical = True
|
|
start = int((datetime.now() - timedelta(hours=hours_back)).timestamp())
|
|
stop = int(datetime.now().timestamp())
|
|
else:
|
|
historical = False
|
|
method = "nl"
|
|
start = None
|
|
stop = None
|
|
|
|
response = self.asknews_sync.news.search_news(
|
|
query=query,
|
|
n_articles=max_results,
|
|
method=method,
|
|
historical=historical,
|
|
start_timestamp=start,
|
|
end_timestamp=stop,
|
|
return_type="string",
|
|
)
|
|
return response.as_string
|
|
|
|
async def asearch_news(
|
|
self, query: str, max_results: int = 10, hours_back: int = 0
|
|
) -> str:
|
|
"""Search news in AskNews API asynchronously."""
|
|
if hours_back > 48:
|
|
method = "kw"
|
|
historical = True
|
|
start = int((datetime.now() - timedelta(hours=hours_back)).timestamp())
|
|
stop = int(datetime.now().timestamp())
|
|
else:
|
|
historical = False
|
|
method = "nl"
|
|
start = None
|
|
stop = None
|
|
|
|
response = await self.asknews_async.news.search_news(
|
|
query=query,
|
|
n_articles=max_results,
|
|
method=method,
|
|
historical=historical,
|
|
start_timestamp=start,
|
|
end_timestamp=stop,
|
|
return_type="string",
|
|
)
|
|
return response.as_string
|