Type Alias PredictResponsePayload

Response payload for prediction requests. Contains a list of prediction results.

type PredictResponsePayload = {
    explanations?: ExplanationResult | null;
    id: string;
    metadata: PredictResponseMetadata;
    predictions: Record<string, PredictionResult[] | string | number>[];
    status: PredictResponseStatus;
}

Index

Properties

explanations? id metadata predictions status

Properties

`Optional`explanations

explanations?: ExplanationResult | null

Explanation data containing context row and column scores.

id

id: string

Unique ID for the request.

metadata

metadata: PredictResponseMetadata

predictions

predictions: Record<string, PredictionResult[] | string | number>[]

Mapping of column names to their list of prediction results or index column.

status

status: PredictResponseStatus

Status message that can indicate warnings (e.g. about suboptimal data).