Run Clustering Inference

Assigns cluster labels to rows in the provided dataset using a trained clustering model. Returns a mapping of row IDs to cluster indices and descriptions.

POST /api/models/clustering/{model_id}/infer

Python

Python

import os
from woodwide import WoodWide

client = WoodWide(
    api_key=os.environ.get("WOOD_WIDE_AI_API_KEY"),  # This is the default and can be omitted
)
response = client.api.models.clustering.infer(
    model_id="model_id",
)
print(response.cluster_label)

200

{
  "cluster_label": {},
  "cluster_descriptions": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

model_id · string | null · required

Query Parameters

dataset_id · string | null

dataset_name · string | null

model_name · string | null

Body

application/x-www-form-urlencoded

coerce_schema · boolean · default: true

Response

200

application/json

Successful Response

Response for clustering models. Contains 'cluster_label' mapping row IDs to cluster indices. May contain 'cluster_descriptions' mapping cluster indices to text descriptions.

cluster_label · Cluster Label · object · required

Show child attributes

cluster_descriptions · Cluster Descriptions · object

Show child attributes