community: make old stub for QuerySQLDataBaseTool private to skip api ref (#28711)

This commit is contained in:
Erick Friis 2024-12-13 10:43:23 -08:00 committed by GitHub
parent 05ebe1e66b
commit 86b3c6e81c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 14 additions and 4 deletions

View File

@ -122,13 +122,13 @@ class ChatOutlines(BaseChatModel):
This can be useful for generating structured outputs like IP addresses, dates, etc.
Example: (valid IP address)
regex = r"((25[0-5]|2[0-4]\d|[01]?\d\d?)\.){3}(25[0-5]|2[0-4]\d|[01]?\d\d?)"
regex = r"((25[0-5]|2[0-4]\\d|[01]?\\d\\d?)\\.){3}(25[0-5]|2[0-4]\\d|[01]?\\d\\d?)"
Note: Computing the regex index can take some time, so it's recommended to reuse
the same regex for multiple generations if possible.
For more details, see: https://dottxt-ai.github.io/outlines/reference/generation/regex/
"""
""" # noqa: E501
type_constraints: Optional[Union[type, str]] = None
"""Type constraints for structured generation.

View File

@ -7,6 +7,7 @@ from sqlalchemy.engine import Result
from pydantic import BaseModel, Field, root_validator, model_validator, ConfigDict
from langchain_core._api.deprecation import deprecated
from langchain_core.language_models import BaseLanguageModel
from langchain_core.callbacks import (
AsyncCallbackManagerForToolRun,
@ -58,8 +59,17 @@ class QuerySQLDatabaseTool(BaseSQLDatabaseTool, BaseTool): # type: ignore[overr
return self.db.run_no_throw(query)
# Backwards compatibility.
QuerySQLDataBaseTool = QuerySQLDatabaseTool
@deprecated(
since="0.3.12",
removal="1.0",
alternative_import="langchain_community.tools.QuerySQLDatabaseTool",
)
class QuerySQLDataBaseTool(QuerySQLDatabaseTool): # type: ignore[override]
"""
Equivalent stub to QuerySQLDatabaseTool for backwards compatibility.
:private:"""
...
class _InfoSQLDatabaseToolInput(BaseModel):