From 71b8c762a2c2120b656ea726cc111f9ec8df20cd Mon Sep 17 00:00:00 2001 From: Tejas Shah Date: Tue, 21 Jan 2025 11:57:25 -0800 Subject: [PATCH] docs: Adds documentation for Opensearch vector store component (#5681) Adds documentation for Opensearch vector store component Co-authored-by: Mendon Kissling <59585235+mendonk@users.noreply.github.com> --- .../Components/components-vector-stores.md | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/docs/Components/components-vector-stores.md b/docs/docs/Components/components-vector-stores.md index 50ab99db0..d5e05d1e8 100644 --- a/docs/docs/Components/components-vector-stores.md +++ b/docs/docs/Components/components-vector-stores.md @@ -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