github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-09-28 23:07:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs[patch]: Improve env variable handling in documentation notebooks (#26347)

Browse Source 
Updated using gritql

```
`os.environ[$key] = getpass($msg)` as $M where {
    $M <: ! within if_statement(),
    $M => `if $key not in os.environ: $M`
}
```
This commit is contained in:
Eugene Yurtsev
2024-09-11 15:39:39 -04:00
committed by GitHub
parent 20f880ac84
commit bbb7c267e5
43 changed files with 116 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
cookbook/code-analysis-deeplake.ipynb
View File

@@ -90,6 +90,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()\n",
"# Please manually enter OpenAI Key"
]

1
docs/docs/how_to/assign.ipynb
View File

@@ -45,6 +45,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/binding.ipynb
View File

@@ -49,6 +49,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/chat_model_caching.ipynb
View File

@@ -50,6 +50,7 @@
"\n",
"from langchain_openai import ChatOpenAI\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()\n",
"\n",
"llm = ChatOpenAI()"

2
docs/docs/how_to/configure.ipynb
View File

@@ -58,6 +58,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},
@@ -281,6 +282,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"ANTHROPIC_API_KEY\" not in os.environ:\n",
" os.environ[\"ANTHROPIC_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/few_shot_examples_chat.ipynb
View File

@@ -66,6 +66,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/functions.ipynb
View File

@@ -54,6 +54,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/llm_caching.ipynb
View File

@@ -25,6 +25,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()\n",
"# Please manually enter OpenAI Key"
]

1
docs/docs/how_to/output_parser_json.ipynb
View File

@@ -47,6 +47,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/output_parser_xml.ipynb
View File

@@ -41,6 +41,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"ANTHROPIC_API_KEY\" not in os.environ:\n",
" os.environ[\"ANTHROPIC_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/output_parser_yaml.ipynb
View File

@@ -39,6 +39,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/parallel.ipynb
View File

@@ -60,6 +60,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/passthrough.ipynb
View File

@@ -46,6 +46,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/how_to/sequence.ipynb
View File

@@ -62,6 +62,7 @@
"\n",
"from langchain_anthropic import ChatAnthropic\n",
"\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)"

1
docs/docs/how_to/tool_calling_parallel.ipynb
View File

@@ -57,6 +57,7 @@
"\n",
"from langchain_openai import ChatOpenAI\n",
"\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)"

1
docs/docs/how_to/tool_choice.ipynb
View File

@@ -57,6 +57,7 @@
"\n",
"from langchain_openai import ChatOpenAI\n",
"\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)"

1
docs/docs/how_to/tool_results_pass_to_model.ipynb
View File

@@ -53,6 +53,7 @@
"\n",
"from langchain_openai import ChatOpenAI\n",
"\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)"

1
docs/docs/how_to/tool_streaming.ipynb
View File

@@ -58,6 +58,7 @@
"\n",
"from langchain_openai import ChatOpenAI\n",
"\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",

1
docs/docs/how_to/tools_few_shot.ipynb
View File

@@ -46,6 +46,7 @@
"\n",
"from langchain_openai import ChatOpenAI\n",
"\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",

54
docs/docs/integrations/chat/ai21.ipynb
View File

@@ -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",
"if \"AI21_API_KEY\" not in os.environ:\n",
" os.environ[\"AI21_API_KEY\"] = getpass()"
],
"outputs": [],
"execution_count": null
]
},
{
"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,6 +223,7 @@
"from langchain_core.tools import tool\n",
"from langchain_core.utils.function_calling import convert_to_openai_tool\n",
"\n",
"if \"AI21_API_KEY\" not in os.environ:\n",
" os.environ[\"AI21_API_KEY\"] = getpass()\n",
"\n",
"\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",

1
docs/docs/integrations/chat/anyscale.ipynb
View File

@@ -54,6 +54,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"ANYSCALE_API_KEY\" not in os.environ:\n",
" os.environ[\"ANYSCALE_API_KEY\"] = getpass()"
]
},

