From bbb7c267e556edea932005220166eb8ab00e36a5 Mon Sep 17 00:00:00 2001 From: Eugene Yurtsev Date: Wed, 11 Sep 2024 15:39:39 -0400 Subject: [PATCH] docs[patch]: Improve env variable handling in documentation notebooks (#26347) Updated using gritql ``` `os.environ[$key] = getpass($msg)` as $M where { $M <: ! within if_statement(), $M => `if $key not in os.environ: $M` } ``` --- cookbook/code-analysis-deeplake.ipynb | 3 +- docs/docs/how_to/assign.ipynb | 3 +- docs/docs/how_to/binding.ipynb | 3 +- docs/docs/how_to/chat_model_caching.ipynb | 3 +- docs/docs/how_to/configure.ipynb | 6 +- docs/docs/how_to/few_shot_examples_chat.ipynb | 3 +- docs/docs/how_to/functions.ipynb | 3 +- docs/docs/how_to/llm_caching.ipynb | 3 +- docs/docs/how_to/output_parser_json.ipynb | 3 +- docs/docs/how_to/output_parser_xml.ipynb | 3 +- docs/docs/how_to/output_parser_yaml.ipynb | 3 +- docs/docs/how_to/parallel.ipynb | 3 +- docs/docs/how_to/passthrough.ipynb | 3 +- docs/docs/how_to/sequence.ipynb | 3 +- docs/docs/how_to/tool_calling_parallel.ipynb | 3 +- docs/docs/how_to/tool_choice.ipynb | 3 +- .../how_to/tool_results_pass_to_model.ipynb | 3 +- docs/docs/how_to/tool_streaming.ipynb | 3 +- docs/docs/how_to/tools_few_shot.ipynb | 3 +- docs/docs/integrations/chat/ai21.ipynb | 58 ++++++++++--------- docs/docs/integrations/chat/anyscale.ipynb | 3 +- docs/docs/integrations/chat/everlyai.ipynb | 3 +- docs/docs/integrations/chat/gigachat.ipynb | 3 +- .../ai21_semantic_text_splitter.ipynb | 3 +- docs/docs/integrations/llm_caching.ipynb | 3 +- docs/docs/integrations/llms/ai21.ipynb | 3 +- docs/docs/integrations/llms/anthropic.ipynb | 3 +- docs/docs/integrations/llms/gigachat.ipynb | 3 +- .../integrations/retrievers/embedchain.ipynb | 3 +- .../integrations/retrievers/outline.ipynb | 3 +- .../retrievers/self_query/astradb.ipynb | 3 +- .../text_embedding/gigachat.ipynb | 3 +- .../vectorstores/apache_doris.ipynb | 3 +- .../integrations/vectorstores/cassandra.ipynb | 3 +- .../integrations/vectorstores/kdbai.ipynb | 3 +- .../integrations/vectorstores/sklearn.ipynb | 3 +- .../constitutional_chain.ipynb | 3 +- .../migrating_chains/conversation_chain.ipynb | 3 +- .../conversation_retrieval_chain.ipynb | 3 +- .../migrating_chains/llm_math_chain.ipynb | 3 +- .../migrating_chains/llm_router_chain.ipynb | 3 +- .../migrating_chains/multi_prompt_chain.ipynb | 3 +- .../migrating_chains/retrieval_qa.ipynb | 3 +- 43 files changed, 116 insertions(+), 71 deletions(-) diff --git a/cookbook/code-analysis-deeplake.ipynb b/cookbook/code-analysis-deeplake.ipynb index 243ae0141c7..e895147d12d 100644 --- a/cookbook/code-analysis-deeplake.ipynb +++ b/cookbook/code-analysis-deeplake.ipynb @@ -90,7 +90,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()\n", "# Please manually enter OpenAI Key" ] }, diff --git a/docs/docs/how_to/assign.ipynb b/docs/docs/how_to/assign.ipynb index c43bfc9606b..a48623ac2ce 100644 --- a/docs/docs/how_to/assign.ipynb +++ b/docs/docs/how_to/assign.ipynb @@ -45,7 +45,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/binding.ipynb b/docs/docs/how_to/binding.ipynb index 0589d33631c..ce2b8a0a8dd 100644 --- a/docs/docs/how_to/binding.ipynb +++ b/docs/docs/how_to/binding.ipynb @@ -49,7 +49,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/chat_model_caching.ipynb b/docs/docs/how_to/chat_model_caching.ipynb index f153750db35..37c3cd5d65e 100644 --- a/docs/docs/how_to/chat_model_caching.ipynb +++ b/docs/docs/how_to/chat_model_caching.ipynb @@ -50,7 +50,8 @@ "\n", "from langchain_openai import ChatOpenAI\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()\n", "\n", "llm = ChatOpenAI()" ] diff --git a/docs/docs/how_to/configure.ipynb b/docs/docs/how_to/configure.ipynb index 6633fd8bff2..80758c55727 100644 --- a/docs/docs/how_to/configure.ipynb +++ b/docs/docs/how_to/configure.ipynb @@ -58,7 +58,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { @@ -281,7 +282,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"ANTHROPIC_API_KEY\"] = getpass()" + "if \"ANTHROPIC_API_KEY\" not in os.environ:\n", + " os.environ[\"ANTHROPIC_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/few_shot_examples_chat.ipynb b/docs/docs/how_to/few_shot_examples_chat.ipynb index 19f00cf15dd..d01b24cd16f 100644 --- a/docs/docs/how_to/few_shot_examples_chat.ipynb +++ b/docs/docs/how_to/few_shot_examples_chat.ipynb @@ -66,7 +66,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/functions.ipynb b/docs/docs/how_to/functions.ipynb index b028c4c0330..c2fb7905339 100644 --- a/docs/docs/how_to/functions.ipynb +++ b/docs/docs/how_to/functions.ipynb @@ -54,7 +54,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/llm_caching.ipynb b/docs/docs/how_to/llm_caching.ipynb index a05b9111568..1ed564b393e 100644 --- a/docs/docs/how_to/llm_caching.ipynb +++ b/docs/docs/how_to/llm_caching.ipynb @@ -25,7 +25,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()\n", "# Please manually enter OpenAI Key" ] }, diff --git a/docs/docs/how_to/output_parser_json.ipynb b/docs/docs/how_to/output_parser_json.ipynb index 718f3b2f70b..646b72514c3 100644 --- a/docs/docs/how_to/output_parser_json.ipynb +++ b/docs/docs/how_to/output_parser_json.ipynb @@ -47,7 +47,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/output_parser_xml.ipynb b/docs/docs/how_to/output_parser_xml.ipynb index fd23ef3adab..ff63ca53465 100644 --- a/docs/docs/how_to/output_parser_xml.ipynb +++ b/docs/docs/how_to/output_parser_xml.ipynb @@ -41,7 +41,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"ANTHROPIC_API_KEY\"] = getpass()" + "if \"ANTHROPIC_API_KEY\" not in os.environ:\n", + " os.environ[\"ANTHROPIC_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/output_parser_yaml.ipynb b/docs/docs/how_to/output_parser_yaml.ipynb index 48abc351b8f..af11c084377 100644 --- a/docs/docs/how_to/output_parser_yaml.ipynb +++ b/docs/docs/how_to/output_parser_yaml.ipynb @@ -39,7 +39,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/parallel.ipynb b/docs/docs/how_to/parallel.ipynb index 3590c0a671c..5f1c23428b5 100644 --- a/docs/docs/how_to/parallel.ipynb +++ b/docs/docs/how_to/parallel.ipynb @@ -60,7 +60,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/passthrough.ipynb b/docs/docs/how_to/passthrough.ipynb index 496cb6aae4d..8bd8e775ffc 100644 --- a/docs/docs/how_to/passthrough.ipynb +++ b/docs/docs/how_to/passthrough.ipynb @@ -46,7 +46,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/how_to/sequence.ipynb b/docs/docs/how_to/sequence.ipynb index b4da854eb13..c4ae076baab 100644 --- a/docs/docs/how_to/sequence.ipynb +++ b/docs/docs/how_to/sequence.ipynb @@ -62,7 +62,8 @@ "\n", "from langchain_anthropic import ChatAnthropic\n", "\n", - "os.environ[\"ANTHROPIC_API_KEY\"] = getpass()\n", + "if \"ANTHROPIC_API_KEY\" not in os.environ:\n", + " os.environ[\"ANTHROPIC_API_KEY\"] = getpass()\n", "\n", "model = ChatAnthropic(model=\"claude-3-sonnet-20240229\", temperature=0)" ] diff --git a/docs/docs/how_to/tool_calling_parallel.ipynb b/docs/docs/how_to/tool_calling_parallel.ipynb index 6567562d11b..e4671bf9837 100644 --- a/docs/docs/how_to/tool_calling_parallel.ipynb +++ b/docs/docs/how_to/tool_calling_parallel.ipynb @@ -57,7 +57,8 @@ "\n", "from langchain_openai import ChatOpenAI\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()\n", "\n", "llm = ChatOpenAI(model=\"gpt-4o-mini\", temperature=0)" ] diff --git a/docs/docs/how_to/tool_choice.ipynb b/docs/docs/how_to/tool_choice.ipynb index 531eef184d2..075d9a0a629 100644 --- a/docs/docs/how_to/tool_choice.ipynb +++ b/docs/docs/how_to/tool_choice.ipynb @@ -57,7 +57,8 @@ "\n", "from langchain_openai import ChatOpenAI\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()\n", "\n", "llm = ChatOpenAI(model=\"gpt-4o-mini\", temperature=0)" ] diff --git a/docs/docs/how_to/tool_results_pass_to_model.ipynb b/docs/docs/how_to/tool_results_pass_to_model.ipynb index ac17ae77494..87f451e7367 100644 --- a/docs/docs/how_to/tool_results_pass_to_model.ipynb +++ b/docs/docs/how_to/tool_results_pass_to_model.ipynb @@ -53,7 +53,8 @@ "\n", "from langchain_openai import ChatOpenAI\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()\n", "\n", "llm = ChatOpenAI(model=\"gpt-4o-mini\", temperature=0)" ] diff --git a/docs/docs/how_to/tool_streaming.ipynb b/docs/docs/how_to/tool_streaming.ipynb index e3b76d68e89..54a92e9bc62 100644 --- a/docs/docs/how_to/tool_streaming.ipynb +++ b/docs/docs/how_to/tool_streaming.ipynb @@ -58,7 +58,8 @@ "\n", "from langchain_openai import ChatOpenAI\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()\n", "\n", "llm = ChatOpenAI(model=\"gpt-4o-mini\", temperature=0)\n", "llm_with_tools = llm.bind_tools(tools)" diff --git a/docs/docs/how_to/tools_few_shot.ipynb b/docs/docs/how_to/tools_few_shot.ipynb index 9f3b7e337de..0e3d6564874 100644 --- a/docs/docs/how_to/tools_few_shot.ipynb +++ b/docs/docs/how_to/tools_few_shot.ipynb @@ -46,7 +46,8 @@ "\n", "from langchain_openai import ChatOpenAI\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()\n", "\n", "llm = ChatOpenAI(model=\"gpt-4o-mini\", temperature=0)\n", "llm_with_tools = llm.bind_tools(tools)" diff --git a/docs/docs/integrations/chat/ai21.ipynb b/docs/docs/integrations/chat/ai21.ipynb index 38429aa9153..bd1410d2d15 100644 --- a/docs/docs/integrations/chat/ai21.ipynb +++ b/docs/docs/integrations/chat/ai21.ipynb @@ -50,18 +50,19 @@ }, { "cell_type": "code", + "execution_count": null, "id": "62e0dbc3", "metadata": { "tags": [] }, + "outputs": [], "source": [ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"AI21_API_KEY\"] = getpass()" - ], - "outputs": [], - "execution_count": null + "if \"AI21_API_KEY\" not in os.environ:\n", + " os.environ[\"AI21_API_KEY\"] = getpass()" + ] }, { "cell_type": "markdown", @@ -73,14 +74,14 @@ }, { "cell_type": "code", + "execution_count": null, "id": "7c2e19d3-7c58-4470-9e1a-718b27a32056", "metadata": {}, + "outputs": [], "source": [ "# os.environ[\"LANGCHAIN_TRACING_V2\"] = \"true\"\n", "# os.environ[\"LANGCHAIN_API_KEY\"] = getpass.getpass(\"Enter your LangSmith API key: \")" - ], - "outputs": [], - "execution_count": null + ] }, { "cell_type": "markdown", @@ -115,15 +116,15 @@ }, { "cell_type": "code", + "execution_count": null, "id": "c40756fb-cbf8-4d44-a293-3989d707237e", "metadata": {}, + "outputs": [], "source": [ "from langchain_ai21 import ChatAI21\n", "\n", "llm = ChatAI21(model=\"jamba-instruct\", temperature=0)" - ], - "outputs": [], - "execution_count": null + ] }, { "cell_type": "markdown", @@ -135,8 +136,10 @@ }, { "cell_type": "code", + "execution_count": null, "id": "46b982dc-5d8a-46da-a711-81c03ccd6adc", "metadata": {}, + "outputs": [], "source": [ "messages = [\n", " (\n", @@ -147,9 +150,7 @@ "]\n", "ai_msg = llm.invoke(messages)\n", "ai_msg" - ], - "outputs": [], - "execution_count": null + ] }, { "cell_type": "markdown", @@ -163,6 +164,7 @@ }, { "cell_type": "code", + "execution_count": null, "id": "39353473fce5dd2e", "metadata": { "collapsed": false, @@ -170,6 +172,7 @@ "outputs_hidden": false } }, + "outputs": [], "source": [ "from langchain_core.prompts import ChatPromptTemplate\n", "\n", @@ -191,25 +194,26 @@ " \"input\": \"I love programming.\",\n", " }\n", ")" - ], - "outputs": [], - "execution_count": null + ] }, { - "metadata": {}, "cell_type": "markdown", - "source": "# Tool Calls / Function Calling", - "id": "39c0ccd229927eab" + "id": "39c0ccd229927eab", + "metadata": {}, + "source": "# Tool Calls / Function Calling" }, { - "metadata": {}, "cell_type": "markdown", - "source": "This example shows how to use tool calling with AI21 models:", - "id": "2bf6b40be07fe2d4" + "id": "2bf6b40be07fe2d4", + "metadata": {}, + "source": "This example shows how to use tool calling with AI21 models:" }, { - "metadata": {}, "cell_type": "code", + "execution_count": null, + "id": "a181a28df77120fb", + "metadata": {}, + "outputs": [], "source": [ "import os\n", "from getpass import getpass\n", @@ -219,7 +223,8 @@ "from langchain_core.tools import tool\n", "from langchain_core.utils.function_calling import convert_to_openai_tool\n", "\n", - "os.environ[\"AI21_API_KEY\"] = getpass()\n", + "if \"AI21_API_KEY\" not in os.environ:\n", + " os.environ[\"AI21_API_KEY\"] = getpass()\n", "\n", "\n", "@tool\n", @@ -276,10 +281,7 @@ " print(f\"Assistant: {llm_answer.content}\")\n", " else:\n", " print(f\"Assistant: {response.content}\")" - ], - "id": "a181a28df77120fb", - "outputs": [], - "execution_count": null + ] }, { "cell_type": "markdown", diff --git a/docs/docs/integrations/chat/anyscale.ipynb b/docs/docs/integrations/chat/anyscale.ipynb index 98cac216ad3..84008c195ef 100644 --- a/docs/docs/integrations/chat/anyscale.ipynb +++ b/docs/docs/integrations/chat/anyscale.ipynb @@ -54,7 +54,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"ANYSCALE_API_KEY\"] = getpass()" + "if \"ANYSCALE_API_KEY\" not in os.environ:\n", + " os.environ[\"ANYSCALE_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/chat/everlyai.ipynb b/docs/docs/integrations/chat/everlyai.ipynb index 511b81dd634..3e3fabc45ed 100644 --- a/docs/docs/integrations/chat/everlyai.ipynb +++ b/docs/docs/integrations/chat/everlyai.ipynb @@ -47,7 +47,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"EVERLYAI_API_KEY\"] = getpass()" + "if \"EVERLYAI_API_KEY\" not in os.environ:\n", + " os.environ[\"EVERLYAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/chat/gigachat.ipynb b/docs/docs/integrations/chat/gigachat.ipynb index 8676c26875d..3fbb13ce419 100644 --- a/docs/docs/integrations/chat/gigachat.ipynb +++ b/docs/docs/integrations/chat/gigachat.ipynb @@ -47,7 +47,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()" + "if \"GIGACHAT_CREDENTIALS\" not in os.environ:\n", + " os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/document_transformers/ai21_semantic_text_splitter.ipynb b/docs/docs/integrations/document_transformers/ai21_semantic_text_splitter.ipynb index ce67c73809e..e4e98205eb9 100644 --- a/docs/docs/integrations/document_transformers/ai21_semantic_text_splitter.ipynb +++ b/docs/docs/integrations/document_transformers/ai21_semantic_text_splitter.ipynb @@ -58,7 +58,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"AI21_API_KEY\"] = getpass()" + "if \"AI21_API_KEY\" not in os.environ:\n", + " os.environ[\"AI21_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/llm_caching.ipynb b/docs/docs/integrations/llm_caching.ipynb index 7c9930bd1f1..f0f4a7ce585 100644 --- a/docs/docs/integrations/llm_caching.ipynb +++ b/docs/docs/integrations/llm_caching.ipynb @@ -24,7 +24,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/llms/ai21.ipynb b/docs/docs/integrations/llms/ai21.ipynb index da2ec1293c1..f48e29c9c66 100644 --- a/docs/docs/integrations/llms/ai21.ipynb +++ b/docs/docs/integrations/llms/ai21.ipynb @@ -67,7 +67,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"AI21_API_KEY\"] = getpass()" + "if \"AI21_API_KEY\" not in os.environ:\n", + " os.environ[\"AI21_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/llms/anthropic.ipynb b/docs/docs/integrations/llms/anthropic.ipynb index 7db347cc1ff..0f9c74c225a 100644 --- a/docs/docs/integrations/llms/anthropic.ipynb +++ b/docs/docs/integrations/llms/anthropic.ipynb @@ -67,7 +67,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"ANTHROPIC_API_KEY\"] = getpass()" + "if \"ANTHROPIC_API_KEY\" not in os.environ:\n", + " os.environ[\"ANTHROPIC_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/llms/gigachat.ipynb b/docs/docs/integrations/llms/gigachat.ipynb index 19400be4474..400f492d9be 100644 --- a/docs/docs/integrations/llms/gigachat.ipynb +++ b/docs/docs/integrations/llms/gigachat.ipynb @@ -47,7 +47,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()" + "if \"GIGACHAT_CREDENTIALS\" not in os.environ:\n", + " os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/retrievers/embedchain.ipynb b/docs/docs/integrations/retrievers/embedchain.ipynb index 5c4d883aac1..1cf987b1d94 100644 --- a/docs/docs/integrations/retrievers/embedchain.ipynb +++ b/docs/docs/integrations/retrievers/embedchain.ipynb @@ -68,7 +68,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/retrievers/outline.ipynb b/docs/docs/integrations/retrievers/outline.ipynb index fcaec16866a..ad58474813a 100644 --- a/docs/docs/integrations/retrievers/outline.ipynb +++ b/docs/docs/integrations/retrievers/outline.ipynb @@ -128,7 +128,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key:\")" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key:\")" ] }, { diff --git a/docs/docs/integrations/retrievers/self_query/astradb.ipynb b/docs/docs/integrations/retrievers/self_query/astradb.ipynb index 96b8ad83ff8..a170a306f1b 100644 --- a/docs/docs/integrations/retrievers/self_query/astradb.ipynb +++ b/docs/docs/integrations/retrievers/self_query/astradb.ipynb @@ -48,7 +48,8 @@ "\n", "from langchain_openai.embeddings import OpenAIEmbeddings\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key:\")\n", + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key:\")\n", "\n", "embeddings = OpenAIEmbeddings()" ] diff --git a/docs/docs/integrations/text_embedding/gigachat.ipynb b/docs/docs/integrations/text_embedding/gigachat.ipynb index 855ec550d6f..1f98f3f4f74 100644 --- a/docs/docs/integrations/text_embedding/gigachat.ipynb +++ b/docs/docs/integrations/text_embedding/gigachat.ipynb @@ -44,7 +44,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()" + "if \"GIGACHAT_CREDENTIALS\" not in os.environ:\n", + " os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/vectorstores/apache_doris.ipynb b/docs/docs/integrations/vectorstores/apache_doris.ipynb index 92239a7a60b..1dcf6204285 100644 --- a/docs/docs/integrations/vectorstores/apache_doris.ipynb +++ b/docs/docs/integrations/vectorstores/apache_doris.ipynb @@ -245,7 +245,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/integrations/vectorstores/cassandra.ipynb b/docs/docs/integrations/vectorstores/cassandra.ipynb index e7f9a19a62d..b18eaab887d 100644 --- a/docs/docs/integrations/vectorstores/cassandra.ipynb +++ b/docs/docs/integrations/vectorstores/cassandra.ipynb @@ -90,7 +90,8 @@ "metadata": {}, "outputs": [], "source": [ - "os.environ[\"OPENAI_API_KEY\"] = getpass(\"OPENAI_API_KEY = \")" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass(\"OPENAI_API_KEY = \")" ] }, { diff --git a/docs/docs/integrations/vectorstores/kdbai.ipynb b/docs/docs/integrations/vectorstores/kdbai.ipynb index 74d177548de..a645c3be563 100644 --- a/docs/docs/integrations/vectorstores/kdbai.ipynb +++ b/docs/docs/integrations/vectorstores/kdbai.ipynb @@ -61,7 +61,8 @@ "source": [ "KDBAI_ENDPOINT = input(\"KDB.AI endpoint: \")\n", "KDBAI_API_KEY = getpass(\"KDB.AI API key: \")\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key: \")" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key: \")" ] }, { diff --git a/docs/docs/integrations/vectorstores/sklearn.ipynb b/docs/docs/integrations/vectorstores/sklearn.ipynb index af1c93c02d1..d54f2156be2 100644 --- a/docs/docs/integrations/vectorstores/sklearn.ipynb +++ b/docs/docs/integrations/vectorstores/sklearn.ipynb @@ -44,7 +44,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass(\"Enter your OpenAI key:\")" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass(\"Enter your OpenAI key:\")" ] }, { diff --git a/docs/docs/versions/migrating_chains/constitutional_chain.ipynb b/docs/docs/versions/migrating_chains/constitutional_chain.ipynb index 91d813bb10f..66db7669b4a 100644 --- a/docs/docs/versions/migrating_chains/constitutional_chain.ipynb +++ b/docs/docs/versions/migrating_chains/constitutional_chain.ipynb @@ -39,7 +39,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/versions/migrating_chains/conversation_chain.ipynb b/docs/docs/versions/migrating_chains/conversation_chain.ipynb index 77e5b345bdc..fe778f1bd08 100644 --- a/docs/docs/versions/migrating_chains/conversation_chain.ipynb +++ b/docs/docs/versions/migrating_chains/conversation_chain.ipynb @@ -38,7 +38,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/versions/migrating_chains/conversation_retrieval_chain.ipynb b/docs/docs/versions/migrating_chains/conversation_retrieval_chain.ipynb index 75a37d36c60..99b12fb7c35 100644 --- a/docs/docs/versions/migrating_chains/conversation_retrieval_chain.ipynb +++ b/docs/docs/versions/migrating_chains/conversation_retrieval_chain.ipynb @@ -46,7 +46,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/versions/migrating_chains/llm_math_chain.ipynb b/docs/docs/versions/migrating_chains/llm_math_chain.ipynb index c9d5470946b..71dc8afab9e 100644 --- a/docs/docs/versions/migrating_chains/llm_math_chain.ipynb +++ b/docs/docs/versions/migrating_chains/llm_math_chain.ipynb @@ -37,7 +37,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/versions/migrating_chains/llm_router_chain.ipynb b/docs/docs/versions/migrating_chains/llm_router_chain.ipynb index 92fec7f9bdb..fb0cfc03757 100644 --- a/docs/docs/versions/migrating_chains/llm_router_chain.ipynb +++ b/docs/docs/versions/migrating_chains/llm_router_chain.ipynb @@ -100,7 +100,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/versions/migrating_chains/multi_prompt_chain.ipynb b/docs/docs/versions/migrating_chains/multi_prompt_chain.ipynb index 85f5ce7a0e1..b49c1708efe 100644 --- a/docs/docs/versions/migrating_chains/multi_prompt_chain.ipynb +++ b/docs/docs/versions/migrating_chains/multi_prompt_chain.ipynb @@ -40,7 +40,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, { diff --git a/docs/docs/versions/migrating_chains/retrieval_qa.ipynb b/docs/docs/versions/migrating_chains/retrieval_qa.ipynb index d931a810385..4bcbeb6a810 100644 --- a/docs/docs/versions/migrating_chains/retrieval_qa.ipynb +++ b/docs/docs/versions/migrating_chains/retrieval_qa.ipynb @@ -44,7 +44,8 @@ "import os\n", "from getpass import getpass\n", "\n", - "os.environ[\"OPENAI_API_KEY\"] = getpass()" + "if \"OPENAI_API_KEY\" not in os.environ:\n", + " os.environ[\"OPENAI_API_KEY\"] = getpass()" ] }, {