langchain.js
    Preparing search index...

    Interface CouchbaseSearchVectorStoreArgs

    This interface defines the fields required to initialize a vector store These are the fields part of config:

    interface CouchbaseSearchVectorStoreArgs {
        addVectorOptions?: AddVectorOptions;
        bucketName: string;
        cluster: Cluster;
        collectionName: string;
        embeddingKey?: string;
        indexName: string;
        scopedIndex?: boolean;
        scopeName: string;
        textKey?: string;
    }
    Index

    Properties

    addVectorOptions? bucketName cluster collectionName embeddingKey? indexName scopedIndex? scopeName textKey?

    Properties

    addVectorOptions?: AddVectorOptions

    Options for adding vectors with specific id/metadata

    bucketName: string

    The name of the bucket in the Couchbase cluster.

    cluster: Cluster

    The Couchbase cluster that the store will interact with.

    collectionName: string

    The name of the collection within the scope.

    embeddingKey?: string

    The key to be used for embeddings in the documents. Defaults to "embedding".

    indexName: string

    The name of the index to be used for vector search.

    scopedIndex?: boolean

    Whether to use a scoped index for vector search. Defaults to true.

    scopeName: string

    The name of the scope within the bucket.

    textKey?: string

    The key to be used for text in the documents. Defaults to "text".

    Settings

    Member Visibility

    On This Page

    Properties