Interface MongoDBAtlasVectorSearchLibArgs

Deprecated

Install and import from the "@langchain/mongodb" integration package instead. Type that defines the arguments required to initialize the MongoDBAtlasVectorSearch class. It includes the MongoDB collection, index name, text key, embedding key, primary key, and overwrite flag.

Param: collection

MongoDB collection to store the vectors.

Param: indexName

A Collections Index Name.

Param: textKey

Corresponds to the plaintext of 'pageContent'.

Param: embeddingKey

Key to store the embedding under.

Param: primaryKey

The Key to use for upserting documents.

interface MongoDBAtlasVectorSearchLibArgs {
    collection: Collection<Document>;
    embeddingKey?: string;
    indexName?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    onFailedAttempt?: FailedAttemptHandler;
    primaryKey?: string;
    textKey?: string;
}

Hierarchy

  • AsyncCallerParams
    • MongoDBAtlasVectorSearchLibArgs

Properties

collection embeddingKey? indexName? maxConcurrency? maxRetries? onFailedAttempt? primaryKey? textKey?

Properties

Readonlycollection

collection: Collection<Document>

Optional ReadonlyembeddingKey

embeddingKey?: string

Optional ReadonlyindexName

indexName?: string

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

Optional ReadonlyprimaryKey

primaryKey?: string

Optional ReadonlytextKey

textKey?: string

Settings

Member Visibility

On This Page

Properties