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.
​
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
​
workspaceId
string

The workspace id.

​
project
object
​
workspace
object

Was this page helpful?

List inference pipelinesUpdate inference pipeline