List project commits

Python

from openlayer import Openlayer

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

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateCreated": "2024-03-22T11:31:01.185Z",
      "status": "completed",
      "statusMessage": "Commit successfully processed.",
      "projectId": "<unknown>",
      "commit": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "authorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
        "fileSize": 1024,
        "message": "Updated the prompt.",
        "mlModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "validationDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "trainingDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "storageUri": "s3://...",
        "dateCreated": "2024-03-22T11:31:01.185Z",
        "gitCommitSha": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "gitCommitRef": "main",
        "gitCommitUrl": "<string>"
      },
      "mlModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "validationDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "trainingDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateArchived": "2024-03-22T11:31:01.185Z",
      "passingGoalCount": 5,
      "failingGoalCount": 1,
      "totalGoalCount": 6,
      "deploymentStatus": "Deployed",
      "archived": false,
      "links": {
        "app": "https://app.openlayer.com/myWorkspace/3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    }
  ]
}

Python

from openlayer import Openlayer

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

{
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateCreated": "2024-03-22T11:31:01.185Z",
      "status": "completed",
      "statusMessage": "Commit successfully processed.",
      "projectId": "<unknown>",
      "commit": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "authorId": "589ece63-49a2-41b4-98e1-10547761d4b0",
        "fileSize": 1024,
        "message": "Updated the prompt.",
        "mlModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "validationDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "trainingDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "storageUri": "s3://...",
        "dateCreated": "2024-03-22T11:31:01.185Z",
        "gitCommitSha": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "gitCommitRef": "main",
        "gitCommitUrl": "<string>"
      },
      "mlModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "validationDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "trainingDatasetId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "dateArchived": "2024-03-22T11:31:01.185Z",
      "passingGoalCount": 5,
      "failingGoalCount": 1,
      "totalGoalCount": 6,
      "deploymentStatus": "Deployed",
      "archived": false,
      "links": {
        "app": "https://app.openlayer.com/myWorkspace/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

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

Response

Status OK.

items

object[]

required

Show child attributes

items.id

string<uuid>

required

The project version (commit) id.

Example:

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

items.dateCreated

string<date-time>

required

The project version (commit) creation date.

Example:

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

items.status

enum<string>

required

The commit status. Initially, the commit is queued, then, it switches to running. Finally, it can be paused, failed, or completed.

Available options:

queued,

running,

paused,

failed,

completed,

unknown

Example:

"completed"

items.statusMessage

string | null

required

The commit status message.

Example:

"Commit successfully processed."

items.projectId

any

required

items.commit

object

required

The details of a commit (project version).

Show child attributes

items.commit.id

string<uuid>

required

The commit id.

Example:

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

items.commit.authorId

string<uuid>

required

The author id of the commit.

Example:

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

items.commit.fileSize

integer | null

required

The size of the commit bundle in bytes.

Example:

1024

items.commit.message

string

required

The commit message.

Example:

"Updated the prompt."

items.commit.mlModelId

string<uuid> | null

required

The model id.

Example:

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

items.commit.validationDatasetId

string<uuid> | null

required

The validation dataset id.

Example:

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

items.commit.trainingDatasetId

string<uuid> | null

required

The training dataset id.

Example:

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

items.commit.storageUri

string

required

The storage URI where the commit bundle is stored.

Example:

"s3://..."

items.commit.dateCreated

string<date-time>

The commit creation date.

Example:

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

items.commit.gitCommitSha

integer

The SHA of the corresponding git commit.

Example:

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

items.commit.gitCommitRef

string

The ref of the corresponding git commit.

Example:

"main"

items.commit.gitCommitUrl

string

The URL of the corresponding git commit.

items.mlModelId

string<uuid> | null

required

The model id.

Example:

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

items.validationDatasetId

string<uuid> | null

required

The validation dataset id.

Example:

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

items.trainingDatasetId

string<uuid> | null

required

The training dataset id.

Example:

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

items.dateArchived

string<date-time> | null

required

The commit archive date.

Example:

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

items.passingGoalCount

integer

required

The number of tests that are passing for the commit.

Required range: x >= 0

Example:

5

items.failingGoalCount

integer

required

The number of tests that are failing for the commit.

Required range: x >= 0

Example:

1

items.totalGoalCount

integer

required

The total number of tests for the commit.

Required range: x >= 0

Example:

6

items.deploymentStatus

string

The deployment status associated with the commit's model.

Maximum string length: 30

Example:

"Deployed"

items.archived

boolean | null

Whether the commit is archived.

Example:

false

items.links

object

Show child attributes

items.links.app

string

required

Example:

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

Retrieve project commit

⌘I

Reference

SDKs

CLI

REST API

List project commits

Authorizations

Path Parameters

Query Parameters

Response