ListClusterFacets

post

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

Takes a high level aggregation of every field and every cluster in a collection. This helps you interpret each cluster and what is in them.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

dataset_id

string

required

length ≤ 240

ID of dataset

Body Params

aggregation_query

object

Aggregation query to aggregate data

filters

array

Defaults to []

Query for filtering the search results

filters

page_size

number

Defaults to 1000

Size of facet page

page

number

Defaults to 1

Page of the results

asc

boolean

Defaults to false

Whether to sort results by ascending or descending frequency

alias

string

vector_fields

array of strings

vector_fields

cluster_field

string

Field to cluster on

cluster_ids

array

List of cluster IDs to aggregate on

cluster_ids

cluster_properties_filter

object

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

facet_fields

array of strings

Fields to include in the facets, if [] then all

facet_fields

date_interval

string

enum

Defaults to monthly

Allowed:

Response

Language

Credentials

Header

Loading…

Response

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

application/json

200successful operation