Skip to content

Commit

Permalink
docs: Improved notebook for vector store "HANA Cloud" (langchain-ai#1…
Browse files Browse the repository at this point in the history
…8496)

- **Description:**
This PR fixes some issues in the Jupyter notebook for the VectorStore
"SAP HANA Cloud Vector Engine":
    * Slight textual adaptations
    * Fix of wrong column name VEC_META (was: VEC_METADATA)

  - **Issue:** N/A
  - **Dependencies:** no new dependecies added
  - **Twitter handle:** @sapopensource

path to notebook:
`docs/docs/integrations/vectorstores/hanavector.ipynb`
  • Loading branch information
MartinKolbAtWork authored and gkorland committed Mar 30, 2024
1 parent 1a958a7 commit 67fbdfe
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/docs/integrations/vectorstores/sap_hanavector.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"To use `OpenAIEmbeddings` we use the OpenAI API Key."
"For `OpenAIEmbeddings` we use the OpenAI API key from the environment."
]
},
{
Expand All @@ -57,7 +57,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Create a database connection to a HANA Cloud instance"
"Create a database connection to a HANA Cloud instance."
]
},
{
Expand Down Expand Up @@ -170,7 +170,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Perform a query to get the two best-matching document chunks from the ones that we added in the previous step.\n",
"Perform a query to get the two best-matching document chunks from the ones that were added in the previous step.\n",
"By default \"Cosine Similarity\" is used for the search."
]
},
Expand Down Expand Up @@ -527,10 +527,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"As default behaviour, the table for the embeddings is created with 3 columns\n",
"* A column `VEC_TEXT`, which contains the text of the Document\n",
"* A column `VEC_METADATA`, which contains the metadata of the Document\n",
"* A column `VEC_VECTOR`, which contains the embeddings-vector of the document's text"
"As default behaviour, the table for the embeddings is created with 3 columns:\n",
"\n",
"- A column `VEC_TEXT`, which contains the text of the Document\n",
"- A column `VEC_META`, which contains the metadata of the Document\n",
"- A column `VEC_VECTOR`, which contains the embeddings-vector of the Document's text"
]
},
{
Expand Down Expand Up @@ -609,9 +610,10 @@
"metadata": {},
"source": [
"Custom tables must have at least three columns that match the semantics of a standard table\n",
"* A column with type `NCLOB` or `NVARCHAR` for the text/context of the embeddings\n",
"* A column with type `NCLOB` or `NVARCHAR` for the metadata \n",
"* A column with type REAL_VECTOR for the embedding vector\n",
"\n",
"- A column with type `NCLOB` or `NVARCHAR` for the text/context of the embeddings\n",
"- A column with type `NCLOB` or `NVARCHAR` for the metadata \n",
"- A column with type `REAL_VECTOR` for the embedding vector\n",
"\n",
"The table can contain additional columns. When new Documents are inserted into the table, these additional columns must allow NULL values."
]
Expand Down

0 comments on commit 67fbdfe

Please sign in to comment.