Documentation issues #134
Description
Describe the bug
I'm referring to the documentation at the following URL: https://epsilla-inc.gitbook.io/epsilladb/vector-database
- Missing documentation on querying existing databases
- Missing documentation on querying existing tables
- Missing documentation on querying fields of existing tables
- Missing documentation on filtering syntax
- Missing documentation on indexing (see additional context).
Additional context
There is some rudimentary documentation on indexing, but some key points are missing and some are unclear:
a) No information on how to create the table with an index on the embedding field with VECTOR_FLOAT dataType, which is not created by "model", but provided as part of the data during insert.
My use case: inserting billions of language sentences (STRINGs), with their embeddings, and query them with embedding vector later on to retrieve a sentence.
b) It is not clear if the "Embedding" name of the field in the table is a keyword or if the embedding vector column can have an arbitrary name.
c) It is also unclear if externally built embedding is inserted along with the data into the table, will it be indexed automatically (by its name "Embedding" or by its type "VECTOR_FLOAT").
d) Is it possible to index any other dataType then STRING? From the documentation:
When creating tables, you can define indices to let Epsilla automatically create embeddings for the STRING fields
And then later on:
Then you can insert records in their raw format and let Epsilla handle the embedding followed by an example with insert of the text data and their embeddings, though the "Embedding" column is not defined in the table (in the previous code snippet) and despite the fact that Epsilla is promised to create the embeddings automatically.