README.md

Dataset

(dataset)

Overview

Available Operations

• create_dataset - Create a Dataset
• delete_dataset_by_id - Delete a Single Dataset by ID
• get_dataset_by_id - Get a Single Dataset by ID
• upload_dataset_image - Upload dataset image
• upload_dataset_image_from_gen - Upload a Single Generated Image to a Dataset

create_dataset

This endpoint creates a new dataset

Example Usage

from leonardo_ai_sdk import LeonardoAiSDK

with LeonardoAiSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as las_client:

    res = las_client.dataset.create_dataset(request={
        "name": "<value>",
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
request	operations.CreateDatasetRequestBody	✔️	The request object to use for the request.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.CreateDatasetResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

delete_dataset_by_id

This endpoint deletes the specific dataset

Example Usage

from leonardo_ai_sdk import LeonardoAiSDK

with LeonardoAiSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as las_client:

    res = las_client.dataset.delete_dataset_by_id(id="<id>")

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
id	str	✔️	The ID of the dataset to delete.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.DeleteDatasetByIDResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

get_dataset_by_id

This endpoint gets the specific dataset

Example Usage

from leonardo_ai_sdk import LeonardoAiSDK

with LeonardoAiSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as las_client:

    res = las_client.dataset.get_dataset_by_id(id="<id>")

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
id	str	✔️	The ID of the dataset to return.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.GetDatasetByIDResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

upload_dataset_image

This endpoint returns presigned details to upload a dataset image to S3

Example Usage

from leonardo_ai_sdk import LeonardoAiSDK

with LeonardoAiSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as las_client:

    res = las_client.dataset.upload_dataset_image(dataset_id="<id>", request_body={
        "extension": "mp4v",
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
dataset_id	str	✔️	_"datasetId" is required
request_body	operations.UploadDatasetImageRequestBody	✔️	Query parameters provided in the request body as a JSON object
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.UploadDatasetImageResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*

upload_dataset_image_from_gen

This endpoint will upload a previously generated image to the dataset

Example Usage

from leonardo_ai_sdk import LeonardoAiSDK

with LeonardoAiSDK(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as las_client:

    res = las_client.dataset.upload_dataset_image_from_gen(dataset_id="<id>", request_body={
        "generated_image_id": "<id>",
    })

    assert res.object is not None

    # Handle response
    print(res.object)

Parameters

Parameter	Type	Required	Description
dataset_id	str	✔️	The ID of the dataset to upload the image to.
request_body	operations.UploadDatasetImageFromGenRequestBody	✔️	Query parameters to be provided in the request body as a JSON object
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

operations.UploadDatasetImageFromGenResponse

Errors

Error Type	Status Code	Content Type
errors.SDKError	4XX, 5XX	*/*