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>
Helper function to load each document

Returns AsyncIterable<Document>
- Defined in langchain/src/document_loaders/web/couchbase.ts:57

load

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

Returns Promise<Document[]>
Implementation of DocumentLoader.load

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

loadAndSplit

loadAndSplit(splitter?): Promise<Document[]>
Loads the documents and splits them using a specified text splitter.
Parameters
- splitter: TextSplitter = ...
Returns Promise<Document[]>
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