VectorDatabaseObject

VectorDatabaseObject[…]

represents a vector database, as created by CreateVectorDatabase.

VectorDatabaseObject["name"]

represents the database with the specified name in the VectorDatabaseObjects[] list.

VectorDatabaseObject[source]

attempts to recreate a VectorDatabaseObject from source.

Details and Options

  • VectorDatabaseObject represents a vector database instance, allowing interaction with and management of the stored vectors.
  • Returned by CreateVectorDatabase, this symbolic object enables common database management operations such as adding data, searching and listing content and properties.
  • Possible values of source include:
  • "name"a named database from VectorDatabaseObjects[]
    File[…]a local file
    LocalObject[…]a local object
    CloudObject[…]a cloud object
  • Database properties can be accessed via VectorDatabaseObject[…][prop].
  • The following properties prop are supported:
  • "Dimensions"number of arrays stored and array size
    "DistanceFunction"distance function used
    "ID"database ID
    "Location"where the database is stored
    "Metadata"metadata associated with each vector
    "Vectors"vectors stored in the database
    "WorkingPrecision"numerical precision for storage and computation
    {prop1,…}a list of properties
  • When recreating a database, the following options can be specified:
  • GeneratedAssetLocation $GeneratedAssetLocationwhere to save the database
    OverwriteTarget Automaticwhether to overwrite an existing location

Examples

open allclose all

Basic Examples  (2)

Initialize a new vector database:

Access some database properties:

Initialize a new vector database with a list of vectors:

Perform a search operation:

Scope  (6)

Retrieval  (1)

Store a vector database in a file:

Recreate the database object from the file:

Recreate the database object from the database name:

Properties  (2)

Extract a list of available properties:

Extract the stored vectors:

Extract multiple properties at once:

Metadata  (3)

Create a vector database where each vector is associated with metadata:

Extract vector database metadata:

Extract vector database metadata and other properties:

Create a vector database where each vector is associated with metadata associations:

Extract vector database object metadata:

Extract a specific metadata element:

Extract multiple metadata elements:

Extract metadata and other properties:

Use the object to perform a search operation:

Options  (2)

GeneratedAssetLocation  (1)

Create a vector database:

Copy the database in a new location:

Delete the original database:

OverwriteTarget  (1)

Create a new vector database:

Create a file:

By default, copying the database to an existing file will fail:

Use OverwriteTarget -> True to override the existing file:

Properties & Relations  (4)

In many situations, an existing vector database can be referred to by name only:

This is equivalent to:

Create a database with vectors and metadata:

Both vectors and metadata are stored positionally:

A SemanticSearchIndex is backed by a VectorDatabaseObject:

Retrieve the underlying database:

Detailed information on the database can be extracted using vector database properties:

Modifying or deleting the underlying database may cause issues with the index:

Create a file-backed vector database:

Database information is stored in the "WXF" format:

More files could be generated for efficiently storing the vector information:

Possible Issues  (2)

Create a database in a specified location:

A naked string is interpreted as the database name:

Use the File wrapper to specify the source is a file path:

Create a path:

Create a database in the specified location:

Move the underlying files:

The original database is no longer usable:

Use VectorDatabaseObject on the moved file with OverwriteTarget True to recreate the database and update the location data:

Wolfram Research (2024), VectorDatabaseObject, Wolfram Language function, https://reference.wolfram.com/language/ref/VectorDatabaseObject.html (updated 2025).

Text

Wolfram Research (2024), VectorDatabaseObject, Wolfram Language function, https://reference.wolfram.com/language/ref/VectorDatabaseObject.html (updated 2025).

CMS

Wolfram Language. 2024. "VectorDatabaseObject." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2025. https://reference.wolfram.com/language/ref/VectorDatabaseObject.html.

APA

Wolfram Language. (2024). VectorDatabaseObject. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/VectorDatabaseObject.html

BibTeX

@misc{reference.wolfram_2024_vectordatabaseobject, author="Wolfram Research", title="{VectorDatabaseObject}", year="2025", howpublished="\url{https://reference.wolfram.com/language/ref/VectorDatabaseObject.html}", note=[Accessed: 20-January-2025 ]}

BibLaTeX

@online{reference.wolfram_2024_vectordatabaseobject, organization={Wolfram Research}, title={VectorDatabaseObject}, year={2025}, url={https://reference.wolfram.com/language/ref/VectorDatabaseObject.html}, note=[Accessed: 20-January-2025 ]}