BetaDatasetsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:datasets> attribute.

Constructor

BetaDatasetsOperations(*args, **kwargs)

Methods

cancel_generation_job

Cancel a data generation job.

Cancels the specified data generation job if it is still in progress.
create_generation_job

Create a data generation job.

Submits a new data generation job for asynchronous execution.
delete_generation_job

Delete a data generation job.

Removes the specified data generation job and its associated output.
get_generation_job

Get a data generation job.

Retrieves the specified data generation job and its current status.
list_generation_jobs

List data generation jobs.

Returns a list of data generation jobs.

cancel_generation_job

Cancel a data generation job.

Cancels the specified data generation job if it is still in progress.

cancel_generation_job(job_id: str, **kwargs: Any) -> DataGenerationJob

Parameters

Name Description
job_id
Required
str

The ID of the job to cancel. Required.

Returns

Type Description
DataGenerationJob

DataGenerationJob. The DataGenerationJob is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

create_generation_job

Create a data generation job.

Submits a new data generation job for asynchronous execution.

create_generation_job(job: _models.DataGenerationJob, *, operation_id: str | None = None, content_type: str = 'application/json', **kwargs: Any) -> _models.DataGenerationJob

Parameters

Name Description
job
Required
DataGenerationJob or <xref:JSON> or IO[bytes]

The job to create. Is one of the following types: DataGenerationJob, JSON, IO[bytes] Required.

Keyword-Only Parameters

Name Description
operation_id
str

Client-generated unique ID for idempotent retries. When absent, the server creates the job unconditionally. Default value is None.

Default value: None

Returns

Type Description
DataGenerationJob

DataGenerationJob. The DataGenerationJob is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

delete_generation_job

Delete a data generation job.

Removes the specified data generation job and its associated output.

delete_generation_job(job_id: str, **kwargs: Any) -> None

Parameters

Name Description
job_id
Required
str

The ID of the job to delete. Required.

Returns

Type Description
None

None

Exceptions

Type Description
HttpResponseError

get_generation_job

Get a data generation job.

Retrieves the specified data generation job and its current status.

get_generation_job(job_id: str, **kwargs: Any) -> DataGenerationJob

Parameters

Name Description
job_id
Required
str

The ID of the job. Required.

Returns

Type Description
DataGenerationJob

DataGenerationJob. The DataGenerationJob is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list_generation_jobs

List data generation jobs.

Returns a list of data generation jobs.

list_generation_jobs(*, limit: int | None = None, order: str | PageOrder | None = None, before: str | None = None, **kwargs: Any) -> ItemPaged[DataGenerationJob]

Keyword-Only Parameters

Name Description
limit
int

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20. Default value is None.

Default value: None
order
str or PageOrder

Sort order by the created_at timestamp of the objects. asc for ascending order anddesc for descending order. Known values are: "asc" and "desc". Default value is None.

Default value: None
before
str

A cursor for use in pagination. before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include before=obj_foo in order to fetch the previous page of the list. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[DataGenerationJob]

An iterator like instance of DataGenerationJob

Exceptions

Type Description
HttpResponseError