WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

CreateVectorDatabase
✖
CreateVectorDatabase

New in 14.1[Experimental]

✖

creates a new empty vector database.

✖
CreateVectorDatabase[{vec1,…}]

initializes the database with the collection of vectors veci.

✖
CreateVectorDatabase[{vec1,…}{val1,…}]

associates the value vali to the vector veci.

✖

gives the vector database the specified name.

Details and Options

Examples

open allclose all

Basic Examples  (2)Summary of the most common use cases

Create an empty VectorDatabaseObject:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-4h10mh
Out[2]=2

Create a database with a specific name and initialize it with a list of vectors:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-57z7wu
Out[1]=1

Search the database by similarity:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-y98n6a
Out[2]=2

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

Data Sources  (3)

Create an empty vector database:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-u7pwl1
Out[1]=1

Create a database with a specific name:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-js5cqr
Out[1]=1

Initialize a new vector database with a list of vectors:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-g2uvjh
Out[1]=1

Metadata  (2)

Initialize the database with both vectors and metadata:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-9rm8gd
Out[1]=1

Specify the metadata as a separate list:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-uqpcyy
Out[2]=2

Specify the metadata with tags as an Association:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-zz51od
Out[1]=1

Specify data and metadata separately:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-gfw643
Out[2]=2

Options  (10)Common values & functionality for each option

DistanceFunction  (1)

Specify a custom distance function for the database:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-iwbp6n
Out[1]=1

By default, EuclideanDistance is used:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-gc2leo
Out[1]=1

FeatureExtractor  (1)

Only vectors can be stored in the database; specify a FeatureExtractor that can extract image features:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-el8sik
Out[1]=1

Search for the closest image to a given one:

In[4]:=4
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-9n2qrl
Out[4]=4

GeneratedAssetLocation  (3)

Specify a custom location to store the database:

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

Retrieve the location:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-y7pgm0
Out[2]=2

By default, the database is stored in a local object:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-zwx4c9
Out[1]=1

Store the vector database in a file:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-qki0up
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-jdp7zb
Out[2]=2

Retrieve the location:

In[3]:=3
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-k9yd6q
Out[3]=3

Recreate the database from the file reference:

In[4]:=4
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-nt2k9v
Out[4]=4

OverwriteTarget  (2)

The database's automatic location is determined by its name:

In[8]:=8
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-hakd8q
Out[8]=8

With default OverwriteTargetAutomatic, a new database name is generated to avoid collisions:

In[9]:=9
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-1zmjtm
Out[9]=9

To force overwriting, use OverwriteTargetTrue:

In[10]:=10
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-xq3cz9
Out[10]=10

Use OverwriteTargetFalse to perform a strict check:

In[11]:=11
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-h0x4j0
Out[11]=11

OverwriteTargetFalse will also prevent reusing the same database name in a different location:

In[12]:=12
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-hr7372
Out[12]=12

Create a file:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-kwd9r5
Out[1]=1

By default, existing files are not overwritten:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-g9gcg5
Out[2]=2

Use OverwriteTargetTrue to overwrite the existing file:

In[3]:=3
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-77ufhe
Out[3]=3

WorkingPrecision  (3)

Specify a custom working precision for the distance computation:

In[5]:=5
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-0lrwh7
Out[5]=5

By default, the precision is inferred from the input data:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-cw4iup
Out[1]=1

Specify a precision for an empty database:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-6foce

Newly added vectors are clipped and/or rounded to fit into the given precision:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-f4r5i0
Out[2]=2

An empty database is created without an explicit working precision:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-nmjf3s
Out[1]=1

The value is resolved when data is added to the database:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-l9bcnn
Out[2]=2

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

A list of scalars is interpreted as a list of one-dimensional vectors:

In[3]:=3
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-nquaw9
Out[3]=3

Use an outer list to indicate that the input is a single vector:

In[4]:=4
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-lq22dp
Out[4]=4

Possible Issues  (4)Common pitfalls and unexpected behavior

Only one-dimensional arrays can be stored in the database:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-u38tg4
Out[1]=1

All arrays in the database should have the same size:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-u48omw
Out[1]=1

The database name is unique:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-cs503c
Out[1]=1

A new database with the same name specification will be created with an incrementing suffix:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-sx9pcw
Out[2]=2

Use DeleteObject to remove an incorrectly generated VectorDatabaseObject:

In[3]:=3
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-efa0ka

Now the name is available again:

In[4]:=4
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-dxjj4r
Out[4]=4

Alternatively, use the option OverwriteTargetTrue to overwrite the old database:

In[5]:=5
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-kb1hbk
Out[5]=5

OverwriteTarget -> False will issue an error rather than adding an incrementing number:

In[6]:=6
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-3xv24k
Out[6]=6

Create a database at a specific location:

In[1]:=1
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-45kb60
Out[1]=1

A database with the same name in a new location will be created with an incrementing suffix:

In[2]:=2
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-u1o3hf
Out[2]=2

Delete the original database to free the name:

In[3]:=3
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-gl824r

Now the name is available again:

In[4]:=4
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-42od0l
Out[4]=4
In[5]:=5
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-p2bf1r
Out[5]=5
In[6]:=6
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-d0mrc0
Out[6]=6
In[7]:=7
✖
https://wolfram.com/xid/0pnajhbwasn3fjtq-lcdzeu
Out[7]=7
Wolfram Research (2024), CreateVectorDatabase, Wolfram Language function, https://reference.wolfram.com/language/ref/CreateVectorDatabase.html.
✖
Wolfram Research (2024), CreateVectorDatabase, Wolfram Language function, https://reference.wolfram.com/language/ref/CreateVectorDatabase.html.

Text

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

✖
Wolfram Research (2024), CreateVectorDatabase, Wolfram Language function, https://reference.wolfram.com/language/ref/CreateVectorDatabase.html.

CMS

Wolfram Language. 2024. "CreateVectorDatabase." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/CreateVectorDatabase.html.

✖
Wolfram Language. 2024. "CreateVectorDatabase." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/CreateVectorDatabase.html.

APA

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

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

BibTeX

@misc{reference.wolfram_2025_createvectordatabase, author="Wolfram Research", title="{CreateVectorDatabase}", year="2024", howpublished="\url{https://reference.wolfram.com/language/ref/CreateVectorDatabase.html}", note=[Accessed: 29-March-2025 ]}

✖
@misc{reference.wolfram_2025_createvectordatabase, author="Wolfram Research", title="{CreateVectorDatabase}", year="2024", howpublished="\url{https://reference.wolfram.com/language/ref/CreateVectorDatabase.html}", note=[Accessed: 29-March-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_createvectordatabase, organization={Wolfram Research}, title={CreateVectorDatabase}, year={2024}, url={https://reference.wolfram.com/language/ref/CreateVectorDatabase.html}, note=[Accessed: 29-March-2025 ]}

✖
@online{reference.wolfram_2025_createvectordatabase, organization={Wolfram Research}, title={CreateVectorDatabase}, year={2024}, url={https://reference.wolfram.com/language/ref/CreateVectorDatabase.html}, note=[Accessed: 29-March-2025 ]}