1
1
# VectorLink: The TerminusDB Semantic Indexer
2
2
3
3
VectorLink is a vector database with an index based on Hierarchical
4
- Navigable Small World graphs written in rust . It is designed to work
4
+ Navigable Small World graphs written in Rust . It is designed to work
5
5
closely with TerminusDB but can be used with any project via a simple
6
- HTTP api . In order to work well with TerminusDB it is designed with
6
+ HTTP API . In order to work well with TerminusDB it is designed with
7
7
the following features:
8
8
9
- * Domains: The database can manage several domains. In a domain you
10
- have a vector store which is append only. This allows you to share
9
+ * Domains: The database can manage several domains. In a domain, you
10
+ have a vector store which is append- only. This allows you to share
11
11
vectors across indexes.
12
12
* Commits: Each index exists at a commit. The index can point to any
13
13
vector in a domain. This allows us to add and remove vectors by
@@ -21,7 +21,7 @@ To invoke the server, you can run it as follows:
21
21
22
22
## Compiling
23
23
24
- You can comile the system with cargo:
24
+ You can compile the system with cargo:
25
25
26
26
``` shell
27
27
cargo compile --release
@@ -49,7 +49,7 @@ If you wan to index documents, you can any of these methods:
49
49
` TERMINUSDB_CONTENT_ENDPOINT/{domain}?commit_id={commit} `
50
50
* use the ` load ` command with a file
51
51
52
- In any of these cases, the indexer expects a content stream which will
52
+ In any of these cases, the indexer expects a content stream that will
53
53
have the form (in JSONlines format):
54
54
55
55
``` json
@@ -86,19 +86,19 @@ indexing (specified by the `id` field).
86
86
87
87
## Todo
88
88
89
- Lots of work to make this the open source versioned vector database
89
+ Lots of work to make this the open- source versioned vector database
90
90
that the world deserves. Anyone who wants to work on the project to
91
91
advance these aims is welcome:
92
92
93
93
* Add other AI configurations for obtaining the embeddings - we'd like
94
94
to be very complete and have ways of configuring other vendors and
95
- open source text-to-embedding systems.
95
+ open- source text-to-embedding systems.
96
96
* Greater scope of metric support
97
97
* Improve compression: We'd like to have a sytem of vector compression
98
98
such as PQ for dealing with very large datasets.
99
99
* Better treatment of deletion and replace
100
100
* Better incrementality of the index structure
101
- * Smaller graph reprsentations of the indicies - using succinct data
101
+ * Smaller graph representations of the indices - using succinct data
102
102
structures to reduce memory overhead.
103
103
104
104
And if you have new ideas we'd love to hear them!
0 commit comments