client.predictions.list

A method of the Predictions endpoint.

list(*, model_id: int = None) → ListResponse

List predictions

API URL: GET /predictions

import civis
client = civis.APIClient()
response = client.predictions.list(...)

Parameters:

model_idint, optional

If specified, only return predictions associated with this model ID.

Returns:

civis.ListResponse

• idint

  The ID of the prediction.

• model_idint

  The ID of the model used for this prediction.

• scored_table_idint

  The ID of the source table for this prediction.

• scored_table_namestr

  The name of the source table for this prediction.

• output_table_namestr

  The name of the output table for this prediction.

• statestr

  The state of the last run of this prediction.

• errorstr

  The error, if any, of the last run of this prediction.

• started_atstr (date-time)

  The start time of the last run of this prediction.

• finished_atstr (date-time)

  The end time of the last run of this prediction.

• last_runcivis.Response

  • id : int

  • statestr

    The state of the run. One of queued, running, succeeded, failed or cancelled.

  • created_atstr (time)

    The time that the run was queued.

  • started_atstr (time)

    The time that the run started.

  • finished_atstr (time)

    The time that the run completed.

  • errorstr

    The error message for this run, if present.