Class CouchbaseDocumentLoader

loader for couchbase document

Hierarchy

BaseDocumentLoader
- CouchbaseDocumentLoader

Implements

DocumentLoader

Index

Constructors

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 ]
- Optional pageContentFields: string[]
  
  { Array } [ filters fields of the document and shows these only ]
- Optional metadataFields: string[]
  
  { Array } [ metadata fields required ]
Returns CouchbaseDocumentLoader
Overrides BaseDocumentLoader.constructor
- Defined in langchain/src/document_loaders/web/couchbase.ts:27

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 ]
- Defined in langchain/src/document_loaders/web/couchbase.ts:59

load

load(): Promise<Document<Record<string, any>>[]>
Function to load document based on query from couchbase

Returns Promise<Document<Record<string, any>>[]>
[ Returns a promise of all the documents as array ]
Implementation of DocumentLoader.load

Overrides BaseDocumentLoader.load
- Defined in langchain/src/document_loaders/web/couchbase.ts:47

loadAndSplit

loadAndSplit(splitter?): Promise<Document<Record<string, any>>[]>
Loads the documents and splits them using a specified text splitter.
Parameters
- splitter: TextSplitter = ...
Returns Promise<Document<Record<string, any>>[]>
A Promise that resolves with an array of Document instances, each split according to the provided TextSplitter.
Implementation of DocumentLoader.loadAndSplit

Inherited from BaseDocumentLoader.loadAndSplit
- Defined in langchain/src/document_loaders/base.ts:32

Generated using TypeDoc