Insights
Get an insight
Retrieves the specified insight report and its results.
Header parameters
Foundry-Features
enum
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
Query parameters
includeCoordinates
boolean
Whether to include coordinates for visualization in the response. Defaults to false.
api-version
string
required
The API version to use for this operation.
Path parameters
id
string
required
The unique identifier for the insights report.
Responses
The request has succeeded.
Body
id
string
required
The unique identifier for the insights report.
metadata
InsightsMetadata
required
Metadata about the insights.
createdAt
string
required
The timestamp when the insights were created.
completedAt
string
The timestamp when the insights were completed.
state
enum | string
required
Enum describing allowed operation states.
enum
displayName
string
required
User friendly display name for the insight.
request
EvaluationRunClusterInsight | AgentClusterInsight | EvaluationComparison
required
The request of the insights report.
EvaluationRunClusterInsight
EvaluationRunClusterInsightRequest
Insights on set of Evaluation Results
type
enum
required
The type of insights request.
evalId
string
required
Evaluation Id for the insights.
runIds
string[]
required
List of evaluation run IDs for the insights.
modelConfiguration
InsightModelConfiguration
Configuration of the model used in the insight generation.
modelDeploymentName
string
required
The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/<modelDeploymentName>'.
AgentClusterInsight
AgentClusterInsightRequest
Insights on set of Agent Evaluation Results
type
enum
required
The type of request.
agentName
string
required
Identifier for the agent.
modelConfiguration
InsightModelConfiguration
Configuration of the model used in the insight generation.
modelDeploymentName
string
required
The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/<modelDeploymentName>'.
EvaluationComparison
EvaluationComparisonInsightRequest
Evaluation Comparison Request
type
enum
required
The type of request.
evalId
string
required
Identifier for the evaluation.
baselineRunId
string
required
The baseline run ID for comparison.
treatmentRunIds
string[]
required
List of treatment run IDs for comparison.
result
EvaluationComparison | EvaluationRunClusterInsight | AgentClusterInsight
The result of the insights.
EvaluationComparison
EvaluationComparisonInsightResult
Insights from the evaluation comparison.
type
enum
required
The type of insights result.
comparisons
EvalRunResultComparison[]
required
Comparison results for each treatment run against the baseline.
method
string
required
The statistical method used for comparison.
EvaluationRunClusterInsight
EvaluationRunClusterInsightResult
Insights from the evaluation run cluster analysis.
type
enum
required
The type of insights result.
clusterInsight
ClusterInsightResult
required
Insights from the cluster analysis.
summary
InsightSummary
required
Summary of the error cluster analysis.
sampleCount
integer
required
Total number of samples analyzed.
uniqueSubclusterCount
integer
required
Total number of unique subcluster labels.
uniqueClusterCount
integer
required
Total number of unique clusters.
method
string
required
Method used for clustering.
usage
ClusterTokenUsage
required
Token usage for cluster analysis
inputTokenUsage
integer
required
input token usage
outputTokenUsage
integer
required
output token usage
totalTokenUsage
integer
required
total token usage
clusters
InsightCluster[]
required
List of clusters identified in the insights.
coordinates
object
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.
[key: string]
ChartCoordinate
Coordinates for the analysis chart.
x
integer
required
X-axis coordinate.
y
integer
required
Y-axis coordinate.
size
integer
required
Size of the chart element.
AgentClusterInsight
AgentClusterInsightResult
Insights from the agent cluster analysis.
type
enum
required
The type of insights result.
clusterInsight
ClusterInsightResult
required
Insights from the cluster analysis.
summary
InsightSummary
required
Summary of the error cluster analysis.
sampleCount
integer
required
Total number of samples analyzed.
uniqueSubclusterCount
integer
required
Total number of unique subcluster labels.
uniqueClusterCount
integer
required
Total number of unique clusters.
method
string
required
Method used for clustering.
usage
ClusterTokenUsage
required
Token usage for cluster analysis
inputTokenUsage
integer
required
input token usage
outputTokenUsage
integer
required
output token usage
totalTokenUsage
integer
required
total token usage
clusters
InsightCluster[]
required
List of clusters identified in the insights.
coordinates
object
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.
[key: string]
ChartCoordinate
Coordinates for the analysis chart.
x
integer
required
X-axis coordinate.
y
integer
required
Y-axis coordinate.
size
integer
required
Size of the chart element.
Request
GET /insights/{id} HTTP/1.1Response
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json