github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-08-07 20:15:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor: use SecretStr for edenai embeddings (#15092)

Browse Source
This commit is contained in:
chyroc 2024-01-02 07:22:51 +08:00 committed by GitHub
parent 32e6e9de13
commit ea6cf0f1b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
libs/community/langchain_community/embeddings/edenai.py
View File

@ -1,8 +1,14 @@
from typing import Any, Dict, List, Optional from typing import Any, Dict, List, Optional
from langchain_core.embeddings import Embeddings from langchain_core.embeddings import Embeddings
from langchain_core.pydantic_v1 import BaseModel, Extra, Field, root_validator from langchain_core.pydantic_v1 import (
from langchain_core.utils import get_from_dict_or_env BaseModel,
Extra,
Field,
SecretStr,
root_validator,
)
from langchain_core.utils import convert_to_secret_str, get_from_dict_or_env
from langchain_community.utilities.requests import Requests from langchain_community.utilities.requests import Requests
@ -13,7 +19,7 @@ class EdenAiEmbeddings(BaseModel, Embeddings):
it as a named parameter. it as a named parameter.
""" """
edenai_api_key: Optional[str] = Field(None, description="EdenAI API Token") edenai_api_key: Optional[SecretStr] = Field(None, description="EdenAI API Token")
provider: str = "openai" provider: str = "openai"
"""embedding provider to use (eg: openai,google etc.)""" """embedding provider to use (eg: openai,google etc.)"""
@ -32,8 +38,8 @@ class EdenAiEmbeddings(BaseModel, Embeddings):
@root_validator() @root_validator()
def validate_environment(cls, values: Dict) -> Dict: def validate_environment(cls, values: Dict) -> Dict:
"""Validate that api key exists in environment.""" """Validate that api key exists in environment."""
values["edenai_api_key"] = get_from_dict_or_env( values["edenai_api_key"] = convert_to_secret_str(
values, "edenai_api_key", "EDENAI_API_KEY" get_from_dict_or_env(values, "edenai_api_key", "EDENAI_API_KEY")
) )
return values return values
@ -50,7 +56,7 @@ class EdenAiEmbeddings(BaseModel, Embeddings):
headers = { headers = {
"accept": "application/json", "accept": "application/json",
"content-type": "application/json", "content-type": "application/json",
"authorization": f"Bearer {self.edenai_api_key}", "authorization": f"Bearer {self.edenai_api_key.get_secret_value()}",
"User-Agent": self.get_user_agent(), "User-Agent": self.get_user_agent(),
} }

21
libs/community/tests/unit_tests/embeddings/test_edenai.py Normal file
View File

@ -0,0 +1,21 @@
"""Test EdenAiEmbeddings embeddings"""
from langchain_core.pydantic_v1 import SecretStr
from pytest import CaptureFixture
from langchain_community.embeddings import EdenAiEmbeddings
def test_api_key_is_string() -> None:
llm = EdenAiEmbeddings(edenai_api_key="secret-api-key")
assert isinstance(llm.edenai_api_key, SecretStr)
def test_api_key_masked_when_passed_via_constructor(
capsys: CaptureFixture,
) -> None:
llm = EdenAiEmbeddings(edenai_api_key="secret-api-key")
print(llm.edenai_api_key, end="")
captured = capsys.readouterr()
assert captured.out == "**********"