Class CouchbaseDocumentLoader

Deprecated

  • Import from "@langchain/community/document_loaders/web/couchbase" instead. This entrypoint will be removed in 0.3.0.

loader for couchbase document

Hierarchy (view full)

Implements

Constructors

constructor

Methods

lazyLoad load loadAndSplit

Constructors

constructor

  • new CouchbaseDocumentLoader(client, query, pageContentFields?, metadataFields?): CouchbaseDocumentLoader

  • construct Couchbase document loader with a requirement for couchbase cluster client

    Parameters

    • client: Cluster

      { Cluster } [ couchbase connected client to connect to database ]

    • query: string

      { string } [ query to get results from while loading the data ]

    • OptionalpageContentFields: string[]

      { Array } [ filters fields of the document and shows these only ]

    • OptionalmetadataFields: string[]

      { Array } [ metadata fields required ]

    Returns CouchbaseDocumentLoader

Methods

lazyLoad

  • lazyLoad(): AsyncIterable<Document<Record<string, any>>>

  • Function to load documents based on iterator rather than full load

    Returns AsyncIterable<Document<Record<string, any>>>

    [ Returns an iterator to fetch documents ]

load

loadAndSplit

  • loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>

  • Parameters

    • Optionalsplitter: BaseDocumentTransformer<DocumentInterface<Record<string, any>>[], DocumentInterface<Record<string, any>>[]>

    Returns Promise<Document<Record<string, any>>[]>

    A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.

    Deprecated

    Use this.load() and splitter.splitDocuments() individually. Loads the documents and splits them using a specified text splitter.

Settings

Member Visibility

On This Page

Constructors
Methods