Sign in

v1

latestOpenAPI 3.0.32026-07-223120123.1 KB
Monitoring

Update inference pipeline.

put/inference-pipelines/{inferencePipelineId}

Path parameters

inferencePipelineIdstring uuid required

The inference pipeline id (a UUID).

Request body

referenceDatasetUristring nullable

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

Response

Status OK.

idstring uuid required

The inference pipeline id.

projectIdstring uuid required

The project id.

workspaceIdstring uuid

The workspace id.

namestring required

The inference pipeline name.

dateCreatedstring date-time required

The creation date.

dateUpdatedstring date-time required

The last updated date.

dateLastSampleReceivedstring date-time nullable required

The last data sample received date.

dateLastPolledstring date-time nullable

The last time the data was polled.

totalRecordsCountinteger nullable

The total number of records in the data backend.

descriptionstring nullable required

The inference pipeline description.

dateLastEvaluatedstring date-time nullable required

The last test evaluation date.

dateOfNextEvaluationstring date-time nullable required

The next test evaluation date.

passingGoalCountinteger required

The number of tests passing.

failingGoalCountinteger required

The number of tests failing.

totalGoalCountinteger required

The total number of tests.

status'queued' | 'running' | 'paused' | 'failed' | 'completed' | 'unknown' required

The status of test evaluation for the inference pipeline.

statusMessagestring nullable required

The status message of test evaluation for the inference pipeline.

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "workspaceId": "055fddb1-261f-4654-8598-f6347ee46a09",
  "project": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "workspaceId": "055fddb1-261f-4654-8598-f6347ee46a09",
    "creatorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
    "name": "My Project",
    "dateCreated": "2024-03-22T11:31:01.185Z",
    "dateUpdated": "2024-03-22T11:31:01.185Z",
    "description": "My project description.",
    "versionCount": 2,
    "inferencePipelineCount": 1,
    "goalCount": 10,
    "developmentGoalCount": 5,
    "monitoringGoalCount": 5,
    "links": {
      "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  },
  "workspace": {
    "name": "Openlayer",
    "slug": "openlayer"
  },
  "name": "production",
  "dateCreated": "2024-03-22T11:31:01.185Z",
  "dateUpdated": "2024-03-22T11:31:01.185Z",
  "dateLastSampleReceived": "2024-03-22T11:31:01.185Z",
  "totalRecordsCount": 1000,
  "description": "This pipeline is used for production.",
  "dateLastEvaluated": "2024-03-22T11:31:01.185Z",
  "dateOfNextEvaluation": "2024-03-22T11:31:01.185Z",
  "passingGoalCount": 5,
  "failingGoalCount": 1,
  "totalGoalCount": 6,
  "status": "completed",
  "statusMessage": "Tests successfully evaluated",
  "links": {
    "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6/inference-pipeline/3fa85f64-5717-4562-b3fc-2c963f66afa6"
  },
  "dataBackend": {
    "projectId": "my-project",
    "datasetId": "my-dataset",
    "tableId": "my-table",
    "config": {
      "inferenceIdColumnName": "id",
      "latencyColumnName": "latency",
      "timestampColumnName": "timestamp",
      "groundTruthColumnName": "ground_truth",
      "humanFeedbackColumnName": "human_feedback"
    }
  }
}