Skip to content

Remove genai... procedures from the list #2713

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

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Remove genai... procedures from the list #2713

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
b14a85c
Deprecate procedures `genai.vector.encodeBatch`, `genai.vector.listEn…
NataliaIvakina Nov 10, 2025
8a4e9ee
Remove GenaAI procedures from the reference list
NataliaIvakina Nov 13, 2025
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 modules/ROOT/pages/changes-deprecations-removals.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,7 @@ It is recommended to upgrade to a supported OS version before the next LTS relea
| Enterprise Edition
| Comment


| xref:procedures.adoc#procedure_dbms_cluster_recreateDatabase[`dbms.cluster.recreateDatabase()`]
|
| {check-mark}
Expand Down
49 changes: 2 additions & 47 deletions modules/ROOT/pages/procedures.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1226,13 +1226,13 @@ It is therefore not supported by the parallel runtime.
For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/current/planning-and-tuning/runtimes/concepts#runtimes-parallel-runtime[Cypher Manual -> Parallel runtime].
====

== GenAI and vectors
== Vectors

For more information, see:

* link:{neo4j-docs-base-uri}/cypher-manual/current/indexes/semantic-indexes/vector-indexes/[Cypher Manual -> Vector indexes]
* link:{neo4j-docs-base-uri}/cypher-manual/current/genai-integrations[Cypher Manual -> GenAI integrations]
* link:{neo4j-docs-base-uri}/cypher-manual/current/functions/vector/[Cypher Manual -> Vector functions]
* link:{neo4j-docs-base-uri}/cypher-manual/current/genai-integrations[Cypher Manual -> GenAI integrations]
Copy link
Collaborator Author

@NataliaIvakina NataliaIvakina Nov 13, 2025

Choose a reason for hiding this comment

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

to fix this link when a new manual is published

* link:{neo4j-docs-base-uri}/cypher-manual/current/functions/[Cypher Manual -> GenAI functions]
Copy link
Collaborator Author

@NataliaIvakina NataliaIvakina Nov 13, 2025

Choose a reason for hiding this comment

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

the same

* link:{neo4j-docs-base-uri}/genai/tutorials/embeddings-vector-indexes/[GenAI documentation -> Embeddings & Vector Indexes Tutorial]

Expand Down Expand Up @@ -1374,34 +1374,6 @@ The similarity score is a value between [0, 1]; where 0 indicates least similar,
|===



[[procedure_genai_vector_encodeBatch]]
=== genai.vector.encodeBatch()


.Details
|===
| *Syntax* 3+m| genai.vector.encodeBatch(resources, provider, configuration) :: (index, resource, vector)
| *Description* 3+a| Encode a given batch of resources as vectors using the named provider.
For each element in the given resource LIST this returns:

* the corresponding 'index' within that LIST,
* the original 'resource' element itself,
* and the encoded 'vector'.

.4+| *Input arguments* | *Name* | *Type* | *Description*
| `resources` | `LIST<STRING>` | The object to transform into an embedding.
| `provider` | `STRING` | The GenAI provider to use.
| `configuration` | `ANY` | The provider specific settings.
.4+| *Return arguments* | *Name* | *Type* | *Description*
| `index` | `INTEGER` | The index of the corresponding element in the input list.
| `resource` | `STRING` | The name of the input resource.
| `vector` | `ANY` | The generated vector embedding for the resource.
| *Mode* 3+| DEFAULT
|===

For more information, see the link:{neo4j-docs-base-uri}/cypher-manual/current/genai-integrations/#multiple-embeddings[Cypher Manual -> Generating a batch of embeddings].

.Known issue
[NOTE]
====
Expand All @@ -1410,23 +1382,6 @@ The types are still enforced as `LIST<INTEGER | FLOAT>`.
====


[[procedure_genai_vector_listEncodingProviders]]
=== genai.vector.listEncodingProviders()


.Details
|===
| *Syntax* 3+m| genai.vector.listEncodingProviders() :: (name, requiredConfigType, otionalConfigType, defaultConfig)
| *Description* 3+a| Lists the available vector embedding providers.
.5+| *Return arguments* | *Name* | *Type* | *Description*
| `name` | `STRING` | The name of the GenAI provider.
| `requiredConfigType` | `STRING` | The signature of the required config map.
| `optionalConfigType` | `STRING` | The signature of the optional config map.
| `defaultConfig` | `MAP` | The default values for the GenAI provider.
| *Mode* 3+| DEFAULT
|===


== Index management

For more information, see:
Expand Down