Retrieve inference pipeline

from openlayer import Openlayer

client = Openlayer()
inference_pipeline = client.inference_pipelines.retrieve(
    inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)

{
  "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.",
    "source": "web",
    "taskType": "llm-base",
    "versionCount": 2,
    "inferencePipelineCount": 1,
    "goalCount": 10,
    "developmentGoalCount": 5,
    "monitoringGoalCount": 5,
    "links": {
      "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "gitRepo": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "gitId": 123,
      "dateConnected": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z",
      "branch": "<string>",
      "name": "<string>",
      "private": true,
      "slug": "<string>",
      "url": "<string>",
      "rootDir": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "gitAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "workspace": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Openlayer",
    "slug": "openlayer",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "wildcardDomains": [
      "<string>"
    ],
    "projectCount": 1,
    "memberCount": 1,
    "monthlyUsage": [
      {
        "monthYear": "2023-12-25",
        "predictionCount": 1,
        "executionTimeMs": 1
      }
    ],
    "inviteCount": 1,
    "periodStartDate": "2023-11-07T05:31:56Z",
    "periodEndDate": "2023-11-07T05:31:56Z",
    "samlOnlyAccess": true,
    "status": "active"
  },
  "name": "production",
  "dateCreated": "2024-03-22T11:31:01.185Z",
  "dateUpdated": "2024-03-22T11:31:01.185Z",
  "dateLastSampleReceived": "2024-03-22T11:31:01.185Z",
  "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"
  }
}

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).

Query Parameters

expand

enum<string>[]

Expand specific nested objects.

Available options:

project,

workspace

Response

200

application/json

Status OK.

string

required

The inference pipeline id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

projectId

string

required

The project id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

name

string

required

The inference pipeline name.

Maximum length: 100

Example:

"production"

dateCreated

string

required

The creation date.

Example:

"2024-03-22T11:31:01.185Z"

dateUpdated

string

required

The last updated date.

Example:

"2024-03-22T11:31:01.185Z"

dateLastSampleReceived

string | null

required

The last data sample received date.

Example:

"2024-03-22T11:31:01.185Z"

description

string | null

required

The inference pipeline description.

Maximum length: 500

Example:

"This pipeline is used for production."

dateLastEvaluated

string | null

required

The last test evaluation date.

Example:

"2024-03-22T11:31:01.185Z"

dateOfNextEvaluation

string | null

required

The next test evaluation date.

Example:

"2024-03-22T11:31:01.185Z"

passingGoalCount

integer

required

The number of tests passing.

Required range: x >= 0

Example:

5

failingGoalCount

integer

required

The number of tests failing.

Required range: x >= 0

Example:

1

totalGoalCount

integer

required

The total number of tests.

Required range: x >= 0

Example:

6

status

enum<string>

required

The status of test evaluation for the inference pipeline.

Available options:

queued,

running,

paused,

failed,

completed,

unknown

Example:

"completed"

statusMessage

string | null

required

The status message of test evaluation for the inference pipeline.

Example:

"Tests successfully evaluated"

links

object

required

workspaceId

string

The workspace id.

Example:

"055fddb1-261f-4654-8598-f6347ee46a09"

project

object

project.id

string

required

The project id.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

project.workspaceId

string | null

required

The workspace id.

Example:

"055fddb1-261f-4654-8598-f6347ee46a09"

project.creatorId

string | null

required

The project creator id.

Example:

"589ece63-49a2-41b4-98e1-10547761d4b0"

project.name

string

required

The project name.

Maximum length: 64

Example:

"My Project"

project.dateCreated

string

required

The project creation date.

Example:

"2024-03-22T11:31:01.185Z"

project.dateUpdated

string

required

The project last updated date.

Example:

"2024-03-22T11:31:01.185Z"

project.source

enum<string> | null

required

The source of the project.

Available options:

web,

api,

null

project.taskType

enum<string>

required

The task type of the project.

Available options:

llm-base,

tabular-classification,

tabular-regression,

text-classification

project.versionCount

integer

required

The number of versions (commits) in the project.

Required range: x >= 0

Example:

2

project.inferencePipelineCount

integer

required

The number of inference pipelines in the project.

Required range: x >= 0

Example:

1

project.goalCount

integer

required

The total number of tests in the project.

Required range: x >= 0

Example:

10

project.developmentGoalCount

integer

required

The number of tests in the development mode of the project.

Required range: x >= 0

Example:

5

project.monitoringGoalCount

integer

required

The number of tests in the monitoring mode of the project.

Required range: x >= 0

Example:

5

project.links

object

required

Links to the project.

project.description

string | null

The project description.

Maximum length: 280

Example:

"My project description."

project.gitRepo

object

workspace

object

Was this page helpful?

List inference pipelines Update inference pipeline

from openlayer import Openlayer

client = Openlayer()
inference_pipeline = client.inference_pipelines.retrieve(
    inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)

{
  "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.",
    "source": "web",
    "taskType": "llm-base",
    "versionCount": 2,
    "inferencePipelineCount": 1,
    "goalCount": 10,
    "developmentGoalCount": 5,
    "monitoringGoalCount": 5,
    "links": {
      "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "gitRepo": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "gitId": 123,
      "dateConnected": "2023-11-07T05:31:56Z",
      "dateUpdated": "2023-11-07T05:31:56Z",
      "branch": "<string>",
      "name": "<string>",
      "private": true,
      "slug": "<string>",
      "url": "<string>",
      "rootDir": "<string>",
      "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "gitAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "workspace": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Openlayer",
    "slug": "openlayer",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "creatorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "wildcardDomains": [
      "<string>"
    ],
    "projectCount": 1,
    "memberCount": 1,
    "monthlyUsage": [
      {
        "monthYear": "2023-12-25",
        "predictionCount": 1,
        "executionTimeMs": 1
      }
    ],
    "inviteCount": 1,
    "periodStartDate": "2023-11-07T05:31:56Z",
    "periodEndDate": "2023-11-07T05:31:56Z",
    "samlOnlyAccess": true,
    "status": "active"
  },
  "name": "production",
  "dateCreated": "2024-03-22T11:31:01.185Z",
  "dateUpdated": "2024-03-22T11:31:01.185Z",
  "dateLastSampleReceived": "2024-03-22T11:31:01.185Z",
  "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"
  }
}

Reference

SDKs

CLI

REST API

Retrieve inference pipeline

Authorizations

Path Parameters

Query Parameters

Response