langchain_google_vertexai.vectorstores.document_storage.DataStoreDocumentStorage

class langchain_google_vertexai.vectorstores.document_storage.DataStoreDocumentStorage(datastore_client: datastore.Client, kind: str = 'document_id', text_property_name: str = 'text', metadata_property_name: str = 'metadata')[source]

Stores documents in Google Cloud DataStore.

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

Methods

__init__(datastore_client[, kind, ...])

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 sequence of documents by key.

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 of all documents in the storage.

Parameters
  • datastore_client (datastore.Client) –

  • kind (str) –

  • text_property_name (str) –

  • metadata_property_name (str) –

__init__(datastore_client: datastore.Client, kind: str = 'document_id', text_property_name: str = 'text', metadata_property_name: str = 'metadata') None[source]

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

Parameters
  • datastore_client (datastore.Client) –

  • kind (str) –

  • text_property_name (str) –

  • metadata_property_name (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 sequence of documents by key.

Parameters

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

Return type

None

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

Gets a batch of documents by id. :param ids: List of ids for the text.

Returns

List of texts. 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 of all documents in the storage.

Parameters

prefix (Optional[str]) – Ignored

Return type

Iterator[str]