Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

​
inferencePipelineId
string
required

The inference pipeline id (a UUID).

Body

application/json
​
description
any
​
name
any
​
referenceDatasetUri
string | null

The storage uri of your reference dataset. We recommend using the Python SDK or the UI to handle your reference dataset updates.

Maximum length: 1000

Response

200 - application/json
​
dateCreated
string
required

The creation date.

​
dateLastEvaluated
string | null
required

The last test evaluation date.

​
dateLastSampleReceived
string | null
required

The last data sample received date.

​
dateOfNextEvaluation
string | null
required

The next test evaluation date.

​
dateUpdated
string
required

The last updated date.

​
description
string | null
required

The inference pipeline description.

Maximum length: 500
​
failingGoalCount
integer
required

The number of tests failing.

Required range: x > 0
​
id
string
required

The inference pipeline id.

​
links
object
required
​
name
string
required

The inference pipeline name.

Maximum length: 100
​
passingGoalCount
integer
required

The number of tests passing.

Required range: x > 0
​
projectId
string
required

The project id.

​
status
enum<string>
required

The status of test evaluation for the inference pipeline.

Available options:
queued,
running,
paused,
failed,
completed,
unknown
​
statusMessage
string | null
required

The status message of test evaluation for the inference pipeline.

​
totalGoalCount
integer
required

The total number of tests.

Required range: x > 0
​
project
object
​
workspace
object
​
workspaceId
string

The workspace id.

Was this page helpful?

Retrieve inference pipelineDelete inference pipeline