Share via


ClusterInsightResult interface

Insights from the cluster analysis.

Properties

clusters

List of clusters identified in the insights.

coordinates

Optional mapping of IDs to 2D coordinates used by the UX for visualization.

The map keys are string identifiers (for example, a cluster id or a sample id) and the values are the coordinates and visual size for rendering on a 2D chart.

This property is omitted unless the client requests coordinates (for example, by passing includeCoordinates=true as a query parameter).

Example:

{
  "cluster-1": { "x": 12, "y": 34, "size": 8 },
  "sample-123": { "x": 18, "y": 22, "size": 4 }
}

Coordinates are intended only for client-side visualization and do not modify the canonical insights results.

summary

Summary of the insights report.

Property Details

clusters

List of clusters identified in the insights.

clusters: InsightCluster[]

Property Value

coordinates

Optional mapping of IDs to 2D coordinates used by the UX for visualization.

The map keys are string identifiers (for example, a cluster id or a sample id) and the values are the coordinates and visual size for rendering on a 2D chart.

This property is omitted unless the client requests coordinates (for example, by passing includeCoordinates=true as a query parameter).

Example:

{
  "cluster-1": { "x": 12, "y": 34, "size": 8 },
  "sample-123": { "x": 18, "y": 22, "size": 4 }
}

Coordinates are intended only for client-side visualization and do not modify the canonical insights results.

coordinates?: Record<string, ChartCoordinate>

Property Value

Record<string, ChartCoordinate>

summary

Summary of the insights report.

summary: InsightSummary

Property Value