Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
project
v1

Cluster Project Documents

Params:
    - method: str[KMeans, MiniBatchKMeans, Birch, DBSCAN]
    - cluster_by: str[term, date, text, definition, duration, party,
                      geoentity, currency_name, currency_value]
    - n_clusters: int
    - force: bool (optional) - force clustering if uncompleted tasks exist
post/api/v1/project/projects/{id}/cluster/

Path parameters

idstring required

A unique integer value identifying this project.

Request body

n_clustersinteger required
forceboolean
cluster_by'term' | 'date' | 'text' | 'definition' | 'duration' | 'party' | 'geoentity' | 'currency_name' | 'currency_value' required
method'kmeans' | 'minibatchkmeans' | 'birch' required
require_confirmationboolean

Example request

{
  "n_clusters": 0,
  "method": "kmeans",
  "require_confirmation": true,
  "force": true,
  "cluster_by": "term"
}

Response

task_idstring uuid required
project_clustering_idinteger required

Example response

{
  "task_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "project_clustering_id": 0
}