jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: Adds documentation for Opensearch vector store component (#5681)

Browse source 
Adds documentation for Opensearch vector store component

Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com>
This commit is contained in:
Tejas Shah 2025-01-21 11:57:25 -08:00 • committed by GitHub
commit 71b8c762a2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 29 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

29
docs/docs/Components/components-vector-stores.md
View file

@ -340,6 +340,35 @@ For more information, see the [MongoDB Atlas documentation](https://www.mongodb.
| vector_store | MongoDBAtlasVectorSearch| MongoDB Atlas vector store instance |
| search_results| List[Data] | Results of similarity search |
## Opensearch
This component creates an Opensearch vector store with search capabilities
For more information, see [Opensearch documentation](https://opensearch.org/platform/search/vector-database.html)
### Inputs
| Name | Type | Description |
|------------------------|--------------|------------------------------------------------------------------------------------------------------------------------|
| opensearch_url | String | URL for OpenSearch cluster (e.g. https://192.168.1.1:9200) |
| index_name | String | The index name where the vectors will be stored in OpenSearch cluster |
| search_input | String | Enter a search query. Leave empty to retrieve all documents or if hybrid search is being used |
| ingest_data | Data | Data to be ingested into the vector store |
| embedding | Embeddings | Embedding function to use |
| search_type | String | Valid values are "similarity", "similarity_score_threshold", "mmr" |
| number_of_results | Integer | Number of results to return in search |
| search_score_threshold | Float | Minimum similarity score threshold for search results |
| username | String | username for the opensource cluster |
| password | SecretString | password for the opensource cluster |
| use_ssl | Boolean | Use SSL |
| verify_certs | Boolean | Verify certificates |
| hybrid_search_query | String | Provide a custom hybrid search query in JSON format. This allows you to combine vector similarity and keyword matching |
### Outputs
| Name | Type | Description |
| ------------- |------------------------|---------------------------------------------|
| vector_store | OpenSearchVectorSearch | OpenSearch vector store instance |
| search_results| List[Data] | Results of similarity search |
## PGVector