Class GoogleCloudStorageDocstore

Class that provides an interface for interacting with Google Cloud Storage (GCS) as a document store. It extends the Docstore class and implements methods to search, add, and add a document to the GCS bucket.

Hierarchy

  • Docstore
    • GoogleCloudStorageDocstore

Constructors

constructor

Properties

bucket prefix storage

Methods

add addDocument search

Constructors

constructor

Properties

bucket

bucket: string

prefix

prefix: string = ""

storage

storage: Storage

Methods

add

  • add(texts): Promise<void>

  • Adds multiple documents to the GCS bucket.

    Parameters

    • texts: Record<string, Document<Record<string, any>>>

      An object where each key is the name of a document and the value is the Document instance to be added

    Returns Promise<void>

    A Promise that resolves when all documents have been added

addDocument

  • addDocument(name, document): Promise<void>

  • Adds a single document to the GCS bucket.

    Parameters

    • name: string

      The name of the document to be added

    • document: Document<Record<string, any>>

      The Document instance to be added

    Returns Promise<void>

    A Promise that resolves when the document has been added

search

  • search(search): Promise<Document<Record<string, any>>>

  • Searches for a document in the GCS bucket and returns it as a Document instance.

    Parameters

    • search: string

      The name of the document to search for in the GCS bucket

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

    A Promise that resolves to a Document instance representing the found document

Settings

Member Visibility

On This Page

Constructors
Properties
Methods