ListClosestToCentroids

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

List documents with vector fields closest to centroids.

Path Params

dataset_id

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

alias

string

Alias is used to name a cluster.

dataset_id

string

cluster_ids

array

List of cluster IDs to retrieve

cluster_ids

select_fields

array of strings

select_fields

approx

number

sum_fields

boolean

page_size

number

Defaults to 20

Size of each page of results

page

number

Defaults to 1

Page of the results

similarity_metric

filters

array

filters

min_score

number

include_vector

boolean

Defaults to false

Include vectors in the search results

include_count

boolean

centroid_dataset_id

string

cluster_properties_filter

object

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

Response

Language

Credentials

Header


xxxxxxxxxx
14
1
curl --request POST \
2
     --url https://api.us-east-1.relevance.ai/latest/datasets/dataset_id/cluster/centroids/list_closest_to_center \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "page_size": 20,
8
  "page": 1,
9
  "include_vector": false,
10
  "cluster_properties_filter": {
11
    "minimum_cluster_size": 0
12
  }
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation