add docstrings and reno

deepset-ai · May 7, 2024 · 6e55270 · 6e55270
1 parent 7d031d5
commit 6e55270
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 0 deletions.
diff --git a/haystack/components/embedders/openai_document_embedder.py b/haystack/components/embedders/openai_document_embedder.py
@@ -46,6 +46,9 @@ def __init__(
         """
         Create a OpenAIDocumentEmbedder component.
 
+        By setting the 'OPENAI_TIMEOUT' and 'OPENAI_MAX_RETRIES' you can change the timeout and max_retries parameters in the OpenAI client.
+
+
         :param api_key:
             The OpenAI API key.
         :param model:

diff --git a/haystack/components/embedders/openai_text_embedder.py b/haystack/components/embedders/openai_text_embedder.py
@@ -44,6 +44,8 @@ def __init__(
         """
         Create an OpenAITextEmbedder component.
 
+        By setting the 'OPENAI_TIMEOUT' and 'OPENAI_MAX_RETRIES' you can change the timeout and max_retries parameters in the OpenAI client.
+
         :param api_key:
             The OpenAI API key.
         :param model:

diff --git a/haystack/components/generators/chat/openai.py b/haystack/components/generators/chat/openai.py
@@ -79,6 +79,8 @@ def __init__(
         Creates an instance of OpenAIChatGenerator. Unless specified otherwise in the `model`, this is for OpenAI's
         GPT-3.5 model.
 
+        By setting the 'OPENAI_TIMEOUT' and 'OPENAI_MAX_RETRIES' you can change the timeout and max_retries parameters in the OpenAI client.
+
         :param api_key: The OpenAI API key.
         :param model: The name of the model to use.
         :param streaming_callback: A callback function that is called when a new token is received from the stream.

diff --git a/haystack/components/generators/openai.py b/haystack/components/generators/openai.py
@@ -61,6 +61,9 @@ def __init__(
         """
         Creates an instance of OpenAIGenerator. Unless specified otherwise in the `model`, this is for OpenAI's GPT-3.5 model.
 
+        By setting the 'OPENAI_TIMEOUT' and 'OPENAI_MAX_RETRIES' you can change the timeout and max_retries parameters in the OpenAI client.
+
+
         :param api_key: The OpenAI API key.
         :param model: The name of the model to use.
         :param streaming_callback: A callback function that is called when a new token is received from the stream.

diff --git a/...enotes/notes/feat-widen-support-of-envars-vars-on-openai-components-efe6203c0c6bd7b3.yaml b/...enotes/notes/feat-widen-support-of-envars-vars-on-openai-components-efe6203c0c6bd7b3.yaml
@@ -0,0 +1,9 @@
+---
+highlights: >
+    Add the 'OPENAI_TIMEOUT' and 'OPENAI_MAX_RETRIES' to the OpenAI components.
+enhancements:
+  - |
+    Now you can set the timeout and max_retries parameters on the OpenAI client by setting the 'OPENAI_TIMEOUT' and 'OPENAI_MAX_RETRIES' environment vars.
+issues:
+  - |
+    7610