Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

document new vector api #62

Merged
merged 2 commits into from
Aug 19, 2024
Merged

document new vector api #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
431a02d
document new vector api
AviAvni Aug 19, 2024
438cb58
add word
AviAvni Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ yaml
uri
vec
euclideanDistance
cosineDistance
vecf
Dani
Dovizioso
Expand Down
1 change: 1 addition & 0 deletions cypher/functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ This section contains information on all supported functions from the Cypher que
| ----------------------------------------- | :----------|
| vecf32(_array_) | Creates a new float 32 vector <br> all elements of input array must be of type float |
| vec.euclideanDistance(_vector_, _vector_) | Returns the Euclidean distance between the two input vectors |
| vec.cosineDistance(_vector_, _vector_) | Returns the Cosine distance between the two input vectors |

### List comprehensions

Expand Down
11 changes: 11 additions & 0 deletions cypher/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,17 @@ To create this type of index use the following syntax:
CREATE VECTOR INDEX FOR <entity_pattern> ON <entity_attribute> OPTIONS <options>
```

The options are:
```
{
dimension: INT, // Requiered, length of the vector to be indexed
similarityFunction: STRING, // Requiered, currently only euclidean is allowed
M: INT, // Optional, maximum number of outgoing edges per node. default 16
efConstruction: INT, // Optional, number of candidates during construction. default 200
efRuntime: INT // Optional, number of candidates during search. default 10
}
```
Comment on lines +203 to +211
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add language specification to the fenced code block.

The fenced code block for the options should specify a language for better syntax highlighting.

-```
+```json
Tools
Markdownlint

203-203: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)


For example, to create a vector index over all `Product` nodes `description` attribute
use the following syntax:

Expand Down
Loading