UHuhh-lt
perspectives

Returns the clusters for the given SourceDocument (sdoc_id) in the specified Aspect (aspect_id).

Changed on
get/perspectives/clusters/{aspect_id}/sdoc/{sdoc_id}

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Password
    Token URL: /authentication/login

Path parameters

aspect_idinteger required
sdoc_idinteger required

Response

Successful Response

idinteger required

ID of the cluster

aspect_idinteger required

ID of the aspect this cluster belongs to

parent_cluster_idinteger nullable required

ID of the parent cluster, if any

is_outlierboolean required

Whether the cluster is an outlier

namestring required

Name of the cluster

descriptionstring required

Description of the cluster

levelinteger required

Hierarchical level of the cluster

xnumber required

X coordinate for visualization

ynumber required

Y coordinate for visualization

top_wordsstring[] nullable required

Top words associated with the cluster

top_word_scoresnumber[] nullable required

Scores of the top words

top_docsinteger[] nullable required

IDs of top documents for the cluster

Changes

  • bd1187f3520eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 53e769440a25Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status