Create data source

Python

from openlayer import Openlayer

client = Openlayer()
inference_pipeline = client.projects.inference_pipelines.create(
  project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  name="production",
  description="My production inference pipeline.",
)

import Openlayer from 'openlayer';

const openlayer = new Openlayer();
const inferencePipelineCreateResponse = await openlayer.projects.inferencePipelines.create(
  {
    projectId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    name: 'production'
    description: 'My production inference pipeline.',
  },
);

package main

import (
  "context"

  "github.com/openlayer-ai/openlayer-go"
  "github.com/openlayer-ai/openlayer-go/option"
)

client := openlayer.NewClient()
inferencePipeline, err := client.Projects.InferencePipelines.New(
  context.TODO(),
  projectId: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  openlayer.ProjectInferencePipelineNewParams{
    Description: openlayer.F("My production inference pipeline."),
    Name: openlayer.F("production"),
  },
)
if err != nil {
  panic(err.Error())
}

import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
import com.openlayer.api.models.ProjectInferencePipelineListParams;
import com.openlayer.api.models.ProjectInferencePipelineListResponse;

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

ProjectInferencePipelineCreateParams params = ProjectInferencePipelineCreateParams.builder()
    .projectId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .name("production")
    .description("My production inference pipeline.")
    .build();

ProjectInferencePipelineCreateResponse response = client.projects().inferencePipelines().create(params);

curl --request POST \
  --url https://api.openlayer.com/v1/projects/{projectId}/inference-pipelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "production",
  "description": "My production inference pipeline."
}'

{
  "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",
    "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",
    "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"
  }
}

{
  "code": 123,
  "error": "<string>"
}

Python

from openlayer import Openlayer

client = Openlayer()
inference_pipeline = client.projects.inference_pipelines.create(
  project_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  name="production",
  description="My production inference pipeline.",
)

import Openlayer from 'openlayer';

const openlayer = new Openlayer();
const inferencePipelineCreateResponse = await openlayer.projects.inferencePipelines.create(
  {
    projectId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
    name: 'production'
    description: 'My production inference pipeline.',
  },
);

package main

import (
  "context"

  "github.com/openlayer-ai/openlayer-go"
  "github.com/openlayer-ai/openlayer-go/option"
)

client := openlayer.NewClient()
inferencePipeline, err := client.Projects.InferencePipelines.New(
  context.TODO(),
  projectId: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  openlayer.ProjectInferencePipelineNewParams{
    Description: openlayer.F("My production inference pipeline."),
    Name: openlayer.F("production"),
  },
)
if err != nil {
  panic(err.Error())
}

import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
import com.openlayer.api.models.ProjectInferencePipelineListParams;
import com.openlayer.api.models.ProjectInferencePipelineListResponse;

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

ProjectInferencePipelineCreateParams params = ProjectInferencePipelineCreateParams.builder()
    .projectId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .name("production")
    .description("My production inference pipeline.")
    .build();

ProjectInferencePipelineCreateResponse response = client.projects().inferencePipelines().create(params);

curl --request POST \
  --url https://api.openlayer.com/v1/projects/{projectId}/inference-pipelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "production",
  "description": "My production inference pipeline."
}'

{
  "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",
    "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",
    "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"
  }
}

{
  "code": 123,
  "error": "<string>"
}

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.

Body

application/json

name

string

required

The inference pipeline name.

Maximum string length: 100

Example:

"production"

description

string | null

required

The inference pipeline description.

Maximum string length: 500

Example:

"This pipeline is used for production."

project

object | null

Show child attributes

workspace

object | null

Show child attributes

dataBackend

BigQueryDataBackend · object

Show child attributes

Response

Status OK.

string<uuid>

required

read-only

The inference pipeline id.

Example:

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

projectId

string<uuid>

required

read-only

The project id.

Example:

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

name

string

required

The inference pipeline name.

Maximum string length: 100

Example:

"production"

dateCreated

string<date-time>

required

read-only

The creation date.

Example:

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

dateUpdated

string<date-time>

required

read-only

The last updated date.

Example:

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

dateLastSampleReceived

string<date-time> | null

required

read-only

The last data sample received date.

Example:

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

description

string | null

required

The inference pipeline description.

Maximum string length: 500

Example:

"This pipeline is used for production."

dateLastEvaluated

string<date-time> | null

required

read-only

The last test evaluation date.

Example:

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

dateOfNextEvaluation

string<date-time> | null

required

read-only

The next test evaluation date.

Example:

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

passingGoalCount

integer

required

read-only

The number of tests passing.

Required range: x >= 0

Example:

5

failingGoalCount

integer

required

read-only

The number of tests failing.

Required range: x >= 0

Example:

1

totalGoalCount

integer

required

read-only

The total number of tests.

Required range: x >= 0

Example:

6

status

enum<string>

required

read-only

The status of test evaluation for the inference pipeline.

Available options:

queued,

running,

paused,

failed,

completed,

unknown

Example:

"completed"

statusMessage

string | null

required

read-only

The status message of test evaluation for the inference pipeline.

Example:

"Tests successfully evaluated"

links

object

required

read-only

Show child attributes

workspaceId

string<uuid>

read-only

The workspace id.

Example:

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

project

object | null

Show child attributes

workspace

object | null

Show child attributes

dateLastPolled

string<date-time> | null

read-only

The last time the data was polled.

totalRecordsCount

integer | null

read-only

The total number of records in the data backend.

Required range: x >= 0

Example:

1000

dataBackend

BigQueryDataBackend · object

Show child attributes

List commit test results

List data sources

⌘I

Reference

SDKs

CLI

REST API

Create data source

Authorizations

Path Parameters

Body

Response