Skip to content

Commit 073583d

Browse files
fileamesfileames
committed
Update langchain-oracledb documentation
1 parent 4828a85 commit 073583d

File tree

6 files changed

+186
-55
lines changed

6 files changed

+186
-55
lines changed

‎cookbook/oracleai_demo.ipynb

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -47,10 +47,12 @@
4747
"source": [
4848
"### Prerequisites\n",
4949
"\n",
50-
"Please install the Oracle Database [python-oracledb driver](https://pypi.org/project/oracledb/) to use LangChain with Oracle AI Vector Search:\n",
50+
"You'll need to install `langchain-oracledb` with `python -m pip install -U langchain-oracledb` to use this integration.\n",
51+
"\n",
52+
"The `python-oracledb` driver is installed automatically as a dependency of langchain-oracledb.\n",
5153
"\n",
5254
"```\n",
53-
"$ python -m pip install --upgrade oracledb\n",
55+
"$ python -m pip install -U langchain-oracledb\n",
5456
"```"
5557
]
5658
},
@@ -217,7 +219,7 @@
217219
"metadata": {},
218220
"outputs": [],
219221
"source": [
220-
"from langchain_community.embeddings.oracleai import OracleEmbeddings\n",
222+
"from langchain_oracledb.embeddings.oracleai import OracleEmbeddings\n",
221223
"\n",
222224
"# please update with your related information\n",
223225
"# make sure that you have onnx file in the system\n",
@@ -296,7 +298,7 @@
296298
"metadata": {},
297299
"outputs": [],
298300
"source": [
299-
"from langchain_community.document_loaders.oracleai import OracleDocLoader\n",
301+
"from langchain_oracledb.document_loaders.oracleai import OracleDocLoader\n",
300302
"from langchain_core.documents import Document\n",
301303
"\n",
302304
"# loading from Oracle Database table\n",
@@ -354,7 +356,7 @@
354356
"metadata": {},
355357
"outputs": [],
356358
"source": [
357-
"from langchain_community.utilities.oracleai import OracleSummary\n",
359+
"from langchain_oracledb.utilities.oracleai import OracleSummary\n",
358360
"from langchain_core.documents import Document\n",
359361
"\n",
360362
"# using 'database' provider\n",
@@ -395,7 +397,7 @@
395397
"metadata": {},
396398
"outputs": [],
397399
"source": [
398-
"from langchain_community.document_loaders.oracleai import OracleTextSplitter\n",
400+
"from langchain_oracledb.document_loaders.oracleai import OracleTextSplitter\n",
399401
"from langchain_core.documents import Document\n",
400402
"\n",
401403
"# split by default parameters\n",
@@ -452,7 +454,7 @@
452454
"metadata": {},
453455
"outputs": [],
454456
"source": [
455-
"from langchain_community.embeddings.oracleai import OracleEmbeddings\n",
457+
"from langchain_oracledb.embeddings.oracleai import OracleEmbeddings\n",
456458
"from langchain_core.documents import Document\n",
457459
"\n",
458460
"# using ONNX model loaded to Oracle Database\n",
@@ -498,14 +500,14 @@
498500
"import sys\n",
499501
"\n",
500502
"import oracledb\n",
501-
"from langchain_community.document_loaders.oracleai import (\n",
503+
"from langchain_oracledb.document_loaders.oracleai import (\n",
502504
" OracleDocLoader,\n",
503505
" OracleTextSplitter,\n",
504506
")\n",
505-
"from langchain_community.embeddings.oracleai import OracleEmbeddings\n",
506-
"from langchain_community.utilities.oracleai import OracleSummary\n",
507-
"from langchain_community.vectorstores import oraclevs\n",
508-
"from langchain_community.vectorstores.oraclevs import OracleVS\n",
507+
"from langchain_oracledb.embeddings.oracleai import OracleEmbeddings\n",
508+
"from langchain_oracledb.utilities.oracleai import OracleSummary\n",
509+
"from langchain_oracledb.vectorstores import oraclevs\n",
510+
"from langchain_oracledb.vectorstores.oraclevs import OracleVS\n",
509511
"from langchain_community.vectorstores.utils import DistanceStrategy\n",
510512
"from langchain_core.documents import Document"
511513
]
@@ -677,27 +679,27 @@
677679
"outputs": [],
678680
"source": [
679681
"query = \"What is Oracle AI Vector Store?\"\n",
680-
"filter = {\"document_id\": [\"1\"]}\n",
682+
"db_filter = {\"document_id\": \"1\"}\n",
681683
"\n",
682684
"# Similarity search without a filter\n",
683685
"print(vectorstore.similarity_search(query, 1))\n",
684686
"\n",
685687
"# Similarity search with a filter\n",
686-
"print(vectorstore.similarity_search(query, 1, filter=filter))\n",
688+
"print(vectorstore.similarity_search(query, 1, db_filter=db_filter))\n",
687689
"\n",
688690
"# Similarity search with relevance score\n",
689691
"print(vectorstore.similarity_search_with_score(query, 1))\n",
690692
"\n",
691693
"# Similarity search with relevance score with filter\n",
692-
"print(vectorstore.similarity_search_with_score(query, 1, filter=filter))\n",
694+
"print(vectorstore.similarity_search_with_score(query, 1, db_filter=db_filter))\n",
693695
"\n",
694696
"# Max marginal relevance search\n",
695697
"print(vectorstore.max_marginal_relevance_search(query, 1, fetch_k=20, lambda_mult=0.5))\n",
696698
"\n",
697699
"# Max marginal relevance search with filter\n",
698700
"print(\n",
699701
" vectorstore.max_marginal_relevance_search(\n",
700-
" query, 1, fetch_k=20, lambda_mult=0.5, filter=filter\n",
702+
" query, 1, fetch_k=20, lambda_mult=0.5, db_filter=db_filter\n",
701703
" )\n",
702704
")"
703705
]

‎docs/docs/integrations/document_loaders/oracleadb_loader.ipynb

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,7 @@
1616
"This notebook covers how to load documents from Oracle Autonomous Database.\n",
1717
"\n",
1818
"## Prerequisites\n",
19-
"1. Install python-oracledb:\n",
20-
"\n",
21-
" `pip install oracledb`\n",
22-
" \n",
23-
" See [Installing python-oracledb](https://python-oracledb.readthedocs.io/en/latest/user_guide/installation.html).\n",
24-
"\n",
25-
"2. A database that python-oracledb's default 'Thin' mode can connected to. This is true of Oracle Autonomous Database, see [python-oracledb Architecture](https://python-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#architecture).\n"
19+
"1. A database that python-oracledb's default 'Thin' mode can connected to. This is true of Oracle Autonomous Database, see [python-oracledb Architecture](https://python-oracledb.readthedocs.io/en/latest/user_guide/introduction.html#architecture).\n"
2620
]
2721
},
2822
{
@@ -37,6 +31,15 @@
3731
"## Instructions"
3832
]
3933
},
34+
{
35+
"cell_type": "markdown",
36+
"metadata": {},
37+
"source": [
38+
"You'll need to install `langchain-oracledb` with `python -m pip install -U langchain-oracledb` to use this integration.\n",
39+
"\n",
40+
"The `python-oracledb` driver is installed automatically as a dependency of langchain-oracledb."
41+
]
42+
},
4043
{
4144
"cell_type": "code",
4245
"execution_count": null,
@@ -48,7 +51,7 @@
4851
},
4952
"outputs": [],
5053
"source": [
51-
"pip install oracledb"
54+
"# python -m pip install -U langchain-oracledb"
5255
]
5356
},
5457
{
@@ -62,7 +65,7 @@
6265
},
6366
"outputs": [],
6467
"source": [
65-
"from langchain_community.document_loaders import OracleAutonomousDatabaseLoader\n",
68+
"from langchain_oracledb.document_loaders import OracleAutonomousDatabaseLoader\n",
6669
"from settings import s"
6770
]
6871
},
@@ -99,7 +102,7 @@
99102
" config_dir=s.CONFIG_DIR,\n",
100103
" wallet_location=s.WALLET_LOCATION,\n",
101104
" wallet_password=s.PASSWORD,\n",
102-
" tns_name=s.TNS_NAME,\n",
105+
" dsn=s.DSN,\n",
103106
")\n",
104107
"doc_1 = doc_loader_1.load()\n",
105108
"\n",
@@ -108,7 +111,7 @@
108111
" user=s.USERNAME,\n",
109112
" password=s.PASSWORD,\n",
110113
" schema=s.SCHEMA,\n",
111-
" connection_string=s.CONNECTION_STRING,\n",
114+
" dsn=s.DSN,\n",
112115
" wallet_location=s.WALLET_LOCATION,\n",
113116
" wallet_password=s.PASSWORD,\n",
114117
")\n",
@@ -147,7 +150,7 @@
147150
" password=s.PASSWORD,\n",
148151
" schema=s.SCHEMA,\n",
149152
" config_dir=s.CONFIG_DIR,\n",
150-
" tns_name=s.TNS_NAME,\n",
153+
" dsn=s.DSN,\n",
151154
" parameters=[\"Direct Sales\"],\n",
152155
")\n",
153156
"doc_3 = doc_loader_3.load()\n",
@@ -157,7 +160,7 @@
157160
" user=s.USERNAME,\n",
158161
" password=s.PASSWORD,\n",
159162
" schema=s.SCHEMA,\n",
160-
" connection_string=s.CONNECTION_STRING,\n",
163+
" dsn=s.DSN,\n",
161164
" parameters=[\"Direct Sales\"],\n",
162165
")\n",
163166
"doc_4 = doc_loader_4.load()"

