Skip to content

Commit a85313d

Browse files
Update README
1 parent 0afaf46 commit a85313d

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Vemdex: TerminusDB Semantic Indexer
1+
# TerminusDB Semantic Indexer
22

33
The TerminusDB Semantic Indexer is a vector database with an index
44
based on Hierarchical Navigable Small World graphs written in rust. It
@@ -45,11 +45,11 @@ If you wan to index documents, you can any of these methods:
4545

4646
* Run a TerminusDB installation and refer to real commits and databases
4747
* Put up an endpoint that will issue the appropriate operations for a
48-
commit id and a domain
49-
* use the `load` command
48+
commit id and a domain with the endpoint `ENDPOINT/domain?commit_id=COMMIT`
49+
* use the `load` command with a file
5050

51-
In any case, the database expects a content which will have the form
52-
(in JSONlines format):
51+
In any of these cases, the indexer expects a content stream which will
52+
have the form (in JSONlines format):
5353

5454
```json
5555
{"id":"terminusdb:///star-wars/People/20", "op":"Inserted", "string":"The person's name is Yoda. They are described with the following synopsis: Yoda is a fictional character in the Star Wars franchise created by George Lucas, first appearing in the 1980 film The Empire Strikes Back. In the original films, he trains Luke Skywalker to fight against the Galactic Empire. In the prequel films, he serves as the Grand Master of the Jedi Order and as a high-ranking general of Clone Troopers in the Clone Wars. Following his death in Return of the Jedi at the age of 900, Yoda was the oldest living character in the Star Wars franchise in canon, until the introduction of Maz Kanata in Star Wars: The Force Awakens. Their gender is male. They have the following hair colours: white. They have a mass of 17. Their skin colours are green."}
@@ -101,5 +101,3 @@ advance these aims is welcome:
101101
structures to reduce memory overhead.
102102

103103
And if you have new ideas we'd love to hear them!
104-
105-

0 commit comments

Comments
 (0)