scorable.score_configs

Classes

ScoreConfigs

Score configs API.

Module Contents

class scorable.score_configs.ScoreConfigs(client_context: scorable.utils.ClientContextCallable)

Score configs API.

A score config describes the label scale used when annotating and calibrating: binary, continuous or categorical. Your organization’s own configs are returned alongside the read-only public globals (the identity “Score” config and “Thumbs”).

Note

The construction of the API instance should be handled by accessing an attribute of a scorable.client.Scorable instance.

Parameters:

client_context (scorable.utils.ClientContextCallable)

async acreate(*, name: str, type: str, categories: List[dict[str, Any]] | None = None, min_value: float | None = None, max_value: float | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.score_config.ScoreConfig

Asynchronously create a score config.

Parameters:

  • name (str)

  • type (str)

  • categories (Optional[List[dict[str, Any]]])

  • min_value (Optional[float])

  • max_value (Optional[float])

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.score_config.ScoreConfig

async adelete(score_config_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → None

Asynchronously delete a score config.

Parameters:

  • score_config_id (str)

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_aclient.ApiClient)

Return type:

None

async aget(score_config_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.score_config.ScoreConfig

Asynchronously get a score config by ID.

Parameters:

  • score_config_id (str)

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.score_config.ScoreConfig

async alist(*, limit: int = 100) → AsyncIterator[scorable.generated.openapi_aclient.models.score_config.ScoreConfig]

Asynchronously iterate through the score configs.

Parameters:

limit (int)

Return type:

AsyncIterator[scorable.generated.openapi_aclient.models.score_config.ScoreConfig]

async aupdate(score_config_id: str, *, name: str | None = None, type: str | None = None, categories: List[dict[str, Any]] | None = None, min_value: float | None = None, max_value: float | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.score_config.ScoreConfig

Asynchronously update a score config.

Parameters:

  • score_config_id (str)

  • name (Optional[str])

  • type (Optional[str])

  • categories (Optional[List[dict[str, Any]]])

  • min_value (Optional[float])

  • max_value (Optional[float])

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.score_config.ScoreConfig

create(*, name: str, type: str, categories: List[dict[str, Any]] | None = None, min_value: float | None = None, max_value: float | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → scorable.generated.openapi_client.models.score_config.ScoreConfig

Create a score config.

Parameters:

  • name (str) – Human-readable name.

  • type (str) – One of binary, continuous or categorical.

  • categories (Optional[List[dict[str, Any]]]) – For binary/categorical configs, a list of {"label": ..., "value": ...}.

  • min_value (Optional[float]) – For continuous configs, the lower bound (defaults to 0).

  • max_value (Optional[float]) – For continuous configs, the upper bound (defaults to 1).

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.score_config.ScoreConfig

delete(score_config_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → None

Delete a score config.

Parameters:

  • score_config_id (str)

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

None

get(score_config_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → scorable.generated.openapi_client.models.score_config.ScoreConfig

Get a score config by ID.

Parameters:

  • score_config_id (str)

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.score_config.ScoreConfig

list(*, limit: int = 100, _client: scorable.generated.openapi_client.ApiClient) → Iterator[scorable.generated.openapi_client.models.score_config.ScoreConfig]

Iterate through the score configs (your organization’s own plus public globals).

Parameters:

  • limit (int)

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

Iterator[scorable.generated.openapi_client.models.score_config.ScoreConfig]

update(score_config_id: str, *, name: str | None = None, type: str | None = None, categories: List[dict[str, Any]] | None = None, min_value: float | None = None, max_value: float | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.ApiClient) → scorable.generated.openapi_client.models.score_config.ScoreConfig

Update a score config. Public globals are read-only.

Parameters:

  • score_config_id (str)

  • name (Optional[str])

  • type (Optional[str])

  • categories (Optional[List[dict[str, Any]]])

  • min_value (Optional[float])

  • max_value (Optional[float])

  • _request_timeout (Optional[int])

  • _client (scorable.generated.openapi_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.score_config.ScoreConfig

client_context