Interface OpenSearchClientArgs

Interface defining the arguments required to create an instance of the OpenSearchVectorStore class. It includes the OpenSearch client, index name, and vector search options.

interface OpenSearchClientArgs {
    client: Client;
    indexName?: string;
    metadataFieldName?: string;
    service?: "es" | "aoss";
    textFieldName?: string;
    vectorFieldName?: string;
    vectorSearchOptions?: VectorSearchOptions;
}

Properties

client indexName? metadataFieldName? service? textFieldName? vectorFieldName? vectorSearchOptions?

Properties

Readonlyclient

client: Client

Optional ReadonlyindexName

indexName?: string

Optional ReadonlymetadataFieldName

metadataFieldName?: string

Optional Readonlyservice

service?: "es" | "aoss"

Optional ReadonlytextFieldName

textFieldName?: string

Optional ReadonlyvectorFieldName

vectorFieldName?: string

Optional ReadonlyvectorSearchOptions

vectorSearchOptions?: VectorSearchOptions

Settings

Member Visibility

On This Page

Properties