Archives/langchain
2
0
Fork 1
mirror of https://github.com/hwchase17/langchain synced 2024-11-06 03:20:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

ArgillaCallbackHandler to properly use default values for api_url and api_key (#9113)

Browse Source 
As of the recent PR at #9043, after some testing we've realised that the
default values were not being used for `api_key` and `api_url`. Besides
that, the default for `api_key` was set to `argilla.apikey`, but since
the default values are intended for people using the Argilla Quickstart
(easy to run and setup), the defaults should be instead `owner.apikey`
if using Argilla 1.11.0 or higher, or `admin.apikey` if using a lower
version of Argilla.

Additionally, we've removed the f-string replacements from the
docstrings.

---------

Co-authored-by: Gabriel Martin <gabriel@argilla.io>
This commit is contained in:
Alvaro Bartolome 2023-08-11 18:37:06 +02:00 committed by GitHub
parent 0e5d09d0da
commit f7ae183f40
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/extras/integrations/callbacks/argilla.ipynb
View File

@ -147,7 +147,7 @@
" api_key=os.environ[\"ARGILLA_API_KEY\"],\n", " api_key=os.environ[\"ARGILLA_API_KEY\"],\n",
")\n", ")\n",
"\n", "\n",
"dataset.push_to_argilla(\"langchain-dataset\")" "dataset.push_to_argilla(\"langchain-dataset\");"
] ]
}, },
{ {

31
libs/langchain/langchain/callbacks/argilla_callback.py
View File

@ -21,11 +21,10 @@ class ArgillaCallbackHandler(BaseCallbackHandler):
default workspace will be used. default workspace will be used.
api_url: URL of the Argilla Server that we want to use, and where the api_url: URL of the Argilla Server that we want to use, and where the
`FeedbackDataset` lives in. Defaults to `None`, which means that either `FeedbackDataset` lives in. Defaults to `None`, which means that either
`ARGILLA_API_URL` environment variable or the default http://localhost:6900 `ARGILLA_API_URL` environment variable or the default will be used.
will be used.
api_key: API Key to connect to the Argilla Server. Defaults to `None`, which api_key: API Key to connect to the Argilla Server. Defaults to `None`, which
means that either `ARGILLA_API_KEY` environment variable or the default means that either `ARGILLA_API_KEY` environment variable or the default
`argilla.apikey` will be used. will be used.
Raises: Raises:
ImportError: if the `argilla` package is not installed. ImportError: if the `argilla` package is not installed.
@ -58,7 +57,6 @@ class ArgillaCallbackHandler(BaseCallbackHandler):
BLOG_URL = "https://docs.argilla.io/en/latest/guides/llms/practical_guides/use_argilla_callback_in_langchain.html" # noqa: E501 BLOG_URL = "https://docs.argilla.io/en/latest/guides/llms/practical_guides/use_argilla_callback_in_langchain.html" # noqa: E501
DEFAULT_API_URL = "http://localhost:6900" DEFAULT_API_URL = "http://localhost:6900"
DEFAULT_API_KEY = "argilla.apikey"
def __init__( def __init__(
self, self,
@ -67,22 +65,22 @@ class ArgillaCallbackHandler(BaseCallbackHandler):
api_url: Optional[str] = None, api_url: Optional[str] = None,
api_key: Optional[str] = None, api_key: Optional[str] = None,
) -> None: ) -> None:
f"""Initializes the `ArgillaCallbackHandler`. """Initializes the `ArgillaCallbackHandler`.
Args: Args:
dataset_name: name of the `FeedbackDataset` in Argilla. Note that it must dataset_name: name of the `FeedbackDataset` in Argilla. Note that it must
exist in advance. If you need help on how to create a `FeedbackDataset` exist in advance. If you need help on how to create a `FeedbackDataset`
in Argilla, please visit {self.BLOG_URL}. in Argilla, please visit
https://docs.argilla.io/en/latest/guides/llms/practical_guides/use_argilla_callback_in_langchain.html.
workspace_name: name of the workspace in Argilla where the specified workspace_name: name of the workspace in Argilla where the specified
`FeedbackDataset` lives in. Defaults to `None`, which means that the `FeedbackDataset` lives in. Defaults to `None`, which means that the
default workspace will be used. default workspace will be used.
api_url: URL of the Argilla Server that we want to use, and where the api_url: URL of the Argilla Server that we want to use, and where the
`FeedbackDataset` lives in. Defaults to `None`, which means that either `FeedbackDataset` lives in. Defaults to `None`, which means that either
`ARGILLA_API_URL` environment variable or `{self.DEFAULT_API_URL}` will `ARGILLA_API_URL` environment variable or the default will be used.
be used.
api_key: API Key to connect to the Argilla Server. Defaults to `None`, which api_key: API Key to connect to the Argilla Server. Defaults to `None`, which
means that either `ARGILLA_API_KEY` environment variable or the default means that either `ARGILLA_API_KEY` environment variable or the default
`{self.DEFAULT_API_KEY}` will be used. will be used.
Raises: Raises:
ImportError: if the `argilla` package is not installed. ImportError: if the `argilla` package is not installed.
@ -116,16 +114,27 @@ class ArgillaCallbackHandler(BaseCallbackHandler):
warnings.warn( warnings.warn(
( (
"Since `api_url` is None, and the env var `ARGILLA_API_URL` is not" "Since `api_url` is None, and the env var `ARGILLA_API_URL` is not"
f" set, it will default to `{self.DEFAULT_API_URL}`." f" set, it will default to `{self.DEFAULT_API_URL}`, which is the"
" default API URL in Argilla Quickstart."
), ),
) )
api_url = self.DEFAULT_API_URL
if api_key is None and os.getenv("ARGILLA_API_KEY") is None: if api_key is None and os.getenv("ARGILLA_API_KEY") is None:
self.DEFAULT_API_KEY = (
"admin.apikey"
if parse(self.ARGILLA_VERSION) < parse("1.11.0")
else "owner.apikey"
)
warnings.warn( warnings.warn(
( (
"Since `api_key` is None, and the env var `ARGILLA_API_KEY` is not" "Since `api_key` is None, and the env var `ARGILLA_API_KEY` is not"
f" set, it will default to `{self.DEFAULT_API_KEY}`." f" set, it will default to `{self.DEFAULT_API_KEY}`, which is the"
" default API key in Argilla Quickstart."
), ),
) )
api_url = self.DEFAULT_API_URL
# Connect to Argilla with the provided credentials, if applicable # Connect to Argilla with the provided credentials, if applicable
try: try: