api.md

Projects

Types:

from openlayer.types import ProjectCreateResponse, ProjectUpdateResponse, ProjectListResponse

Methods:

• client.projects.create(**params) -> ProjectCreateResponse
• client.projects.update(project_id, **params) -> ProjectUpdateResponse
• client.projects.list(**params) -> ProjectListResponse
• client.projects.delete(project_id) -> None

Commits

Types:

from openlayer.types.projects import CommitCreateResponse, CommitListResponse

Methods:

• client.projects.commits.create(project_id, **params) -> CommitCreateResponse
• client.projects.commits.list(project_id, **params) -> CommitListResponse

InferencePipelines

Types:

from openlayer.types.projects import InferencePipelineCreateResponse, InferencePipelineListResponse

Methods:

• client.projects.inference_pipelines.create(project_id, **params) -> InferencePipelineCreateResponse
• client.projects.inference_pipelines.list(project_id, **params) -> InferencePipelineListResponse

Tests

Types:

from openlayer.types.projects import TestCreateResponse, TestUpdateResponse, TestListResponse

Methods:

• client.projects.tests.create(project_id, **params) -> TestCreateResponse
• client.projects.tests.update(project_id, **params) -> TestUpdateResponse
• client.projects.tests.list(project_id, **params) -> TestListResponse

Workspaces

Types:

from openlayer.types import WorkspaceRetrieveResponse, WorkspaceUpdateResponse

Methods:

• client.workspaces.retrieve(workspace_id) -> WorkspaceRetrieveResponse
• client.workspaces.update(workspace_id, **params) -> WorkspaceUpdateResponse

Invites

Types:

from openlayer.types.workspaces import InviteCreateResponse, InviteListResponse

Methods:

• client.workspaces.invites.create(workspace_id, **params) -> InviteCreateResponse
• client.workspaces.invites.list(workspace_id, **params) -> InviteListResponse

APIKeys

Types:

from openlayer.types.workspaces import APIKeyCreateResponse

Methods:

• client.workspaces.api_keys.create(workspace_id, **params) -> APIKeyCreateResponse

Commits

Types:

from openlayer.types import CommitRetrieveResponse

Methods:

• client.commits.retrieve(project_version_id) -> CommitRetrieveResponse

TestResults

Types:

from openlayer.types.commits import TestResultListResponse

Methods:

• client.commits.test_results.list(project_version_id, **params) -> TestResultListResponse

InferencePipelines

Types:

from openlayer.types import (
    InferencePipelineRetrieveResponse,
    InferencePipelineUpdateResponse,
    InferencePipelineRetrieveSessionsResponse,
    InferencePipelineRetrieveUsersResponse,
)

Methods:

• client.inference_pipelines.retrieve(inference_pipeline_id, **params) -> InferencePipelineRetrieveResponse
• client.inference_pipelines.update(inference_pipeline_id, **params) -> InferencePipelineUpdateResponse
• client.inference_pipelines.delete(inference_pipeline_id) -> None
• client.inference_pipelines.retrieve_sessions(inference_pipeline_id, **params) -> InferencePipelineRetrieveSessionsResponse
• client.inference_pipelines.retrieve_users(inference_pipeline_id, **params) -> InferencePipelineRetrieveUsersResponse

Data

Types:

from openlayer.types.inference_pipelines import DataStreamResponse

Methods:

• client.inference_pipelines.data.stream(inference_pipeline_id, **params) -> DataStreamResponse

Rows

Types:

from openlayer.types.inference_pipelines import (
    RowRetrieveResponse,
    RowUpdateResponse,
    RowListResponse,
)

Methods:

• client.inference_pipelines.rows.retrieve(inference_id, *, inference_pipeline_id) -> RowRetrieveResponse
• client.inference_pipelines.rows.update(inference_pipeline_id, **params) -> RowUpdateResponse
• client.inference_pipelines.rows.list(inference_pipeline_id, **params) -> RowListResponse
• client.inference_pipelines.rows.delete(inference_id, *, inference_pipeline_id) -> None

TestResults

Types:

from openlayer.types.inference_pipelines import TestResultListResponse

Methods:

• client.inference_pipelines.test_results.list(inference_pipeline_id, **params) -> TestResultListResponse

Storage

PresignedURL

Types:

from openlayer.types.storage import PresignedURLCreateResponse, PresignedURLRetrieveResponse