‎docs/docs/integrations/document_loaders/oracleai.ipynb

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@
4242
"source": [
4343
"### Prerequisites\n",
4444
"\n",
45-
"Please install Oracle Python Client driver to use Langchain with Oracle AI Vector Search. "
45+
"You'll need to install `langchain-oracledb` with `python -m pip install -U langchain-oracledb` to use this integration.\n",
46+
"\n",
47+
"The `python-oracledb` driver is installed automatically as a dependency of langchain-oracledb."
4648
]
4749
},
4850
{
@@ -51,7 +53,7 @@
5153
"metadata": {},
5254
"outputs": [],
5355
"source": [
54-
"# pip install oracledb"
56+
"# python -m pip install -U langchain-oracledb"
5557
]
5658
},
5759
{
@@ -154,7 +156,7 @@
154156
"metadata": {},
155157
"outputs": [],
156158
"source": [
157-
"from langchain_community.document_loaders.oracleai import OracleDocLoader\n",
159+
"from langchain_oracledb.document_loaders.oracleai import OracleDocLoader\n",
158160
"from langchain_core.documents import Document\n",
159161
"\n",
160162
"\"\"\"\n",
@@ -199,7 +201,7 @@
199201
"metadata": {},
200202
"outputs": [],
201203
"source": [
202-
"from langchain_community.document_loaders.oracleai import OracleTextSplitter\n",
204+
"from langchain_oracledb.document_loaders.oracleai import OracleTextSplitter\n",
203205
"from langchain_core.documents import Document\n",
204206
"\n",
205207
"\"\"\"\n",

‎docs/docs/integrations/text_embedding/oracleai.ipynb

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@
4242
"source": [
4343
"### Prerequisites\n",
4444
"\n",
45-
"Ensure you have the Oracle Python Client driver installed to facilitate the integration of Langchain with Oracle AI Vector Search."
45+
"You'll need to install `langchain-oracledb` with `python -m pip install -U langchain-oracledb` to use this integration.\n",
46+
"\n",
47+
"The `python-oracledb` driver is installed automatically as a dependency of langchain-oracledb."
4648
]
4749
},
4850
{
@@ -51,7 +53,7 @@
5153
"metadata": {},
5254
"outputs": [],
5355
"source": [
54-
"# pip install oracledb"
56+
"# python -m pip install -U langchain-oracledb"
5557
]
5658
},
5759
{
@@ -113,7 +115,7 @@
113115
"metadata": {},
114116
"outputs": [],
115117
"source": [
116-
"from langchain_community.embeddings.oracleai import OracleEmbeddings\n",
118+
"from langchain_oracledb.embeddings.oracleai import OracleEmbeddings\n",
117119
"\n",
118120
"# Update the directory and file names for your ONNX model\n",
119121
"# make sure that you have onnx file in the system\n",
@@ -223,7 +225,7 @@
223225
"metadata": {},
224226
"outputs": [],
225227
"source": [
226-
"from langchain_community.embeddings.oracleai import OracleEmbeddings\n",
228+
"from langchain_oracledb.embeddings.oracleai import OracleEmbeddings\n",
227229
"from langchain_core.documents import Document\n",
228230
"\n",
229231
"\"\"\"\n",
@@ -237,10 +239,10 @@
237239
"\n",
238240
"# using huggingface\n",
239241
"embedder_params = {\n",
240-
" \"provider\": \"huggingface\", \n",
241-
" \"credential_name\": \"HF_CRED\", \n",
242-
" \"url\": \"https://api-inference.huggingface.co/pipeline/feature-extraction/\", \n",
243-
" \"model\": \"sentence-transformers/all-MiniLM-L6-v2\", \n",
242+
" \"provider\": \"huggingface\",\n",
243+
" \"credential_name\": \"HF_CRED\",\n",
244+
" \"url\": \"https://api-inference.huggingface.co/pipeline/feature-extraction/\",\n",
245+
" \"model\": \"sentence-transformers/all-MiniLM-L6-v2\",\n",
244246
" \"wait_for_model\": \"true\"\n",
245247
"}\n",
246248
"\"\"\"\n",

‎docs/docs/integrations/tools/oracleai.ipynb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@
4242
"source": [
4343
"### Prerequisites\n",
4444
"\n",
45-
"Please install Oracle Python Client driver to use Langchain with Oracle AI Vector Search. "
45+
"You'll need to install `langchain-oracledb` with `python -m pip install -U langchain-oracledb` to use this integration.\n",
46+
"\n",
47+
"The `python-oracledb` driver is installed automatically as a dependency of langchain-oracledb."
4648
]
4749
},
4850
{
@@ -51,7 +53,7 @@
5153
"metadata": {},
5254
"outputs": [],
5355
"source": [
54-
"# pip install oracledb"
56+
"# python -m pip install -U langchain-oracledb"
5557
]
5658
},
5759
{
@@ -123,7 +125,7 @@
123125
"metadata": {},
124126
"outputs": [],
125127
"source": [
126-
"from langchain_community.utilities.oracleai import OracleSummary\n",
128+
"from langchain_oracledb.utilities.oracleai import OracleSummary\n",
127129
"from langchain_core.documents import Document\n",
128130
"\n",
129131
"\"\"\"\n",

0 commit comments

Comments
 (0)