Mask API key for AI21 LLM #12418

gautamanirudh · 2023-10-27T10:44:18Z

Description: Added masking of the API Key for AI21 LLM when printed and improved the docstring for AI21 LLM.
- Updated the AI21 LLM to utilize SecretStr from pydantic to securely manage API key.
- Made improvements in the docstring of AI21 LLM. It now mentions that the API key can also be passed as a named parameter to the constructor.
- Added unit tests.
Issue: For New Contributors: Use SecretStr for api_keys #12165
Tag maintainer: @eyurtsev

vercel · 2023-10-27T10:44:22Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
langchain	⬜️ Ignored (Inspect)	Visit Preview		Oct 28, 2023 8:45am

gautamanirudh · 2023-10-27T10:56:41Z

@eyurtsev Does it make sense to move the _to_secret() function(first implemented in #12377) to langchain utils? It can be utilized in other files as well.

eyurtsev · 2023-10-27T14:20:13Z

@gautamanirudh yeah let's move to utils

…anirudh/langchain into fix/mask-api-key-ai21-llm

eyurtsev · 2023-10-29T02:33:33Z

libs/langchain/langchain/llms/ai21.py

@@ -62,7 +62,7 @@ class AI21(LLM):
    logitBias: Optional[Dict[str, float]] = None
    """Adjust the probability of specific tokens being generated."""

-    ai21_api_key: Optional[str] = None
+    ai21_api_key: Optional[SecretStr] = None


Is it possible for the ai21_api_key to be None? It looks like after the root validator runs this always get set to a value?

Yes, ai21_api_key can never be None.

eyurtsev · 2023-10-29T02:34:07Z

libs/langchain/langchain/llms/ai21.py

@@ -141,9 +143,10 @@ def _call(
            else:
                base_url = "https://api.ai21.com/studio/v1"
        params = {**self._default_params, **kwargs}
+        self.ai21_api_key = cast(SecretStr, self.ai21_api_key)


Cast probably won't be needed if the attribute is no longer an Optional

Yes, used the cast to avoid type checking, I was encountering a mypy error without it.

eyurtsev · 2023-10-29T02:35:31Z

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

@@ -0,0 +1,41 @@
+"""Test AI21 llm"""


eyurtsev · 2023-10-29T02:37:04Z

Ready to merge -- we might want to update the type to be non optional later on, but not requiring changes for this PR since ti was already optional before

@eyurtsev

- **Description:** Added masking of the API Key for AI21 LLM when printed and improved the docstring for AI21 LLM. - Updated the AI21 LLM to utilize SecretStr from pydantic to securely manage API key. - Made improvements in the docstring of AI21 LLM. It now mentions that the API key can also be passed as a named parameter to the constructor. - Added unit tests. - **Issue:** langchain-ai#12165 - **Tag maintainer:** @eyurtsev --------- Co-authored-by: Anirudh Gautam <anirudh@Anirudhs-Mac-mini.local>

@eyurtsev

- **Description:** Added masking for the API key for Minimax LLM + tests inspired by #12418. - **Issue:** the issue # fixes #12165 - **Dependencies:** this fix is dependent on Minimax instantiation fix which is introduced in #13439, so merge this one after. - **Tag maintainer:** @eyurtsev --------- Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>

@eyurtsev

- **Description:** Added masking for the API key for Minimax LLM + tests inspired by langchain-ai#12418. - **Issue:** the issue # fixes langchain-ai#12165 - **Dependencies:** this fix is dependent on Minimax instantiation fix which is introduced in langchain-ai#13439, so merge this one after. - **Tag maintainer:** @eyurtsev --------- Co-authored-by: Harrison Chase <hw.chase.17@gmail.com>

@eyurtsev

- **Description:** Added masking of the API Key for AI21 LLM when printed and improved the docstring for AI21 LLM. - Updated the AI21 LLM to utilize SecretStr from pydantic to securely manage API key. - Made improvements in the docstring of AI21 LLM. It now mentions that the API key can also be passed as a named parameter to the constructor. - Added unit tests. - **Issue:** langchain-ai#12165 - **Tag maintainer:** @eyurtsev --------- Co-authored-by: Anirudh Gautam <anirudh@Anirudhs-Mac-mini.local>

**Description:** Masking of the API key for AI21 models **Issue:** Fixes #12165 for AI21 **Dependencies:** None Note: This fix came in originally through #12418 but was possibly missed in the refactor to the AI21 partner package --------- Co-authored-by: Erick Friis <erick@langchain.dev>

…0257) **Description:** Masking of the API key for AI21 models **Issue:** Fixes langchain-ai#12165 for AI21 **Dependencies:** None Note: This fix came in originally through langchain-ai#12418 but was possibly missed in the refactor to the AI21 partner package --------- Co-authored-by: Erick Friis <erick@langchain.dev>

**Description:** Masking of the API key for AI21 models **Issue:** Fixes #12165 for AI21 **Dependencies:** None Note: This fix came in originally through #12418 but was possibly missed in the refactor to the AI21 partner package --------- Co-authored-by: Erick Friis <erick@langchain.dev>

Anirudh Gautam added 4 commits October 27, 2023 14:31

Mask API key for AI21 LLM

954a9a1

Improved AI21 LLM docstring

e0d7faa

Added secret retrieval test in test_ai21.py

9a1bba1

Added secret retrieval test in test_ai21.py

02b62af

dosubot bot added Ɑ: models Related to LLMs or chat model modules 🤖:improvement Medium size change to existing code to handle new use-cases labels Oct 27, 2023

Anirudh Gautam added 3 commits October 28, 2023 13:55

Moved _to_secret() in llms/ai21.py to langchain/utils

6e2494e

Merge branch 'fix/mask-api-key-ai21-llm' of https://github.com/gautam…

88a2f38

…anirudh/langchain into fix/mask-api-key-ai21-llm

Fix MyPy type error for ai21_api_key in AI21 class

6a997d1

eyurtsev self-requested a review October 29, 2023 02:30

eyurtsev reviewed Oct 29, 2023

View reviewed changes

eyurtsev approved these changes Oct 29, 2023

View reviewed changes

eyurtsev added the lgtm PR looks good. Use to confirm that a PR is ready for merging. label Oct 29, 2023

baskaryan merged commit b257e6a into langchain-ai:master Oct 29, 2023
22 checks passed

rancomp mentioned this pull request Dec 5, 2023

Mask API key for Minimax LLM #14309

Merged

sepiatone mentioned this pull request Apr 10, 2024

partner[ai21]: masking of the api key for ai21 models #20257

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Mask API key for AI21 LLM #12418

Mask API key for AI21 LLM #12418

gautamanirudh commented Oct 27, 2023 •

edited

Loading

vercel bot commented Oct 27, 2023 •

edited

Loading

gautamanirudh commented Oct 27, 2023

eyurtsev commented Oct 27, 2023

eyurtsev Oct 29, 2023

gautamanirudh Oct 29, 2023

eyurtsev Oct 29, 2023

gautamanirudh Oct 29, 2023

eyurtsev Oct 29, 2023

eyurtsev commented Oct 29, 2023

Mask API key for AI21 LLM #12418

Mask API key for AI21 LLM #12418

Conversation

gautamanirudh commented Oct 27, 2023 • edited Loading

vercel bot commented Oct 27, 2023 • edited Loading

gautamanirudh commented Oct 27, 2023

eyurtsev commented Oct 27, 2023

eyurtsev Oct 29, 2023

Choose a reason for hiding this comment

gautamanirudh Oct 29, 2023

Choose a reason for hiding this comment

eyurtsev Oct 29, 2023

Choose a reason for hiding this comment

gautamanirudh Oct 29, 2023

Choose a reason for hiding this comment

eyurtsev Oct 29, 2023

Choose a reason for hiding this comment

eyurtsev commented Oct 29, 2023

gautamanirudh commented Oct 27, 2023 •

edited

Loading

vercel bot commented Oct 27, 2023 •

edited

Loading