Skip to content

Commit

Permalink
docs: Update Google El Carro for Oracle Workload Documentation. (lang…
Browse files Browse the repository at this point in the history
…chain-ai#18394)

In this commit we update the documentation for Google El Carro for Oracle Workloads. We amend the documentation in the Google Providers page to use the correct name which is El Carro for Oracle Workloads. We also add changes to the document_loaders and memory pages to reflect changes we made in our repo.
  • Loading branch information
tabbyl21 authored and gkorland committed Mar 30, 2024
1 parent 437e440 commit 61f2c8f
Show file tree
Hide file tree
Showing 3 changed files with 491 additions and 403 deletions.
87 changes: 67 additions & 20 deletions docs/docs/integrations/document_loaders/google_el_carro.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
"cells": [
{
"cell_type": "markdown",
"metadata": {
"id": "NKbPFu-GWFDV"
},
"source": [
"# Google El Carro Oracle Operator\n",
">\n",
Expand All @@ -13,14 +10,18 @@
"community driven, no vendor lock-in container orchestration system. El Carro\n",
"provides a powerful declarative API for comprehensive and consistent\n",
"configuration and deployment as well as for real-time operations and\n",
"monitoring..\n",
"Extend your database application to build AI-powered experiences leveraging\n",
"Oracle Langchain integrations.\n",
"monitoring.\n",
"Extend your Oracle database's capabilities to build AI-powered experiences by\n",
"leveraging the El Carro Langchain integration.\n",
"\n",
"This guide goes over how to use El Carro Langchain integration to\n",
"[save, load and delete langchain documents](https://python.langchain.com/docs/modules/data_connection/document_loaders/)\n",
"with `ElCarroLoader` and `ElCarroDocumentSaver`."
]
"with `ElCarroLoader` and `ElCarroDocumentSaver`. This integration works for\n",
"any Oracle database, regardless of where it is running."
],
"metadata": {
"collapsed": false
}
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -68,15 +69,60 @@
"## Basic Usage\n",
"\n",
"### Set Up Oracle Database Connection\n",
"Fill out the following variable with your Oracle database connections details."
]
},
{
"cell_type": "code",
"execution_count": null,
"outputs": [],
"source": [
"# @title Set Your Values Here { display-mode: \"form\" }\n",
"HOST = \"127.0.0.1\" # @param {type: \"string\"}\n",
"PORT = 3307 # @param {type: \"integer\"}\n",
"DATABASE = \"my-database\" # @param {type: \"string\"}\n",
"TABLE_NAME = \"message_store\" # @param {type: \"string\"}\n",
"USER = \"my-user\" # @param {type: \"string\"}\n",
"PASSWORD = input(\"Please provide a password to be used for the database user: \")"
],
"metadata": {
"collapsed": false
}
},
{
"cell_type": "markdown",
"source": [
"\n",
"ElCarroEngine configures a connection pool to your Oracle database,\n",
"enabling successful connections from your application and following industry\n",
"best practices.\n",
"If you are using El Carro, you can find the hostname and port values in the\n",
"status of the El Carro Kubernetes instance.\n",
"Use the user password you created for your PDB.\n",
"Example"
],
"metadata": {
"collapsed": false
}
},
{
"cell_type": "markdown",
"source": [
"kubectl get -w instances.oracle.db.anthosapis.com -n db\n",
"NAME DB ENGINE VERSION EDITION ENDPOINT URL DB NAMES BACKUP ID READYSTATUS READYREASON DBREADYSTATUS DBREADYREASON\n",
"mydb Oracle 18c Express mydb-svc.db 34.71.69.25:6021 False CreateInProgress"
],
"metadata": {
"collapsed": false
}
},
{
"cell_type": "markdown",
"source": [
"### ElCarroEngine Connection Pool\n",
"\n",
"You can find the hostname and port values in the status of the El Carro\n",
"Kubernetes instance.\n",
"Use the user password you created for your PDB."
]
"`ElCarroEngine` configures a connection pool to your Oracle database, enabling successful connections from your application and following industry best practices."
],
"metadata": {
"collapsed": false
}
},
{
"cell_type": "code",
Expand Down Expand Up @@ -362,7 +408,8 @@
" elcarro_engine=elcarro_engine,\n",
" TABLE_NAME=TABLE_NAME,\n",
")\n",
"loader.load()"
"loaded_docs = loader.load()\n",
"print(f\"Loaded Documents: [{loaded_docs}]\")"
]
},
{
Expand Down Expand Up @@ -421,10 +468,10 @@
"specify the list of `metadata_columns` we want it to have. In this example, the\n",
"created table will have table columns:\n",
"\n",
"- description (type: text): for storing fruit description.\n",
"- fruit_name (type text): for storing fruit name.\n",
"- organic (type tinyint(1)): to tell if the fruit is organic.\n",
"- other_metadata (type: JSON): for storing other metadata information of the\n",
"- content (type: text): for storing fruit description.\n",
"- type (type text): for storing fruit type.\n",
"- weight (type INT): for storing fruit weight.\n",
"- extra_json_metadata (type: JSON): for storing other metadata information of the\n",
" fruit.\n",
"\n",
"We can use the following parameters\n",
Expand Down
Loading

0 comments on commit 61f2c8f

Please sign in to comment.