List data sources

Python

from openlayer import Openlayer

client = Openlayer()
client.projects.inference_pipelines.list(
  project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "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"
      },
      "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",
        "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"
        },
        "description": "My project description.",
        "gitRepo": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "gitId": 123,
          "dateConnected": "2023-11-07T05:31:56Z",
          "dateUpdated": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "private": true,
          "slug": "<string>",
          "url": "<string>",
          "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "gitAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "branch": "<string>",
          "rootDir": "<string>"
        }
      },
      "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",
        "projectCount": 1,
        "memberCount": 1,
        "inviteCount": 1,
        "periodStartDate": "2023-11-07T05:31:56Z",
        "periodEndDate": "2023-11-07T05:31:56Z",
        "status": "active",
        "wildcardDomains": [
          "<string>"
        ],
        "monthlyUsage": [
          {
            "monthYear": "2023-12-25",
            "predictionCount": 1,
            "executionTimeMs": 1
          }
        ],
        "samlOnlyAccess": true
      },
      "dateLastPolled": "2023-11-07T05:31:56Z",
      "totalRecordsCount": 1000,
      "dataBackend": {
        "backendType": "bigquery",
        "bigqueryConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "my-project",
        "datasetId": "my-dataset",
        "tableId": "my-table",
        "partitionType": "DAY"
      }
    }
  ]
}

GET

projects

{projectId}

inference-pipelines

Python

from openlayer import Openlayer

client = Openlayer()
client.projects.inference_pipelines.list(
  project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "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"
      },
      "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",
        "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"
        },
        "description": "My project description.",
        "gitRepo": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "gitId": 123,
          "dateConnected": "2023-11-07T05:31:56Z",
          "dateUpdated": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "private": true,
          "slug": "<string>",
          "url": "<string>",
          "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "gitAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "branch": "<string>",
          "rootDir": "<string>"
        }
      },
      "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",
        "projectCount": 1,
        "memberCount": 1,
        "inviteCount": 1,
        "periodStartDate": "2023-11-07T05:31:56Z",
        "periodEndDate": "2023-11-07T05:31:56Z",
        "status": "active",
        "wildcardDomains": [
          "<string>"
        ],
        "monthlyUsage": [
          {
            "monthYear": "2023-12-25",
            "predictionCount": 1,
            "executionTimeMs": 1
          }
        ],
        "samlOnlyAccess": true
      },
      "dateLastPolled": "2023-11-07T05:31:56Z",
      "totalRecordsCount": 1000,
      "dataBackend": {
        "backendType": "bigquery",
        "bigqueryConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "my-project",
        "datasetId": "my-dataset",
        "tableId": "my-table",
        "partitionType": "DAY"
      }
    }
  ]
}

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

projectId

string<uuid>

required

The project id.

Query Parameters

page

integer

default:1

The page to return in a paginated query.

Required range: x >= 1

perPage

integer

default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100

name

string

Filter list of items by name.

Response

Status OK.

items

object[]

required

Show child attributes

items.id

string<uuid>

required

The inference pipeline id.

Example:

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

items.projectId

string<uuid>

required

The project id.

Example:

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

items.name

string

required

The inference pipeline name.

Maximum string length: 100

Example:

"production"

items.dateCreated

string<date-time>

required

The creation date.

Example:

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

items.dateUpdated

string<date-time>

required

The last updated date.

Example:

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

items.dateLastSampleReceived

string<date-time> | null

required

The last data sample received date.

Example:

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

items.description

string | null

required

The inference pipeline description.

Maximum string length: 500

Example:

"This pipeline is used for production."

items.dateLastEvaluated

string<date-time> | null

required

The last test evaluation date.

Example:

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

items.dateOfNextEvaluation

string<date-time> | null

required

The next test evaluation date.

Example:

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

items.passingGoalCount

integer

required

The number of tests passing.

Required range: x >= 0

Example:

5

items.failingGoalCount

integer

required

The number of tests failing.

Required range: x >= 0

Example:

1

items.totalGoalCount

integer

required

The total number of tests.

Required range: x >= 0

Example:

6

items.status

enum<string>

required

The status of test evaluation for the inference pipeline.

Available options:

queued,

running,

paused,

failed,

completed,

unknown

Example:

"completed"

items.statusMessage

string | null

required

The status message of test evaluation for the inference pipeline.

Example:

"Tests successfully evaluated"

items.links

object

required

Show child attributes

items.links.app

string

required

Example:

"https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6/inference-pipeline/3fa85f64-5717-4562-b3fc-2c963f66afa6"

items.workspaceId

string<uuid>

The workspace id.

Example:

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

items.project

object

