Mask API key for Tongyi ChatModel and LLM

libs/langchain/langchain/chat_models/tongyi.py

@@ -11,6 +11,7 @@
     Optional,
     Tuple,
     Type,
+    cast,
 )
 
 from langchain_core.messages import (
@@ -33,7 +34,8 @@
     ChatResult,
     GenerationChunk,
 )
-from langchain_core.pydantic_v1 import Field, root_validator
+from langchain_core.pydantic_v1 import Field, SecretStr, root_validator
+from langchain_core.utils import convert_to_secret_str
 from requests.exceptions import HTTPError
 from tenacity import (
     RetryCallState,
@@ -214,7 +216,7 @@ def lc_serializable(self) -> bool:
     top_p: float = 0.8
     """Total probability mass of tokens to consider at each step."""
 
-    dashscope_api_key: Optional[str] = None
+    dashscope_api_key: Optional[SecretStr] = None
     """Dashscope api key provide by alicloud."""
 
     n: int = 1
@@ -240,7 +242,9 @@ def _llm_type(self) -> str:
     @root_validator()
     def validate_environment(cls, values: Dict) -> Dict:
         """Validate that api key and python package exists in environment."""
-        get_from_dict_or_env(values, "dashscope_api_key", "DASHSCOPE_API_KEY")
+        values["dashscope_api_key"] = convert_to_secret_str(
+            get_from_dict_or_env(values, "dashscope_api_key", "DASHSCOPE_API_KEY")
+        )
         try:
             import dashscope
         except ImportError:
@@ -387,7 +391,7 @@ def _create_message_dicts(
     def _client_params(self) -> Dict[str, Any]:
         """Get the parameters used for the openai client."""
         creds: Dict[str, Any] = {
-            "api_key": self.dashscope_api_key,
+            "api_key": cast(SecretStr, self.dashscope_api_key).get_secret_value()
         }
         return {**self._default_params, **creds}
 

libs/langchain/langchain/llms/tongyi.py

@@ -1,10 +1,11 @@
 from __future__ import annotations
 
 import logging
-from typing import Any, Callable, Dict, List, Optional
+from typing import Any, Callable, Dict, List, Optional, cast
 
 from langchain_core.outputs import Generation, LLMResult
-from langchain_core.pydantic_v1 import Field, root_validator
+from langchain_core.pydantic_v1 import Field, SecretStr, root_validator
+from langchain_core.utils import convert_to_secret_str
 from requests.exceptions import HTTPError
 from tenacity import (
     before_sleep_log,
@@ -109,15 +110,15 @@ def is_lc_serializable(cls) -> bool:
         return True
 
     client: Any  #: :meta private:
-    model_name: str = "qwen-plus-v1"
+    model_name: str = "qwen-plus"
 
     """Model name to use."""
     model_kwargs: Dict[str, Any] = Field(default_factory=dict)
 
     top_p: float = 0.8
     """Total probability mass of tokens to consider at each step."""
 
-    dashscope_api_key: Optional[str] = None
+    dashscope_api_key: Optional[SecretStr] = None
     """Dashscope api key provide by alicloud."""
 
     n: int = 1
@@ -140,7 +141,9 @@ def _llm_type(self) -> str:
     @root_validator()
     def validate_environment(cls, values: Dict) -> Dict:
         """Validate that api key and python package exists in environment."""
-        get_from_dict_or_env(values, "dashscope_api_key", "DASHSCOPE_API_KEY")
+        values["dashscope_api_key"] = convert_to_secret_str(
+            get_from_dict_or_env(values, "dashscope_api_key", "DASHSCOPE_API_KEY")
+        )
         try:
             import dashscope
         except ImportError:
@@ -164,6 +167,7 @@ def _default_params(self) -> Dict[str, Any]:
         """Get the default parameters for calling OpenAI API."""
         normal_params = {
             "top_p": self.top_p,
+            "api_key": cast(SecretStr, self.dashscope_api_key).get_secret_value(),
         }
 
         return {**normal_params, **self.model_kwargs}

libs/langchain/pyproject.toml

@@ -149,6 +149,7 @@ msal = {version = "^1.25.0", optional = true}
 databricks-vectorsearch = {version = "^0.21", optional = true}
 couchbase = {version = "^4.1.9", optional = true}
 dgml-utils = {version = "^0.3.0", optional = true}
+dashscope = {version = "^1.13.3", optional = true}
 datasets = {version = "^2.15.0", optional = true}
 
 [tool.poetry.group.test.dependencies]
@@ -336,6 +337,7 @@ extended_testing = [
  "bibtexparser",
  "cassio",
  "chardet",
+ "dashscope",
  "datasets",
  "google-cloud-documentai",
  "esprima",

libs/langchain/tests/unit_tests/chat_models/test_tongyi.py

@@ -0,0 +1,38 @@
+"""
+This file is to perform unit tests for Tongyi chat model.
+"""
+
+import pytest
+from langchain_core.pydantic_v1 import SecretStr
+from pytest import CaptureFixture, MonkeyPatch
+
+from langchain.chat_models.tongyi import ChatTongyi
+
+
+@pytest.mark.requires("dashscope")
+def test_api_key_is_secret_value() -> None:
+    llm = ChatTongyi(dashscope_api_key="secret-api-key")
+    assert isinstance(llm.dashscope_api_key, SecretStr)
+
+
+@pytest.mark.requires("dashscope")
+def test_api_key_is_secret_pass_by_constructor(
+    capsys: CaptureFixture,
+) -> None:
+    llm = ChatTongyi(dashscope_api_key="secret-api-key")
+    print(llm.dashscope_api_key, end="")
+    captured = capsys.readouterr()
+
+    assert captured.out == "**********"
+
+
+@pytest.mark.requires("dashscope")
+def test_api_key_is_secret_pass_by_end(
+    monkeypatch: MonkeyPatch, capsys: CaptureFixture
+) -> None:
+    monkeypatch.setenv("DASHSCOPE_API_KEY", "secret-api-key")
+    llm = ChatTongyi()
+    print(llm.dashscope_api_key, end="")
+    captured = capsys.readouterr()
+
+    assert captured.out == "**********"

libs/langchain/tests/unit_tests/llms/test_tongyi.py

@@ -0,0 +1,39 @@
+"""
+This file is to perform unit tests for Tongyi llm.
+"""
+
+import pytest
+from langchain_core.pydantic_v1 import SecretStr
+from pytest import CaptureFixture, MonkeyPatch
+
+from langchain.llms.tongyi import Tongyi
+
+pytest.mark.requires("dashscope")
+
+
+def test_api_key_is_secret_value() -> None:
+    llm = Tongyi(dashscope_api_key="secret-key-api")
+    assert isinstance(llm.dashscope_api_key, SecretStr)
+
+
+@pytest.mark.requires("dashscope")
+def test_api_key_is_secret_value_pass_by_constructor(
+    capsys: CaptureFixture,
+) -> None:
+    llm = Tongyi(dashscope_api_key="secret-key-api")
+    print(llm.dashscope_api_key, end="")
+    captured = capsys.readouterr()
+
+    assert captured.out == "**********"
+
+
+@pytest.mark.requires("dashscope")
+def test_api_key_is_secret_value_pass_by_end(
+    capsys: CaptureFixture, monkeypatch: MonkeyPatch
+) -> None:
+    monkeypatch.setenv("DASHSCOPE_API_KEY", "secret-api-key")
+    llm = Tongyi()
+    print(llm.dashscope_api_key, end="")
+    captured = capsys.readouterr()
+
+    assert captured.out == "**********"