Methods:

• client.storage.presigned_url.create(**params) -> PresignedURLCreateResponse
• client.storage.presigned_url.retrieve(**params) -> PresignedURLRetrieveResponse

Tests

Types:

from openlayer.types import TestEvaluateResponse, TestListResultsResponse

Methods:

• client.tests.evaluate(test_id, **params) -> TestEvaluateResponse
• client.tests.list_results(test_id, **params) -> TestListResultsResponse

BackgroundTasks

Types:

from openlayer.types import BackgroundTaskRetrieveResponse

Methods:

• client.background_tasks.retrieve(task_id) -> BackgroundTaskRetrieveResponse

Governance

Frameworks

Types:

from openlayer.types.governance import (
    FrameworkCreateResponse,
    FrameworkRetrieveResponse,
    FrameworkUpdateResponse,
    FrameworkListResponse,
    FrameworkExportResponse,
    FrameworkListProjectRuleStatsResponse,
    FrameworkListProjectsResponse,
    FrameworkListRulesResponse,
)

Methods:

• client.governance.frameworks.create(workspace_id, **params) -> FrameworkCreateResponse
• client.governance.frameworks.retrieve(framework_id) -> FrameworkRetrieveResponse
• client.governance.frameworks.update(framework_id, **params) -> FrameworkUpdateResponse
• client.governance.frameworks.list(workspace_id, **params) -> FrameworkListResponse
• client.governance.frameworks.export(framework_id, **params) -> FrameworkExportResponse
• client.governance.frameworks.list_project_rule_stats(framework_id, **params) -> FrameworkListProjectRuleStatsResponse
• client.governance.frameworks.list_projects(framework_id, **params) -> FrameworkListProjectsResponse
• client.governance.frameworks.list_rules(framework_id, **params) -> FrameworkListRulesResponse

Documents

Types:

from openlayer.types.governance.frameworks import DocumentRetrieveResponse, DocumentListResponse

Methods:

• client.governance.frameworks.documents.retrieve(document_id, *, framework_id) -> DocumentRetrieveResponse
• client.governance.frameworks.documents.list(framework_id, **params) -> DocumentListResponse

Sections

Types:

from openlayer.types.governance.frameworks import SectionListRulesResponse

Methods:

• client.governance.frameworks.sections.list_rules(section_id, *, framework_id, **params) -> SectionListRulesResponse

Subsections

Types:

from openlayer.types.governance.frameworks import SubsectionListRulesResponse

Methods:

• client.governance.frameworks.subsections.list_rules(subsection_id, *, framework_id, **params) -> SubsectionListRulesResponse

Rules

Types:

from openlayer.types.governance import (
    RuleCreateResponse,
    RuleRetrieveResponse,
    RuleUpdateResponse,
    RuleListResponse,
)

Methods:

• client.governance.rules.create(workspace_id, **params) -> RuleCreateResponse
• client.governance.rules.retrieve(rule_id) -> RuleRetrieveResponse
• client.governance.rules.update(rule_id, **params) -> RuleUpdateResponse
• client.governance.rules.list(workspace_id, **params) -> RuleListResponse
• client.governance.rules.delete(rule_id) -> None

RuleResults

Types:

from openlayer.types.governance import (
    RuleResultRetrieveResponse,
    RuleResultUpdateResponse,
    RuleResultListResponse,
    RuleResultCreateEvidenceResponse,
    RuleResultListEvidenceResponse,
)

Methods:

• client.governance.rule_results.retrieve(rule_result_id) -> RuleResultRetrieveResponse
• client.governance.rule_results.update(rule_result_id, **params) -> RuleResultUpdateResponse
• client.governance.rule_results.list(workspace_id, **params) -> RuleResultListResponse
• client.governance.rule_results.create_evidence(rule_result_id, **params) -> RuleResultCreateEvidenceResponse
• client.governance.rule_results.list_evidence(rule_result_id, **params) -> RuleResultListEvidenceResponse

RuleStats

Types:

from openlayer.types.governance import RuleStatRetrieveResponse

Methods:

• client.governance.rule_stats.retrieve(workspace_id, **params) -> RuleStatRetrieveResponse

RuleTags

Types:

from openlayer.types.governance import RuleTagListResponse

Methods:

• client.governance.rule_tags.list(workspace_id, **params) -> RuleTagListResponse