api.md

Shared Types

from scorecard_ai.types import APIError

Projects

Types:

from scorecard_ai.types import Project

Methods:

• client.projects.create(**params) -> Project
• client.projects.list(**params) -> SyncPaginatedResponse[Project]

Testsets

Types:

from scorecard_ai.types import Testset, TestsetDeleteResponse

Methods:

• client.testsets.create(project_id, **params) -> Testset
• client.testsets.update(testset_id, **params) -> Testset
• client.testsets.list(project_id, **params) -> SyncPaginatedResponse[Testset]
• client.testsets.delete(testset_id) -> TestsetDeleteResponse
• client.testsets.get(testset_id) -> Testset

Testcases

Types:

from scorecard_ai.types import Testcase, TestcaseCreateResponse, TestcaseDeleteResponse

Methods:

• client.testcases.create(testset_id, **params) -> TestcaseCreateResponse
• client.testcases.update(testcase_id, **params) -> Testcase
• client.testcases.list(testset_id, **params) -> SyncPaginatedResponse[Testcase]
• client.testcases.delete(**params) -> TestcaseDeleteResponse
• client.testcases.get(testcase_id) -> Testcase

Runs

Types:

from scorecard_ai.types import Run

Methods:

• client.runs.create(project_id, **params) -> Run
• client.runs.list(project_id, **params) -> SyncPaginatedResponse[Run]
• client.runs.get(run_id) -> Run

Metrics

Types:

from scorecard_ai.types import Metric, MetricDeleteResponse

Methods:

• client.metrics.create(project_id, **params) -> Metric
• client.metrics.update(metric_id, **params) -> Metric
• client.metrics.list(project_id, **params) -> SyncPaginatedResponse[Metric]
• client.metrics.delete(metric_id) -> MetricDeleteResponse
• client.metrics.get(metric_id) -> Metric

Records

Types:

from scorecard_ai.types import Record, RecordListResponse, RecordDeleteResponse

Methods:

• client.records.create(run_id, **params) -> Record
• client.records.list(run_id, **params) -> SyncPaginatedResponse[RecordListResponse]
• client.records.delete(record_id) -> RecordDeleteResponse

Annotations

Types:

from scorecard_ai.types.records import Annotation, AnnotationListResponse

Methods:

• client.records.annotations.list(record_id) -> AnnotationListResponse

Tags

Types:

from scorecard_ai.types.records import RecordTag, TagListResponse, TagDeleteResponse

Methods:

• client.records.tags.create(record_id, **params) -> RecordTag
• client.records.tags.list(record_id) -> TagListResponse
• client.records.tags.delete(text, *, record_id) -> TagDeleteResponse

Assignees

Types:

from scorecard_ai.types.records import (
    RecordAssignment,
    AssigneeListResponse,
    AssigneeDeleteResponse,
)

Methods:

• client.records.assignees.create(record_id, **params) -> RecordAssignment
• client.records.assignees.list(record_id) -> AssigneeListResponse
• client.records.assignees.delete(assignee_user_id, *, record_id) -> AssigneeDeleteResponse

Scores

Types:

from scorecard_ai.types import Score

Methods:

• client.scores.upsert(metric_config_id, *, record_id, **params) -> Score

Attachments

Types:

from scorecard_ai.types import (
    Attachment,
    AttachmentDeleteResponse,
    AttachmentGetResponse,
    AttachmentInitiateResponse,
)

Methods:

• client.attachments.list(session_id, **params) -> SyncPaginatedResponse[Attachment]
• client.attachments.delete(attachment_id) -> AttachmentDeleteResponse
• client.attachments.commit(attachment_id) -> Attachment
• client.attachments.get(attachment_id) -> AttachmentGetResponse
• client.attachments.initiate(**params) -> AttachmentInitiateResponse

Systems

Types:

from scorecard_ai.types import System, SystemDeleteResponse

Methods:

• client.systems.update(system_id, **params) -> System
• client.systems.list(project_id, **params) -> SyncPaginatedResponse[System]
• client.systems.delete(system_id) -> SystemDeleteResponse
• client.systems.get(system_id) -> System
• client.systems.upsert(project_id, **params) -> System

Versions

Types:

from scorecard_ai.types.systems import SystemVersion

Methods:

• client.systems.versions.get(system_version_id) -> SystemVersion
• client.systems.versions.upsert(system_id, **params) -> SystemVersion