Authorizations

Authorization
string
headerrequired

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
name
any
description
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
id
string
required

The inference pipeline id.

projectId
string
required

The project id.

name
string
required

The inference pipeline name.

Maximum length: 100
dateCreated
string
required

The creation date.

dateUpdated
string
required

The last updated date.

dateLastSampleReceived
string | null
required

The last data sample received date.

description
string | null
required

The inference pipeline description.

Maximum length: 500
dateLastEvaluated
string | null
required

The last test evaluation date.

dateOfNextEvaluation
string | null
required

The next test evaluation date.

passingGoalCount
integer
required

The number of tests passing.

Required range: x > 0
failingGoalCount
integer
required

The number of tests failing.

Required range: x > 0
totalGoalCount
integer
required

The total number of tests.

Required range: x > 0
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.

links
object
required

Was this page helpful?

Retrieve inference pipelineDelete inference pipeline