plexus.dashboard.api.models package

class plexus.dashboard.api.models.Account(id: str, name: str, key: str, description: str | None = None, settings: Dict | None = None, client: _BaseAPIClient | None = None)

Bases: BaseModel

Account model for interacting with the API.

__init__(id: str, name: str, key: str, description: str | None = None, settings: Dict | None = None, client: _BaseAPIClient | None = None)
description: str | None = None
classmethod fields() → str

Return the GraphQL fields to query for this model

classmethod from_dict(data: Dict[str, Any], client: _BaseAPIClient) → Account

Create an Account instance from a dictionary.

classmethod get_by_id(id: str, client: _BaseAPIClient) → Account

Get an account by its ID.

classmethod get_by_key(key: str, client: _BaseAPIClient) → Account | None

Get an account by its key.

Args:

key: The account key to look up client: The API client instance

Returns:

Account: The found account or None

key: str
classmethod list_by_key(client: _BaseAPIClient, key: str) → Account | None

Get an account by its key.

Args:

client: The API client instance key: The account key to look up

Returns:

Account: The found account or None

name: str
settings: Dict | None = None
update(**kwargs) → Account

Update the account.

class plexus.dashboard.api.models.Evaluation(id: str, type: str, accountId: str, status: str, createdAt: datetime.datetime, updatedAt: datetime.datetime, client: plexus.dashboard.api.client._BaseAPIClient | None = None, parameters: Dict | None = None, metrics: Dict | None = None, inferences: int | None = None, accuracy: float | None = None, cost: float | None = None, startedAt: datetime.datetime | None = None, elapsedSeconds: int | None = None, estimatedRemainingSeconds: int | None = None, totalItems: int | None = None, processedItems: int | None = None, errorMessage: str | None = None, errorDetails: Dict | None = None, scorecardId: str | None = None, scoreId: str | None = None, confusionMatrix: Dict | None = None, scoreGoal: str | None = None, datasetClassDistribution: Dict | None = None, isDatasetClassDistributionBalanced: bool | None = None, predictedClassDistribution: Dict | None = None, isPredictedClassDistributionBalanced: bool | None = None, taskId: str | None = None)

Bases: BaseModel

__init__(id: str, type: str, accountId: str, status: str, createdAt: datetime, updatedAt: datetime, client: _BaseAPIClient | None = None, parameters: Dict | None = None, metrics: Dict | None = None, inferences: int | None = None, accuracy: float | None = None, cost: float | None = None, startedAt: datetime | None = None, elapsedSeconds: int | None = None, estimatedRemainingSeconds: int | None = None, totalItems: int | None = None, processedItems: int | None = None, errorMessage: str | None = None, errorDetails: Dict | None = None, scorecardId: str | None = None, scoreId: str | None = None, confusionMatrix: Dict | None = None, scoreGoal: str | None = None, datasetClassDistribution: Dict | None = None, isDatasetClassDistributionBalanced: bool | None = None, predictedClassDistribution: Dict | None = None, isPredictedClassDistributionBalanced: bool | None = None, taskId: str | None = None)
accountId: str
accuracy: float | None = None
confusionMatrix: Dict | None = None
cost: float | None = None
classmethod create(client: _BaseAPIClient, type: str, accountId: str, *, status: str = 'PENDING', scorecardId: str | None = None, scoreId: str | None = None, taskId: str | None = None, **kwargs) → Evaluation

Create a new Evaluation.

createdAt: datetime
datasetClassDistribution: Dict | None = None
elapsedSeconds: int | None = None
errorDetails: Dict | None = None
errorMessage: str | None = None
estimatedRemainingSeconds: int | None = None
classmethod fields() → str

Fields to request in queries and mutations

classmethod from_dict(data: Dict[str, Any], client: _BaseAPIClient) → Evaluation

Create an instance from a dictionary of data