Show child attributes

items.project.id

string<uuid>

required

The project id.

Example:

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

items.project.workspaceId

string<uuid> | null

required

The workspace id.

Example:

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

items.project.creatorId

string<uuid> | null

required

The project creator id.

Example:

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

items.project.name

string

required

The project name.

Maximum string length: 64

Example:

"My Project"

items.project.dateCreated

string<date-time>

required

The project creation date.

Example:

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

items.project.dateUpdated

string<date-time>

required

The project last updated date.

Example:

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

items.project.source

enum<string> | null

required

The source of the project.

Available options:

web,

api,

null

items.project.taskType

enum<string>

required

The task type of the project.

Available options:

llm-base,

tabular-classification,

tabular-regression,

text-classification

items.project.versionCount

integer

required

The number of versions (commits) in the project.

Required range: x >= 0

Example:

2

items.project.inferencePipelineCount

integer

required

The number of inference pipelines in the project.

Required range: x >= 0

Example:

1

items.project.goalCount

integer

required

The total number of tests in the project.

Required range: x >= 0

Example:

10

items.project.developmentGoalCount

integer

required

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

Required range: x >= 0

Example:

5

items.project.monitoringGoalCount

integer

required

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

Required range: x >= 0

Example:

5

items.project.links

object

required

Links to the project.

Show child attributes

items.project.links.app

string

required

Example:

"https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"

items.project.description

string | null

The project description.

Maximum string length: 280

Example:

"My project description."

items.project.gitRepo

object

Show child attributes

items.project.gitRepo.id

string<uuid>

required

items.project.gitRepo.gitId

integer

required

items.project.gitRepo.dateConnected

string<date-time>

required

items.project.gitRepo.dateUpdated

string<date-time>

required

items.project.gitRepo.name

string

required

items.project.gitRepo.private

boolean

required

items.project.gitRepo.slug

string

required

items.project.gitRepo.url

string<url>

required

items.project.gitRepo.projectId

string<uuid>

required

items.project.gitRepo.gitAccountId

string<uuid>

required

items.project.gitRepo.branch

string

items.project.gitRepo.rootDir

string

items.workspace

object

Show child attributes

items.workspace.id

string<uuid>

required

The workspace id.

items.workspace.name

string

required

The workspace name.

Maximum string length: 80

Example:

"Openlayer"

items.workspace.slug

string

required

The workspace slug.

Maximum string length: 32

Example:

"openlayer"

items.workspace.dateCreated

string<date-time>

required

The workspace creation date.

items.workspace.dateUpdated

string<date-time>

required

The workspace last updated date.

items.workspace.creatorId

string<uuid> | null

required

The workspace creator id.

items.workspace.projectCount

integer

required

The number of projects in the workspace.

Required range: x >= 0

items.workspace.memberCount

integer

required

The number of members in the workspace.

Required range: x >= 0

items.workspace.inviteCount

integer

required

The number of invites in the workspace.

Required range: x >= 0

items.workspace.periodStartDate

string<date-time> | null

required

The start date of the current billing period.

items.workspace.periodEndDate

string<date-time> | null

required

The end date of the current billing period.

items.workspace.status

enum<string>

required

Available options:

active,

past_due,

unpaid,

canceled,

incomplete,

incomplete_expired,

trialing,

paused

items.workspace.wildcardDomains

string[]

items.workspace.monthlyUsage

object[]

Show child attributes

items.workspace.monthlyUsage.monthYear

string<date>

items.workspace.monthlyUsage.predictionCount

integer

Required range: x >= 0

items.workspace.monthlyUsage.executionTimeMs

integer | null

Required range: x >= 0

items.workspace.samlOnlyAccess

boolean

Whether the workspace only allows SAML authentication.

items.dateLastPolled

string<date-time> | null

The last time the data was polled.

items.totalRecordsCount

integer | null

The total number of records in the data backend.

Required range: x >= 0

Example:

1000

items.dataBackend

object

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6

Show child attributes

items.dataBackend.backendType

enum<string>

required

Available options:

bigquery

items.dataBackend.bigqueryConnectionId

string<uuid> | null

required

items.dataBackend.projectId

string

required

Maximum string length: 120

Example:

"my-project"

items.dataBackend.datasetId

string

required

Maximum string length: 120

Example:

"my-dataset"

items.dataBackend.tableId

string | null

required

Maximum string length: 120

Example:

"my-table"

items.dataBackend.partitionType

enum<string> | null

Available options:

DAY,

MONTH,

YEAR

Create data source

Retrieve data source

⌘I

Reference

SDKs

CLI

REST API

Authorizations

Path Parameters

Query Parameters

Response