Skip to content

Commit 17c7bfa

Browse files
committed
update typos
1 parent 086cdbd commit 17c7bfa

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

docs/source/user_guide/large_language_model/retrieval.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _vector_store:
22

33
#################################################
4-
integration with OCI Generative AI and OpenSearch
4+
Integration with OCI Generative AI and OpenSearch
55
#################################################
66

77
.. versionadded:: 2.9.1
@@ -91,12 +91,15 @@ Since the search result usually cannot be directly used to answer a specific que
9191
)
9292
qa.run("your question")
9393
94+
Retrieval QA with FAISS
95+
=======================
96+
9497
FAISS as Vector DB
95-
==================
98+
------------------
9699

97100
A lot of the time, your documents are not that large and you dont have a OCI OpenSearch cluster set up. In that case, you can use ``FAISS`` as your in-memory vector store, which can also do similarty search very efficiently.
98101

99-
The following code snippet shows how to use ``FAISS`` as your vector store:
102+
The following code snippet shows how to use ``FAISS`` along with OCI Embedding Model to do semantic search:
100103

101104
.. code-block:: python3
102105
@@ -120,7 +123,7 @@ The following code snippet shows how to use ``FAISS`` as your vector store:
120123
db = FAISS.from_embeddings(text_embedding_pairs, oci_embedings)
121124
db.similarity_search("your query", k=2, size=2)
122125
123-
Retrieval QA Using FAISS Vector Store as a retriever
126+
Retrieval QA Using FAISS Vector Store as a Retriever
124127
----------------------------------------------------
125128

126129
Similarly, you can use FAISS Vector Store as a retriever to build a retrieval QA engine using langchain. The following code snippet shows how to use OCI OpenSearch as a retriever:
@@ -158,7 +161,7 @@ As of version 0.0.346, Langchain does not support serialization of any vector st
158161
OpenSearchVectorSearch Serialization
159162
------------------------------------
160163

161-
langchain does not automatically support serialization of ``OpenSearchVectorSearch``. However, ADS provides a way to serialize ``OpenSearchVectorSearch``. To serialize ``OpenSearchVectorSearch``, you need to use environment variables to pass in the credentials. The following variables can be passed in through the corresponding environment variables:
164+
langchain does not automatically support serialization of ``OpenSearchVectorSearch``. However, ADS provides a way to serialize ``OpenSearchVectorSearch``. To serialize ``OpenSearchVectorSearch``, you need to use environment variables to store the credentials. The following variables can be passed in through the corresponding environment variables:
162165

163166
- http_auth: (``OCI_OPENSEARCH_USERNAME``, ``OCI_OPENSEARCH_PASSWORD``)
164167
- verify_certs: ``OCI_OPENSEARCH_VERIFY_CERTS``
@@ -196,10 +199,10 @@ During deployment, it is very important that you remember to pass in those envir
196199
"OCI_OPENSEARCH_PASSWORD": "<oci_opensearch_password>",
197200
"OCI_OPENSEARCH_VERIFY_CERTS": "<oci_opensearch_verify_certs>",)
198201
199-
OpenSearchVectorSearch Deployment
200-
---------------------------------
202+
Deployment of Retrieval QA with OpenSearch
203+
------------------------------------------
201204

202-
Here is an example code snippet for OpenSearchVectorSearch deployment:
205+
Here is an example code snippet for deployment of Retrieval QA using OpenSearch as a retriever:
203206

204207
.. code-block:: python3
205208
@@ -268,12 +271,10 @@ Here is an example code snippet for OpenSearchVectorSearch deployment:
268271
model.predict("your prompt")
269272
270273
274+
Deployment of Retrieval QA with FAISS
275+
-------------------------------------
271276

272-
273-
FAISS Deployment
274-
----------------
275-
276-
Here is an example code snippet for FAISS deployment:
277+
Here is an example code snippet for deployment of Retrieval QA using FAISS as a retriever:
277278

278279
.. code-block:: python3
279280

0 commit comments

Comments
 (0)