Class CouchbaseDocumentLoader

loader for couchbase document

Hierarchy (View Summary)

BaseDynamicToolInput
- CouchbaseDocumentLoader

Implements

BaseDynamicToolInput

Index

Constructors

Methods

Constructors

constructor

new CouchbaseDocumentLoader(
    client: Cluster,
    query: string,
    pageContentFields?: string[],
    metadataFields?: string[],
): 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
Overrides BaseDocumentLoader.constructor
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/document_loaders/web/couchbase.ts:31

Methods

lazyLoad

lazyLoad(): AsyncIterable<Document>
Function to load documents based on iterator rather than full load

Returns AsyncIterable<Document>
[ Returns an iterator to fetch documents ]
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/document_loaders/web/couchbase.ts:63

load

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

Returns Promise<Document[]>
[ Returns a promise of all the documents as array ]
- Defined in remotes/langchain-ai/langchainjs/v1/libs/langchain-community/src/document_loaders/web/couchbase.ts:51