Skip to content

Commit 976bf21

Browse files
authored
Vector index no longer experimental (#803)
* Vector index no longer experimental * Rename startup option * Mention previous startup option name in release notes
1 parent 311dee3 commit 976bf21

File tree

10 files changed

+30
-34
lines changed

10 files changed

+30
-34
lines changed

site/content/3.12/about-arangodb/features/core.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,9 @@ available from v3.12.5 onward.
150150
threshold is reached.
151151
{{% /comment %}}
152152

153-
{{% comment %}} Experimental feature
154153
- [**Vector search**](../../index-and-search/indexing/working-with-indexes/vector-indexes.md):
155154
Find items with similar properties by comparing vector embeddings generated by
156155
machine learning models.
157-
{{% /comment %}}
158156

159157
- [**Search highlighting**](../../index-and-search/arangosearch/search-highlighting.md):
160158
Get the substring positions of matched terms, phrases, or _n_-grams.

site/content/3.12/aql/functions/vector.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ You can calculate vector embeddings using [ArangoDB's GraphML](../../data-scienc
1616
capabilities (available in ArangoGraph) or using external tools.
1717

1818
{{< warning >}}
19-
The vector index is an experimental feature that you need to enable for the
20-
ArangoDB server with the `--experimental-vector-index` startup option.
19+
You need to enable the vector index feature for the
20+
ArangoDB server with the `--vector-index` startup option.
2121
Once enabled for a deployment, it cannot be disabled anymore because it
2222
permanently changes how the data is managed by the RocksDB storage engine
2323
(it adds an additional column family).
2424

25-
To restore a dump that contains vector indexes, the `--experimental-vector-index`
25+
To restore a dump that contains vector indexes, the `--vector-index`
2626
startup option needs to be enabled on the deployment you want to restore to.
2727
{{< /warning >}}
2828

site/content/3.12/index-and-search/indexing/working-with-indexes/vector-indexes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ The vector index implementation uses the [Faiss library](https://github.com/face
1919
## How to use vector indexes
2020

2121
{{< warning >}}
22-
The vector index is an experimental feature that you need to enable for the
23-
ArangoDB server with the `--experimental-vector-index` startup option.
22+
You need to enable the vector index feature for the
23+
ArangoDB server with the `--vector-index` startup option.
2424
Once enabled for a deployment, it cannot be disabled anymore because it
2525
permanently changes how the data is managed by the RocksDB storage engine
2626
(it adds an additional column family).
2727

28-
To restore a dump that contains vector indexes, the `--experimental-vector-index`
28+
To restore a dump that contains vector indexes, the `--vector-index`
2929
startup option needs to be enabled on the deployment you want to restore to.
3030
{{< /warning >}}
3131

32-
1. Enable the experimental vector index feature.
32+
1. Enable the vector index feature.
3333
2. Calculate vector embeddings using [ArangoDB's GraphML](../../../data-science/graphml/_index.md)
3434
capabilities (available in ArangoGraph) or using external tools.
3535
Store each vector as an attribute in the respective document.

site/content/3.12/release-notes/version-3.12/api-changes-in-3-12.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,11 +463,11 @@ add the `withHidden=true` query parameter to the call of the endpoint.
463463
curl "http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
464464
```
465465

466-
#### Vector indexes (experimental)
466+
#### Vector indexes
467467

468468
<small>Introduced in: v3.12.4</small>
469469

470-
A new `vector` index type has been added as an experimental feature.
470+
A new `vector` index type has been added.
471471
See [HTTP interface for vector indexes](../../develop/http-api/indexes/vector.md)
472472
for details.
473473

site/content/3.12/release-notes/version-3.12/whats-new-in-3-12.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1485,18 +1485,18 @@ Note that it is still forbidden to use `_id` as a top-level attribute or
14851485
sub-attribute in `fields` of persistent indexes. On the other hand, inverted
14861486
indexes have been allowing to index and store the `_id` system attribute.
14871487

1488-
### Vector indexes (experimental)
1488+
### Vector indexes
14891489

14901490
<small>Introduced in: v3.12.4</small>
14911491

1492-
A new `vector` index type has been added as an experimental feature that enables
1492+
A new `vector` index type has been added that enables
14931493
you to find items with similar properties by comparing vector embeddings, which
14941494
are numerical representations generated by machine learning models.
14951495

1496-
To try out this feature, start an ArangoDB server (`arangod`) with the
1497-
`--experimental-vector-index` startup option. You need to generate
1498-
vector embeddings before creating a vector index. For more information about
1499-
the vector index type including the available settings, see the
1496+
To use this feature, start an ArangoDB server (`arangod`) with the `--vector-index`
1497+
startup option (or `--experimental-vector-index` in v3.12.4 and v3.12.5).
1498+
You need to generate vector embeddings before creating a vector index. For more
1499+
information about the vector index type including the available settings, see the
15001500
[Vector indexes](../../index-and-search/indexing/working-with-indexes/vector-indexes.md)
15011501
documentation.
15021502

site/content/3.13/about-arangodb/features/core.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,11 +145,9 @@ aliases:
145145
threshold is reached.
146146
{{% /comment %}}
147147

148-
{{% comment %}} Experimental feature
149148
- [**Vector search**](../../index-and-search/indexing/working-with-indexes/vector-indexes.md):
150149
Find items with similar properties by comparing vector embeddings generated by
151150
machine learning models.
152-
{{% /comment %}}
153151

154152
- [**Search highlighting**](../../index-and-search/arangosearch/search-highlighting.md):
155153
Get the substring positions of matched terms, phrases, or _n_-grams.

site/content/3.13/aql/functions/vector.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ You can calculate vector embeddings using [ArangoDB's GraphML](../../data-scienc
1616
capabilities (available in ArangoGraph) or using external tools.
1717

1818
{{< warning >}}
19-
The vector index is an experimental feature that you need to enable for the
20-
ArangoDB server with the `--experimental-vector-index` startup option.
19+
You need to enable the vector index feature for the
20+
ArangoDB server with the `--vector-index` startup option.
2121
Once enabled for a deployment, it cannot be disabled anymore because it
2222
permanently changes how the data is managed by the RocksDB storage engine
2323
(it adds an additional column family).
2424

25-
To restore a dump that contains vector indexes, the `--experimental-vector-index`
25+
To restore a dump that contains vector indexes, the `--vector-index`
2626
startup option needs to be enabled on the deployment you want to restore to.
2727
{{< /warning >}}
2828

site/content/3.13/index-and-search/indexing/working-with-indexes/vector-indexes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ The vector index implementation uses the [Faiss library](https://github.com/face
1919
## How to use vector indexes
2020

2121
{{< warning >}}
22-
The vector index is an experimental feature that you need to enable for the
23-
ArangoDB server with the `--experimental-vector-index` startup option.
22+
You need to enable the vector index feature for the
23+
ArangoDB server with the `--vector-index` startup option.
2424
Once enabled for a deployment, it cannot be disabled anymore because it
2525
permanently changes how the data is managed by the RocksDB storage engine
2626
(it adds an additional column family).
2727

28-
To restore a dump that contains vector indexes, the `--experimental-vector-index`
28+
To restore a dump that contains vector indexes, the `--vector-index`
2929
startup option needs to be enabled on the deployment you want to restore to.
3030
{{< /warning >}}
3131

32-
1. Enable the experimental vector index feature.
32+
1. Enable the vector index feature.
3333
2. Calculate vector embeddings using [ArangoDB's GraphML](../../../data-science/graphml/_index.md)
3434
capabilities (available in ArangoGraph) or using external tools.
3535
Store each vector as an attribute in the respective document.

site/content/3.13/release-notes/version-3.12/api-changes-in-3-12.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,11 +463,11 @@ add the `withHidden=true` query parameter to the call of the endpoint.
463463
curl "http://localhost:8529/_api/index?collection=myCollection&withHidden=true"
464464
```
465465

466-
#### Vector indexes (experimental)
466+
#### Vector indexes
467467

468468
<small>Introduced in: v3.12.4</small>
469469

470-
A new `vector` index type has been added as an experimental feature.
470+
A new `vector` index type has been added.
471471
See [HTTP interface for vector indexes](../../develop/http-api/indexes/vector.md)
472472
for details.
473473

site/content/3.13/release-notes/version-3.12/whats-new-in-3-12.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1485,18 +1485,18 @@ Note that it is still forbidden to use `_id` as a top-level attribute or
14851485
sub-attribute in `fields` of persistent indexes. On the other hand, inverted
14861486
indexes have been allowing to index and store the `_id` system attribute.
14871487

1488-
### Vector indexes (experimental)
1488+
### Vector indexes
14891489

14901490
<small>Introduced in: v3.12.4</small>
14911491

1492-
A new `vector` index type has been added as an experimental feature that enables
1492+
A new `vector` index type has been added that enables
14931493
you to find items with similar properties by comparing vector embeddings, which
14941494
are numerical representations generated by machine learning models.
14951495

1496-
To try out this feature, start an ArangoDB server (`arangod`) with the
1497-
`--experimental-vector-index` startup option. You need to generate
1498-
vector embeddings before creating a vector index. For more information about
1499-
the vector index type including the available settings, see the
1496+
To use this feature, start an ArangoDB server (`arangod`) with the `--vector-index`
1497+
startup option (or `--experimental-vector-index` in v3.12.4 and v3.12.5).
1498+
You need to generate vector embeddings before creating a vector index. For more
1499+
information about the vector index type including the available settings, see the
15001500
[Vector indexes](../../index-and-search/indexing/working-with-indexes/vector-indexes.md)
15011501
documentation.
15021502

0 commit comments

Comments
 (0)