models_list_builds: List builds for the given Model job

In civis: R Client for the 'Civis Platform API'

List builds for the given Model job

Description

List builds for the given Model job

Usage

models_list_builds(
  id,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

id	integer required. The ID of the Model job.
limit	integer optional. Number of results to return. Defaults to 20. Maximum allowed is 100.
page_num	integer optional. Page number of the results to return. Defaults to the first page, 1.
order	string optional. The field on which to order the result set. Defaults to id. Must be one of: id.
order_dir	string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

Value

An array containing the following fields:

id	integer, The ID of the model build.
state	string, The state of the model build.one of 'queued' 'running' 'succeeded' 'failed' or 'cancelled'.
error	string, The error, if any, returned by the build.
name	string, The name of the model build.
createdAt	string, The time the model build was created.
description	string, A description of the model build.
rootMeanSquaredError	number, A key metric for continuous models. Nil for other model types.
rSquaredError	number, A key metric for continuous models. Nil for other model types.
rocAuc	number, A key metric for binary, multinomial, and ordinal models. Nil for other model types.
transformationMetadata	string, A string representing the full JSON output of the metadata for transformation of column names
output	string, A string representing the JSON output for the specified build. Only present when smaller than 10KB in size.
outputLocation	string, A URL representing the location of the full JSON output for the specified build.The URL link will be valid for 5 minutes.

civis documentation built on Aug. 30, 2025, 1:08 a.m.