Nearest Neighbors By Ids

POST 
/v1/project/data/get/nearest_neighbors/by_id

Nearest Neighbors By Ids

Request

application/json

Body

required

atlas_index_id Atlas Index Id (string)required

Unique atlas index id

datum_ids

object

The datum ids to query.

anyOf

MOD1

Array [

string

]

atom_ids

object

The atom ids to query.

anyOf

MOD1

Array [

string

]

k K (integer)

Default value: 4

The number of neighbors to return

Responses

200

Successful Response

application/json

Schema

Schema

neighbors array[]required

nested list of nearest neighbors

distances array[]required

distances of the neighbors to queries

Example (from schema)

{
  "neighbors": [
    [
      "string"
    ]
  ],
  "distances": [
    [
      0
    ]
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...