​
Dataset Objects

class Dataset(BaseClientModel, DecorateAllMethods)

​
get_content

def get_content() -> Union[None, DatasetContent]
Gets and returns the content of the dataset. Also refreshes the content of the local dataset instance. Raises:
  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns: Union[None, DatasetContent]: The content of the dataset

​
add_rows

def add_rows(row_data: list[dict[str, Any]]) -> "Dataset"
Adds rows to the dataset. Arguments:
  • row_data (List[Dict[str, Any]]): The rows to add to the dataset.
Raises:
  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns: Dataset: The updated dataset with the new rows.

​
Datasets Objects

class Datasets(BaseClientModel)

​
list

def list(limit: Union[Unset, int] = 100) -> list[Dataset]
Lists all datasets. Arguments:
  • limit (Union[Unset, int]): The maximum number of datasets to return. Default is 100.
Raises:
  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns: List[Dataset]: A list of datasets.

​
get

def get(*,
        id: Optional[str] = None,
        name: Optional[str] = None,
        with_content: bool = False) -> Optional[Dataset]
Retrieves a dataset by id or name (exactly one of id or name must be provided). Arguments:
  • id (str): The id of the dataset.
  • name (str): The name of the dataset.
  • with_content (bool): Whether to return the content of the dataset. Default is False.
Raises:
  • ValueError: If neither or both id and name are provided.
  • name1: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • name2: If the request takes longer than Client.timeout.
Returns: name3: The dataset.

​
delete

def delete(*, id: Optional[str] = None, name: Optional[str] = None) -> None
Deletes a dataset by id or name. Arguments:
  • id (str): The id of the dataset.
  • name (str): The name of the dataset.
Raises:
  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

​
create

def create(name: str, content: DatasetType) -> Dataset
Creates a new dataset. Arguments:
  • name (str): The name of the dataset.
  • content (DatasetType): The content of the dataset.
Raises:
  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns: Dataset: The created dataset.

​
extend

def extend(*,
           prompt_settings: Optional[dict[str, Any]] = None,
           prompt: Optional[str] = None,
           instructions: Optional[str] = None,
           examples: Optional[builtins.list[str]] = None,
           data_types: Optional[builtins.list[str]] = None,
           count: int = 10) -> builtins.list[DatasetRow]
Extends a dataset with synthetically generated data based on the provided parameters. This method initiates a dataset extension job, waits for it to complete by polling its status, and then returns the content of the extended dataset. Arguments:
  • prompt_settings (Dict[str, Any]): Settings for the prompt generation. Should contain ‘model_alias’ key. Example: {‘model_alias’: ‘GPT-4o mini’}
  • prompt (str): A description of the assistant’s role.
  • instructions (str): Instructions for the assistant.
  • examples (List[str]): Examples of user prompts.
  • data_types (List[str]): The types of data to generate. Possible values are: ‘General Query’, ‘Prompt Injection’, ‘Off-Topic Query’, ‘Toxic Content in Query’, ‘Multiple Questions in Query’, ‘Sexist Content in Query’.
  • Dict[str, Any]0 (Dict[str, Any]1): The number of synthetic examples to generate.
Raises:
  • Dict[str, Any]2: If the request to extend the dataset fails.
  • Dict[str, Any]3: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • Dict[str, Any]4: If the request takes longer than Client.timeout.
Returns: Dict[str, Any]5: A list of rows from the extended dataset.

​
get_dataset

def get_dataset(*,
                id: Optional[str] = None,
                name: Optional[str] = None) -> Optional[Dataset]
Retrieves a dataset by id or name (exactly one of id or name must be provided). Arguments:
  • id (str): The id of the dataset.
  • name (str): The name of the dataset.
  • with_content (bool): Whether to return the content of the dataset. Default is False.
Raises:
  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns: name0: The dataset.

​
list_datasets

def list_datasets(limit: Union[Unset, int] = 100) -> list[Dataset]
Lists all datasets. Arguments:
  • limit (Union[Unset, int]): The maximum number of datasets to return. Default is 100.
Returns: List[Dataset]: A list of datasets.

​
delete_dataset

def delete_dataset(*,
                   id: Optional[str] = None,
                   name: Optional[str] = None) -> None
Deletes a dataset by id or name (exactly one of id or name must be provided). Arguments:
  • id (str): The id of the dataset.
  • name (str): The name of the dataset.
Raises:
  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.

​
create_dataset

def create_dataset(name: str, content: DatasetType) -> Dataset
Creates a new dataset. Arguments:
  • name (str): The name of the dataset.
  • content (DatasetType): The content of the dataset.
Raises:
  • errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • httpx.TimeoutException: If the request takes longer than Client.timeout.
Returns: Dataset: The created dataset.

​
get_dataset_version_history

def get_dataset_version_history(
    *,
    dataset_name: str = None,
    dataset_id: str = None
) -> Optional[Union[HTTPValidationError, ListDatasetVersionResponse]]
Retrieves a dataset version history by dataset name or dataset id. Arguments:
  • dataset_name (str): The name of the dataset.
  • dataset_id (str): The id of the dataset.
Raises:
  • HTTPValidationError: None
Returns: ListDatasetVersionResponse:

​
get_dataset_version

def get_dataset_version(*,
                        version_index: int,
                        dataset_name: str = None,
                        dataset_id: str = None) -> Optional[DatasetContent]
Retrieves a dataset version by dataset name or dataset id. Arguments:
  • version_index (int): The version of the dataset.
  • dataset_name (Optional[str]): The name of the dataset.
  • dataset_id (Optional[str]): The id of the dataset.
Returns: DatasetContent:

​
extend_dataset

def extend_dataset(*,
                   prompt_settings: Optional[dict[str, Any]] = None,
                   prompt: Optional[str] = None,
                   instructions: Optional[str] = None,
                   examples: Optional[list[str]] = None,
                   data_types: Optional[list[str]] = None,
                   count: int = 10) -> list[DatasetRow]
Extends a dataset with synthetically generated data based on the provided parameters. This function initiates a dataset extension job, waits for it to complete by polling its status, and then returns the content of the extended dataset. Arguments:
  • prompt_settings (Dict[str, Any]): Settings for the prompt generation. Should contain ‘model_alias’ key. Example: {‘model_alias’: ‘GPT-4o mini’}
  • prompt (str): A description of the assistant’s role.
  • instructions (str): Instructions for the assistant.
  • examples (List[str]): Examples of user prompts.
  • data_types (List[str]): The types of data to generate. Possible values are: ‘General Query’, ‘Prompt Injection’, ‘Off-Topic Query’, ‘Toxic Content in Query’, ‘Multiple Questions in Query’, ‘Sexist Content in Query’.
  • Dict[str, Any]0 (Dict[str, Any]1): The number of synthetic examples to generate.
Raises:
  • Dict[str, Any]2: If the request to extend the dataset fails.
  • Dict[str, Any]3: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
  • Dict[str, Any]4: If the request takes longer than Client.timeout.
Returns: Dict[str, Any]5: A list of rows from the extended dataset.