scorable.datasets¶

Attributes¶

MAX_BULK_ITEMS

Classes¶

DataSets

DataSets (sub) API

Module Contents¶

class scorable.datasets.DataSets(client_context: scorable.utils.ClientContextCallable, base_url: str, api_key: str)¶

DataSets (sub) API

Note

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

Parameters:

client_context (scorable.utils.ClientContextCallable)
base_url (str)
api_key (str)

async aadd_item(dataset_id: str, *, response: str, request: str = '', expected_output: str = '', contexts: List[str] | None = None, variables: Dict[str, Any] | None = None, metadata: Dict[str, Any] | None = None, change_note: str = '', _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.dataset_item.DatasetItem¶

Asynchronously add a single item to a dataset.

Parameters:

dataset_id (str)
response (str)
request (str)
expected_output (str)
contexts (Optional[List[str]])
variables (Optional[Dict[str, Any]])
metadata (Optional[Dict[str, Any]])
change_note (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.dataset_item.DatasetItem

async aadd_items(dataset_id: str, items: List[Dict[str, Any]], *, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → List[scorable.generated.openapi_aclient.models.dataset_item.DatasetItem]¶

Asynchronously bulk add items to a dataset (at most 5000 per call).

Parameters:

dataset_id (str)
items (List[Dict[str, Any]])
_request_timeout (Optional[int])
_client (scorable.generated.openapi_aclient.ApiClient)

Return type:

List[scorable.generated.openapi_aclient.models.dataset_item.DatasetItem]

async aarchive_item(dataset_id: str, item_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → None¶

Asynchronously archive (soft-delete) a dataset item.

Parameters:

dataset_id (str)
item_id (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_aclient.ApiClient)

Return type:

None

Asynchronously create a dataset object with the given parameters to the registry. If the dataset has a path, it will be uploaded to the registry.

Parameters:

name (Optional[str])
path (Optional[str])
type (str)
project_id (Optional[str])
_request_timeout (Optional[int])

Return type:

Optional[scorable.generated.openapi_aclient.models.data_set_create.DataSetCreate]

add_item(dataset_id: str, *, response: str, request: str = '', expected_output: str = '', contexts: List[str] | None = None, variables: Dict[str, Any] | None = None, metadata: Dict[str, Any] | None = None, change_note: str = '', _request_timeout: int | None = None, _client: scorable.generated.openapi_client.api_client.ApiClient) → scorable.generated.openapi_client.models.dataset_item.DatasetItem¶

Add a single item to a dataset.

Parameters:

dataset_id (str)
response (str)
request (str)
expected_output (str)
contexts (Optional[List[str]])
variables (Optional[Dict[str, Any]])
metadata (Optional[Dict[str, Any]])
change_note (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.dataset_item.DatasetItem

add_items(dataset_id: str, items: List[Dict[str, Any]], *, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.api_client.ApiClient) → List[scorable.generated.openapi_client.models.dataset_item.DatasetItem]¶

Bulk add items to a dataset (at most 5000 per call).

Parameters:

dataset_id (str)
items (List[Dict[str, Any]])
_request_timeout (Optional[int])
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

List[scorable.generated.openapi_client.models.dataset_item.DatasetItem]

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

Asynchronously delete a dataset object from the registry.

Parameters:

dataset_id (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_aclient.ApiClient)

Return type:

None

async aget(dataset_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.data_set_list.DataSetList¶

Asynchronously get a dataset object from the registry.

Parameters:

dataset_id (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.data_set_list.DataSetList

async aget_item(dataset_id: str, item_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.dataset_item.DatasetItem¶

Asynchronously get a single dataset item.

Parameters:

dataset_id (str)
item_id (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.dataset_item.DatasetItem

async alist(search_term: str | None = None, *, limit: int = 100, project_id: str | None = None, _request_timeout: int | None = None) → AsyncIterator[scorable.generated.openapi_aclient.models.data_set_list.DataSetList]¶

Asynchronously iterate through the datasets.

Parameters:

limit (int) – Number of entries to iterate through at most.
search_term (Optional[str]) – Can be used to limit returned datasets.
project_id (Optional[str]) – Optional project filter.
_request_timeout (Optional[int])

Return type:

AsyncIterator[scorable.generated.openapi_aclient.models.data_set_list.DataSetList]

async alist_items(dataset_id: str, *, include_archived: bool = False, limit: int = 100) → AsyncIterator[scorable.generated.openapi_aclient.models.dataset_item.DatasetItem]¶

Asynchronously iterate through the items of a dataset.

Parameters:

dataset_id (str)
include_archived (bool)
limit (int)

Return type:

AsyncIterator[scorable.generated.openapi_aclient.models.dataset_item.DatasetItem]

archive_item(dataset_id: str, item_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.api_client.ApiClient) → None¶

Archive (soft-delete) a dataset item.

Parameters:

dataset_id (str)
item_id (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

None

async aupdate_item(dataset_id: str, item_id: str, *, response: str | None = None, request: str | None = None, expected_output: str | None = None, contexts: List[str] | None = None, variables: Dict[str, Any] | None = None, metadata: Dict[str, Any] | None = None, change_note: str | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_aclient.ApiClient) → scorable.generated.openapi_aclient.models.dataset_item.DatasetItem¶

Asynchronously edit a dataset item.

Parameters:

dataset_id (str)
item_id (str)
response (Optional[str])
request (Optional[str])
expected_output (Optional[str])
contexts (Optional[List[str]])
variables (Optional[Dict[str, Any]])
metadata (Optional[Dict[str, Any]])
change_note (Optional[str])
_request_timeout (Optional[int])
_client (scorable.generated.openapi_aclient.ApiClient)

Return type:

scorable.generated.openapi_aclient.models.dataset_item.DatasetItem

Create a dataset object with the given parameters to the registry. If the dataset has a path, it will be uploaded to the registry.

Parameters:

name (Optional[str])
path (Optional[str])
type (str)
project_id (Optional[str])
_request_timeout (Optional[int])

Return type:

Optional[scorable.generated.openapi_client.models.data_set_create.DataSetCreate]

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

Delete a dataset object from the registry.

Parameters:

dataset_id (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

None

get(dataset_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.api_client.ApiClient) → scorable.generated.openapi_client.models.data_set_list.DataSetList¶

Get a dataset object from the registry.

Parameters:

dataset_id (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.data_set_list.DataSetList

get_item(dataset_id: str, item_id: str, *, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.api_client.ApiClient) → scorable.generated.openapi_client.models.dataset_item.DatasetItem¶

Get a single dataset item.

Parameters:

dataset_id (str)
item_id (str)
_request_timeout (Optional[int])
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.dataset_item.DatasetItem

list(search_term: str | None = None, *, limit: int = 100, project_id: str | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.api_client.ApiClient) → Iterator[scorable.generated.openapi_client.models.data_set_list.DataSetList]¶

Iterate through the datasets.

Parameters:

limit (int) – Number of entries to iterate through at most.
search_term (Optional[str]) – Can be used to limit returned datasets.
project_id (Optional[str]) – Optional project filter.
_request_timeout (Optional[int])
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

Iterator[scorable.generated.openapi_client.models.data_set_list.DataSetList]

list_items(dataset_id: str, *, include_archived: bool = False, limit: int = 100, _client: scorable.generated.openapi_client.api_client.ApiClient) → Iterator[scorable.generated.openapi_client.models.dataset_item.DatasetItem]¶

Iterate through the latest-version items of a dataset (with embedded published annotations).

Parameters:

dataset_id (str) – The dataset to list items from.
include_archived (bool) – Include archived items when true.
limit (int) – Number of entries to iterate through at most.
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

Iterator[scorable.generated.openapi_client.models.dataset_item.DatasetItem]

update_item(dataset_id: str, item_id: str, *, response: str | None = None, request: str | None = None, expected_output: str | None = None, contexts: List[str] | None = None, variables: Dict[str, Any] | None = None, metadata: Dict[str, Any] | None = None, change_note: str | None = None, _request_timeout: int | None = None, _client: scorable.generated.openapi_client.api_client.ApiClient) → scorable.generated.openapi_client.models.dataset_item.DatasetItem¶

Edit a dataset item. Editing creates a new version; only the latest version is editable.

Parameters:

dataset_id (str)
item_id (str)
response (Optional[str])
request (Optional[str])
expected_output (Optional[str])
contexts (Optional[List[str]])
variables (Optional[Dict[str, Any]])
metadata (Optional[Dict[str, Any]])
change_note (Optional[str])
_request_timeout (Optional[int])
_client (scorable.generated.openapi_client.api_client.ApiClient)

Return type:

scorable.generated.openapi_client.models.dataset_item.DatasetItem

api_key¶

base_url¶

client_context¶

scorable.datasets.MAX_BULK_ITEMS = 5000¶