classmethod get_by_id(id: str, client: _BaseAPIClient, include_score_results: bool = False) → Evaluation
inferences: int | None = None
isDatasetClassDistributionBalanced: bool | None = None
isPredictedClassDistributionBalanced: bool | None = None
metrics: Dict | None = None
parameters: Dict | None = None
predictedClassDistribution: Dict | None = None
processedItems: int | None = None
scoreGoal: str | None = None
scoreId: str | None = None
scorecardId: str | None = None
startedAt: datetime | None = None
status: str
taskId: str | None = None
totalItems: int | None = None
type: str
update(**kwargs) → None

Update Evaluation fields in a background thread.

This is a non-blocking operation - the mutation is performed in a background thread.

Args:

**kwargs: Fields to update

updatedAt: datetime
class plexus.dashboard.api.models.Score(id: str, name: str, key: str, externalId: str, type: str, order: int, sectionId: str, accuracy: float | None = None, version: str | None = None, aiProvider: str | None = None, aiModel: str | None = None, isFineTuned: bool | None = None, configuration: Dict | None = None, distribution: Dict | None = None, versionHistory: Dict | None = None, client: plexus.dashboard.api.client._BaseAPIClient | None = None)

Bases: BaseModel

__init__(id: str, name: str, key: str, externalId: str, type: str, order: int, sectionId: str, accuracy: float | None = None, version: str | None = None, aiProvider: str | None = None, aiModel: str | None = None, isFineTuned: bool | None = None, configuration: Dict | None = None, distribution: Dict | None = None, versionHistory: Dict | None = None, client: _BaseAPIClient | None = None)
accuracy: float | None = None
aiModel: str | None = None
aiProvider: str | None = None
configuration: Dict | None = None
distribution: Dict | None = None
externalId: str
classmethod fields() → str

Return the GraphQL fields to query for this model

classmethod from_dict(data: Dict[str, Any], client: _BaseAPIClient) → Score

Create an instance from a dictionary of data

classmethod get_by_external_id(external_id: str, scorecard_id: str, client: _BaseAPIClient) → Score | None

Get a score by its external ID

classmethod get_by_id(id: str, client: _BaseAPIClient) → Score
classmethod get_by_key(key: str, scorecard_id: str, client: _BaseAPIClient) → Score | None

Get a score by its key

classmethod get_by_name(name: str, scorecard_id: str, client: _BaseAPIClient) → Score | None

Get a score by its name

isFineTuned: bool | None = None
key: str
classmethod list_by_section_id(section_id: str, client: _BaseAPIClient, next_token: str | None = None, limit: int = 100) → Dict[str, Any]

Get all scores for a section with pagination support

Returns:
Dict containing:

  • items: List of Score objects

  • nextToken: Token for next page if more results exist

name: str
order: int
sectionId: str
type: str
version: str | None = None
versionHistory: Dict | None = None
class plexus.dashboard.api.models.Scorecard(id: str, name: str, key: str, externalId: str, accountId: str, description: str | None = None, client: plexus.dashboard.api.client._BaseAPIClient | None = None)

Bases: BaseModel

__init__(id: str, name: str, key: str, externalId: str, accountId: str, description: str | None = None, client: _BaseAPIClient | None = None)
accountId: str
classmethod create(client: _BaseAPIClient, name: str, key: str, externalId: str, accountId: str, description: str | None = None) → Scorecard

Create a new scorecard.

Args:

client: The API client name: Name of the scorecard key: Unique key identifier externalId: External ID (usually from YAML) accountId: ID of the account this scorecard belongs to description: Optional description

Returns:

The created Scorecard instance

description: str | None = None
externalId: str
classmethod fields() → str

Return the GraphQL fields to query for this model

classmethod from_dict(data: Dict[str, Any], client: _BaseAPIClient) → Scorecard

Create an instance from a dictionary of data

classmethod get_by_external_id(external_id: str, client: _BaseAPIClient) → Scorecard
classmethod get_by_id(id: str, client: _BaseAPIClient) → Scorecard
classmethod get_by_key(key: str, client: _BaseAPIClient) → Scorecard
classmethod get_by_name(name: str, client: _BaseAPIClient) → Scorecard
key: str
name: str

Submodules