From 0ed1ac6ddfe96c483312509aa9b433ce0d1c4d5d Mon Sep 17 00:00:00 2001
From: Kurtis Massey <55586356+kurtismassey@users.noreply.github.com>
Date: Tue, 21 May 2024 23:34:16 +0100
Subject: [PATCH] Update docstring for get_env_variable
---
semantic_router/encoders/bedrock.py | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/semantic_router/encoders/bedrock.py b/semantic_router/encoders/bedrock.py
index 40b43411..1a32baea 100644
--- a/semantic_router/encoders/bedrock.py
+++ b/semantic_router/encoders/bedrock.py
@@ -250,6 +250,20 @@ class BedrockEncoder(BaseEncoder):
@staticmethod
def get_env_variable(var_name, provided_value, default=None):
+ """Retrieves environment variable or uses a provided value.
+
+ Args:
+ var_name (str): The name of the environment variable.
+ provided_value (Optional[str]): The provided value to use if not None.
+ default (Optional[str]): The default value if the environment variable is not set.
+
+ Returns:
+ str: The value of the environment variable or the provided/default value.
+ None: Where AWS_SESSION_TOKEN is not set or provided
+
+ Raises:
+ ValueError: If no value is provided and the environment variable is not set.
+ """
if provided_value is not None:
return provided_value
value = os.getenv(var_name, default)
--
GitLab