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.

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

vector optimized configurations #527

Open
wants to merge 16 commits into
base: console
Choose a base branch
from
Open
Changes from 6 commits
Commits
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
22 changes: 22 additions & 0 deletions modules/ROOT/pages/managing-instances/instance-details.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,28 @@ A snapshot is a copy of the data in an instance at a specific point in time.
Neo4j regularly takes snapshots of your instance, and you can request a snapshot to be taken on demand.
These snapshots can be used to restore data to a different Neo4j instance.

== Vector optimization
fiquick marked this conversation as resolved.
Show resolved Hide resolved

label:AuraDB-Professional[]
label:AuraDB-Business-Critical[]
label:AuraDB-Virtual-Dedicated-Cloud[]

Vector optimization reserves memory for vector indexes, enhancing performance for vector-based operations.
It is available for AuraDB instances with more than 4GB of memory, and is available across all supported cloud providers and regions.
fiquick marked this conversation as resolved.
Show resolved Hide resolved

This configuration may impact memory use and therefore may affect performance for other queries.

You can enable vector optimization during instance creation when selecting *Instance details* with a toggle under *Additional settings*.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
You can enable vector optimization during instance creation when selecting *Instance details* with a toggle under *Additional settings*.
You can enable vector optimization during instance creation using the toggle in *Additional settings*, in the *Instance details*.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the suggestion - I considered both phrases, and the original phrasing seems a bit clearer as it guides users through a sequential flow, directing them to Instance details before mentioning Additional settings. Let me know if you have any other thoughts!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"You can enable vector optimization with a toggle during instance creation."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Update: waiting for the final UX for the setting before finalizing this part

To enable vector optimization on existing instances, from the instance card, select the more menu *(…​)* then select *Inspect* to see the *Instance details.*
fiquick marked this conversation as resolved.
Show resolved Hide resolved
You can view the current vector configuration status from the *instance details*.

If you lower the instance size below 4GB, vector optimization is disabled automatically.

If you clone your instance to a new instance, the new instance inherits the vector optimization settings of the original instance.
But if you clone to an existing instance, the existing instance *does not* inherit the original instance's vector optimization settings.

To learn more about how to use vector indexes, see link:https://neo4j.com/docs/cypher-manual/current/indexes/semantic-indexes/vector-indexes/[Cypher Manual -> Vector indexes].

// == Import instance

// _Feature coming soon!_
Expand Down