langchain_google_vertexai.vectorstores.document_storage.GCSDocumentStorage

class langchain_google_vertexai.vectorstores.document_storage.GCSDocumentStorage(bucket: Bucket, prefix: Optional[str] = 'documents')[source]

Stores documents in Google Cloud Storage. For each pair id, document_text the name of the blob will be {prefix}/{id} stored in plain text format.

Constructor. :param bucket: Bucket where the documents will be stored. :param prefix: Prefix that is prepended to all document names.

Methods

__init__(bucket[, prefix])

Constructor.

amdelete(keys)

Delete the given keys and their associated values.

amget(keys)

Get the values associated with the given keys.

amset(key_value_pairs)

Set the values for the given keys.

ayield_keys(*[, prefix])

Get an iterator over keys that match the given prefix.

mdelete(keys)

Deletes a batch of documents by id.

mget(keys)

Gets a batch of documents by id.

mset(key_value_pairs)

Stores a series of documents using each keys

yield_keys(*[, prefix])

Yields the keys present in the storage.

Parameters
  • bucket (storage.Bucket) –

  • prefix (Optional[str]) –

__init__(bucket: Bucket, prefix: Optional[str] = 'documents') None[source]

Constructor. :param bucket: Bucket where the documents will be stored. :param prefix: Prefix that is prepended to all document names.

Parameters
  • bucket (Bucket) –

  • prefix (Optional[str]) –

Return type

None

async amdelete(keys: Sequence[K]) None

Delete the given keys and their associated values.

Parameters

keys (Sequence[K]) – A sequence of keys to delete.

Return type

None

async amget(keys: Sequence[K]) List[Optional[V]]

Get the values associated with the given keys.

Parameters

keys (Sequence[K]) – A sequence of keys.

Returns

A sequence of optional values associated with the keys. If a key is not found, the corresponding value will be None.

Return type

List[Optional[V]]

async amset(key_value_pairs: Sequence[Tuple[K, V]]) None

Set the values for the given keys.

Parameters

key_value_pairs (Sequence[Tuple[K, V]]) – A sequence of key-value pairs.

Return type

None

async ayield_keys(*, prefix: Optional[str] = None) Union[AsyncIterator[K], AsyncIterator[str]]

Get an iterator over keys that match the given prefix.

Parameters

prefix (str) – The prefix to match.

Returns

An iterator over keys that match the given prefix.

This method is allowed to return an iterator over either K or str depending on what makes more sense for the given store.

Return type

Iterator[K | str]

mdelete(keys: Sequence[str]) None[source]

Deletes a batch of documents by id.

Parameters

keys (Sequence[str]) – List of ids for the text.

Return type

None

mget(keys: Sequence[str]) List[Optional[Document]][source]

Gets a batch of documents by id. The default implementation only loops get_by_id. Subclasses that have faster ways to retrieve data by batch should implement this method. :param ids: List of ids for the text.

Returns

List of documents. If the key id is not found for any id record returns a

None instead.

Parameters

keys (Sequence[str]) –

Return type

List[Optional[Document]]

mset(key_value_pairs: Sequence[Tuple[str, Document]]) None[source]

Stores a series of documents using each keys

Parameters

key_value_pairs (Sequence[Tuple[K, V]]) – A sequence of key-value pairs.

Return type

None

yield_keys(*, prefix: Optional[str] = None) Iterator[str][source]

Yields the keys present in the storage.

Parameters

prefix (Optional[str]) – Ignored. Uses the prefix provided in the constructor.

Return type

Iterator[str]