Search GraphSAGE embeddings

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

Search the learned GraphSAGE representationsSaved embeddings must exist before this request can compare nodes.

Choose a query nodeSelect the relation, result limit and metric.
Compare saved representationsSearch the trained GraphSAGE embeddings.
Read similar node keysUse their scores within this similarity calculation.

Before you start

Use your database bearer token.

Train GraphSAGE 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 contains a matched node key and score from the saved GraphSAGE embeddings. k asks for a result limit; it does not guarantee that the graph contains that many usable embeddings.

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/graphsage/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