OpenSearch

Estimated reading: 2 minutes 150 views

The OpenSearch component reads and writes to OpenSearch instances using OpenSearchVectorSearch.

For more information, see the following:

1. Hidden parameters
2. Search results output
3. Vector store instances
4. OpenSearch documentation

OpenSearch parameters

Name Type Description
opensearch_url String Input parameter. URL for OpenSearch cluster, such as https://192.168.1.1:9200.
index_name String Input parameter. The index name where the vectors are stored in OpenSearch cluster.
search_input String Input parameter. Enter a search query. Leave empty to retrieve all documents or if hybrid search is being used.
ingest_data Data Input parameter. The data to be ingested into the vector store.
embedding Embeddings Input parameter. The embedding function to use.
search_type String Input parameter. The options are "similarity", "similarity_score_threshold", "mmr".
number_of_results Integer Input parameter. The number of results to return in search.
search_score_threshold Float Input parameter. The minimum similarity score threshold for search results.
username String Input parameter. The username for the OpenSearch cluster.
password SecretString Input parameter. The password for the OpenSearch cluster.
use_ssl Boolean Input parameter. Use SSL.
verify_certs Boolean Input parameter. Verify certificates.
hybrid_search_query String Input parameter. Provide a custom hybrid search query in JSON format. This allows you to combine vector similarity and keyword matching.
Share this Doc

OpenSearch

Or copy link

CONTENTS