github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-05-31 20:19:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

templates[patch]: opensearch readme update (#14103)

Browse Source
This commit is contained in:
Erick Friis 2023-12-01 08:48:00 -08:00 committed by GitHub
parent ac1c8634a8
commit a3ae8e0a41
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
templates/rag-opensearch/README.md
View File

@ -7,12 +7,20 @@ This Template performs RAG using [OpenSearch](https://python.langchain.com/docs/
Set the following environment variables.
- `OPENAI_API_KEY` - To access OpenAI Embeddings and Models.
And optionally set the OpenSearch ones if not using defaults:
- `OPENSEARCH_URL` - URL of the hosted OpenSearch Instance
- `OPENSEARCH_USERNAME` - User name for the OpenSearch instance
- `OPENSEARCH_PASSWORD` - Password for the OpenSearch instance
- `OPENSEARCH_INDEX_NAME` - Name of the index
Note: To load dummy index named `langchain-test` with dummy documents, use `dummy_index_setup.py` script in the folder
To run the default OpenSeach instance in docker, you can use the command
```shell
docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" --name opensearch-node -d opensearchproject/opensearch:latest
```
Note: To load dummy index named `langchain-test` with dummy documents, run `python dummy_index_setup.py` in the package
## Usage