Sign in

v1

latestOpenAPI 3.0.32026-07-223120123.1 KB
Monitoring

List inference pipelines

List the inference pipelines in a project.

get/projects/{projectId}/inference-pipelines

Path parameters

projectIdstring uuid required

The project id.

Query parameters

pageinteger

The page to return in a paginated query.

perPageinteger

Maximum number of items to return per page.

namestring

Filter list of items by name.

Response

Status OK.

Example response

{
  "items": [
    {
      "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"
        }
      }
    }
  ]
}