1
docs/docs/integrations/chat/everlyai.ipynb
View File

@@ -47,6 +47,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"EVERLYAI_API_KEY\" not in os.environ:\n",
" os.environ[\"EVERLYAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/integrations/chat/gigachat.ipynb
View File

@@ -47,6 +47,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"GIGACHAT_CREDENTIALS\" not in os.environ:\n",
" os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()"
]
},

1
docs/docs/integrations/document_transformers/ai21_semantic_text_splitter.ipynb
View File

@@ -58,6 +58,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"AI21_API_KEY\" not in os.environ:\n",
" os.environ[\"AI21_API_KEY\"] = getpass()"
]
},

1
docs/docs/integrations/llm_caching.ipynb
View File

@@ -24,6 +24,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/integrations/llms/ai21.ipynb
View File

@@ -67,6 +67,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"AI21_API_KEY\" not in os.environ:\n",
" os.environ[\"AI21_API_KEY\"] = getpass()"
]
},

1
docs/docs/integrations/llms/anthropic.ipynb
View File

@@ -67,6 +67,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"ANTHROPIC_API_KEY\" not in os.environ:\n",
" os.environ[\"ANTHROPIC_API_KEY\"] = getpass()"
]
},

1
docs/docs/integrations/llms/gigachat.ipynb
View File

@@ -47,6 +47,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"GIGACHAT_CREDENTIALS\" not in os.environ:\n",
" os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()"
]
},

1
docs/docs/integrations/retrievers/embedchain.ipynb
View File

@@ -68,6 +68,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/integrations/retrievers/outline.ipynb
View File

@@ -128,6 +128,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key:\")"
]
},

1
docs/docs/integrations/retrievers/self_query/astradb.ipynb
View File

@@ -48,6 +48,7 @@
"\n",
"from langchain_openai.embeddings import OpenAIEmbeddings\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key:\")\n",
"\n",
"embeddings = OpenAIEmbeddings()"

1
docs/docs/integrations/text_embedding/gigachat.ipynb
View File

@@ -44,6 +44,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"GIGACHAT_CREDENTIALS\" not in os.environ:\n",
" os.environ[\"GIGACHAT_CREDENTIALS\"] = getpass()"
]
},

1
docs/docs/integrations/vectorstores/apache_doris.ipynb
View File

@@ -245,6 +245,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/integrations/vectorstores/cassandra.ipynb
View File

@@ -90,6 +90,7 @@
"metadata": {},
"outputs": [],
"source": [
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass(\"OPENAI_API_KEY = \")"
]
},

1
docs/docs/integrations/vectorstores/kdbai.ipynb
View File

@@ -61,6 +61,7 @@
"source": [
"KDBAI_ENDPOINT = input(\"KDB.AI endpoint: \")\n",
"KDBAI_API_KEY = getpass(\"KDB.AI API key: \")\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass(\"OpenAI API Key: \")"
]
},

1
docs/docs/integrations/vectorstores/sklearn.ipynb
View File

@@ -44,6 +44,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass(\"Enter your OpenAI key:\")"
]
},

1
docs/docs/versions/migrating_chains/constitutional_chain.ipynb
View File

@@ -39,6 +39,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/versions/migrating_chains/conversation_chain.ipynb
View File

@@ -38,6 +38,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/versions/migrating_chains/conversation_retrieval_chain.ipynb
View File

@@ -46,6 +46,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/versions/migrating_chains/llm_math_chain.ipynb
View File

@@ -37,6 +37,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/versions/migrating_chains/llm_router_chain.ipynb
View File

@@ -100,6 +100,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/versions/migrating_chains/multi_prompt_chain.ipynb
View File

@@ -40,6 +40,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},

1
docs/docs/versions/migrating_chains/retrieval_qa.ipynb
View File

@@ -44,6 +44,7 @@
"import os\n",
"from getpass import getpass\n",
"\n",
"if \"OPENAI_API_KEY\" not in os.environ:\n",
" os.environ[\"OPENAI_API_KEY\"] = getpass()"
]
},