mirror of
https://github.com/hwchase17/langchain.git
synced 2025-12-03 08:47:03 +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),
}
```
67 lines
2.0 KiB
Python
67 lines
2.0 KiB
Python
"""Util that calls Dataherald."""
|
|
|
|
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 DataheraldAPIWrapper(BaseModel):
|
|
"""Wrapper for Dataherald.
|
|
|
|
Docs for using:
|
|
|
|
1. Go to dataherald and sign up
|
|
2. Create an API key
|
|
3. Save your API key into DATAHERALD_API_KEY env variable
|
|
4. pip install dataherald
|
|
|
|
"""
|
|
|
|
dataherald_client: Any #: :meta private:
|
|
db_connection_id: str
|
|
dataherald_api_key: Optional[str] = None
|
|
|
|
class Config:
|
|
extra = "forbid"
|
|
|
|
@root_validator(pre=True)
|
|
def validate_environment(cls, values: Dict) -> Dict:
|
|
"""Validate that api key and python package exists in environment."""
|
|
dataherald_api_key = get_from_dict_or_env(
|
|
values, "dataherald_api_key", "DATAHERALD_API_KEY"
|
|
)
|
|
values["dataherald_api_key"] = dataherald_api_key
|
|
|
|
try:
|
|
import dataherald
|
|
|
|
except ImportError:
|
|
raise ImportError(
|
|
"dataherald is not installed. "
|
|
"Please install it with `pip install dataherald`"
|
|
)
|
|
|
|
client = dataherald.Dataherald(api_key=dataherald_api_key)
|
|
values["dataherald_client"] = client
|
|
|
|
return values
|
|
|
|
def run(self, prompt: str) -> str:
|
|
"""Generate a sql query through Dataherald and parse result."""
|
|
from dataherald.types.sql_generation_create_params import Prompt
|
|
|
|
prompt_obj = Prompt(text=prompt, db_connection_id=self.db_connection_id)
|
|
res = self.dataherald_client.sql_generations.create(prompt=prompt_obj)
|
|
|
|
try:
|
|
answer = res.sql
|
|
if not answer:
|
|
# We don't want to return the assumption alone if answer is empty
|
|
return "No answer"
|
|
else:
|
|
return f"Answer: {answer}"
|
|
|
|
except StopIteration:
|
|
return "Dataherald wasn't able to answer it"
|