WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

VectorDatabaseObject
✖
VectorDatabaseObject

Updatedshow changeshide changes[Experimental]

✖

represents a vector database, as created by CreateVectorDatabase.

✖

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

✖

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)Summary of the most common use cases

Initialize a new vector database:

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-57z7wu
Out[3]=3

Access some database properties:

In[8]:=8
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-bt5l08
Out[8]=8

Initialize a new vector database with a list of vectors:

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-1bdn85
Out[1]=1

Perform a search operation:

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-3wm3u1
Out[2]=2

Scope  (6)Survey of the scope of standard use cases

Retrieval  (1)

Store a vector database in a file:

In[4]:=4
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-p3mjci
Out[4]=4

Recreate the database object from the file:

In[5]:=5
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-x3gxjp
Out[5]=5

Recreate the database object from the database name:

In[7]:=7
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-83x420
Out[7]=7

Properties  (2)

Extract a list of available properties:

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-vnck59
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-2rrt1k
Out[3]=3

Extract the stored vectors:

In[4]:=4
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-oljsqu
Out[4]=4

Extract multiple properties at once:

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-post64
In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-u9g3a3
Out[2]=2

Metadata  (3)

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

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-dh3o08
Out[2]=2

Extract vector database metadata:

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-rj7vqa
Out[3]=3

Extract vector database metadata and other properties:

In[4]:=4
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-12vcz1
Out[4]=4

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

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-dvtuyi

Extract vector database object metadata:

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-7l6fq9
Out[2]=2

Extract a specific metadata element:

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-ep1ntv
Out[3]=3

Extract multiple metadata elements:

In[4]:=4
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-qkitay
Out[4]=4

Extract metadata and other properties:

In[5]:=5
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-483r3t
Out[5]=5

Use the object to perform a search operation:

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-0dlduw
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-6v50np
Out[2]=2

Options  (2)Common values & functionality for each option

GeneratedAssetLocation  (1)

Create a vector database:

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-l1r3rm
Out[1]=1

Copy the database in a new location:

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-nhev6g
Out[2]=2

Delete the original database:

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-n3w1ry

OverwriteTarget  (1)

Create a new vector database:

In[29]:=29
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-eu5w9b
Out[29]=29

Create a file:

In[30]:=30
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-o0ldlw
Out[30]=30

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

In[31]:=31
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-zs4q2d
Out[31]=31

Use OverwriteTarget -> True to override the existing file:

In[32]:=32
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-8ajjaa
Out[32]=32

Properties & Relations  (4)Properties of the function, and connections to other functions

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

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-5b9d1m
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-7x7sgj
Out[2]=2

This is equivalent to:

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-l7ud38
Out[3]=3

Create a database with vectors and metadata:

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-dqyn9a
Out[1]=1

Both vectors and metadata are stored positionally:

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-5sdbqo
Out[2]=2

A SemanticSearchIndex is backed by a VectorDatabaseObject:

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-fwkjkm
Out[1]=1

Retrieve the underlying database:

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-qwq7sa
Out[2]=2

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

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-wdtonl
Out[3]=3

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

In[4]:=4
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-6tdn2w
In[5]:=5
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-1c845u
Out[5]=5

Create a file-backed vector database:

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-6sk58h
Out[1]=1

Database information is stored in the "WXF" format:

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-6rxdw4
Out[2]=2

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

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-6q8xy7
Out[3]=3

Possible Issues  (2)Common pitfalls and unexpected behavior

Create a database in a specified location:

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-qiywc
Out[3]=3

A naked string is interpreted as the database name:

In[4]:=4
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-uyaqag
Out[4]=4

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

In[5]:=5
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-us44nj
Out[5]=5

Create a path:

In[1]:=1
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-3jpryh
Out[1]=1

Create a database in the specified location:

In[2]:=2
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-jdp7zb
Out[2]=2

Move the underlying files:

In[3]:=3
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-osj28q

The original database is no longer usable:

In[4]:=4
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-yc29jc
Out[4]=4

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

In[5]:=5
✖
https://wolfram.com/xid/08vhgk6nqrs2s8y-k9yd6q
Out[5]=5
Wolfram Research (2024), VectorDatabaseObject, Wolfram Language function, https://reference.wolfram.com/language/ref/VectorDatabaseObject.html (updated 2025).
✖
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).

✖
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.

✖
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

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

BibTeX

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

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

BibLaTeX

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

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