API Reference

ListClosestToCentroids

post
https://api.us-east-1.relevance.ai/latest/datasets//cluster/centroids/list_closest_to_center

List documents with vector fields closest to centroids.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 240

ID of dataset

Body Params
vector_fields
array of strings

The vector fields that these centroids are associated with.

vector_fields
centroid_vector_fields
array of strings
centroid_vector_fields
string

Alias is used to name a cluster.

string
cluster_ids
array

List of cluster IDs to retrieve

cluster_ids
select_fields
array of strings
select_fields
number
boolean
number
Defaults to 20

Size of each page of results

number
Defaults to 1

Page of the results

enum
Allowed:
filters
array
filters
number
boolean
Defaults to false

Include vectors in the search results

boolean
string
cluster_properties_filter
object

Filter if clusters with certain characteristics should be hidden in results.

Response

Updated over 4 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 4 years ago