Search Node2Vec embeddings

GET /v1/tenants/{tenant}/graph/{schema}/node2vec/{rel}/topk

Find nodes with similar learned rolesRepresentation similarity differs from a direct link or shortest path.

Choose a query nodeUse a graph with saved Node2Vec embeddings.
Compare learned vectorsApply the selected metric and result limit.
Read similar node keysInterpret scores within this embedding search.

Before you start

Use your database bearer token.

Train Node2Vec embeddings with persistence before searching them. Use a node with a usable saved embedding.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`schema`	`string`	Required
`rel`	`string`	Required

Query parameters

Field	Type	Required
`query`	`string`	Required
`k`	`integer`	Required
`metric`	`string`	Optional

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

Each item is a node key with a similarity score from saved Node2Vec embeddings. This compares learned graph representations; it is different from finding a direct edge or shortest path.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
408	Reduce query work or adjust the timeout.
429	Honor Retry-After when present; back off.
499	The client cancelled the request.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/graph/demo.people/node2vec/follows/topk?query=u1&k=3&metric=cosine" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

[
  {
    "pk": "u1",
    "score": 1
  },
  {
    "pk": "u2",
    "score": 0.9331
  },
  {
    "pk": "u3",
    "score": 0.6415
  }
]

Illustrative similarities in the persisted example vectors; actual learned embeddings differ.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

Query parametersCopy Anchor Link

HeadersCopy Anchor Link