beta_datasets

Creates, updates, deletes, gets or lists a beta_datasets resource.

Overview

Name	beta_datasets
Type	Resource
Id	azure.ai_projects.beta_datasets

Fields

The following fields are returned by SELECT queries:

get_generation_job

Name	Datatype	Description
id	string	Server-assigned unique identifier. Required.
created_at	string (date-time)	The timestamp when the job was created, represented in Unix time (seconds since January 1, 1970). Required.
error	object	Error details — populated only on failure.
finished_at	string (date-time)	The timestamp when the job was finished, represented in Unix time (seconds since January 1, 1970).
inputs	object	Caller-supplied inputs.
result	object	Result produced on success.
status	string	Current lifecycle status. Required. Known values are: "queued", "in_progress", "succeeded", "failed", and "cancelled". (queued, in_progress, succeeded, failed, cancelled)

list_generation_jobs

Name	Datatype	Description
id	string	Server-assigned unique identifier. Required.
created_at	string (date-time)	The timestamp when the job was created, represented in Unix time (seconds since January 1, 1970). Required.
error	object	Error details — populated only on failure.
finished_at	string (date-time)	The timestamp when the job was finished, represented in Unix time (seconds since January 1, 1970).
inputs	object	Caller-supplied inputs.
result	object	Result produced on success.
status	string	Current lifecycle status. Required. Known values are: "queued", "in_progress", "succeeded", "failed", and "cancelled". (queued, in_progress, succeeded, failed, cancelled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_generation_job	select	job_id, endpoint		Get a data generation job. Retrieves the specified data generation job and its current status.
list_generation_jobs	select	endpoint	limit, order, after, before	List data generation jobs. Returns a list of data generation jobs.
create_generation_job	exec	endpoint	Operation-Id	Create a data generation job. Submits a new data generation job for asynchronous execution.
delete_generation_job	exec	job_id, endpoint		Delete a data generation job. Removes the specified data generation job and its associated output.
cancel_generation_job	exec	job_id, endpoint		Cancel a data generation job. Cancels the specified data generation job if it is still in progress.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: )
job_id	string	The ID of the job to cancel. Required.
Operation-Id	string	Client-generated unique ID for idempotent retries. When absent, the server creates the job unconditionally. Default value is None.
after	string
before	string	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.
limit	integer	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.
order	string	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.

SELECT examples

get_generation_job

Get a data generation job. Retrieves the specified data generation job and its current status.

SELECT
id,
created_at,
error,
finished_at,
inputs,
result,
status
FROM azure.ai_projects.beta_datasets
WHERE job_id = '{{ job_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_generation_jobs

List data generation jobs. Returns a list of data generation jobs.

SELECT
id,
created_at,
error,
finished_at,
inputs,
result,
status
FROM azure.ai_projects.beta_datasets
WHERE endpoint = '{{ endpoint }}' -- required
AND limit = '{{ limit }}'
AND order = '{{ order }}'
AND after = '{{ after }}'
AND before = '{{ before }}'
;

Lifecycle Methods

create_generation_job

Create a data generation job. Submits a new data generation job for asynchronous execution.

EXEC azure.ai_projects.beta_datasets.create_generation_job 
@endpoint='{{ endpoint }}' --required, 
@Operation-Id='{{ Operation-Id }}' 
@@json=
'{
"inputs": "{{ inputs }}"
}'
;

delete_generation_job

Delete a data generation job. Removes the specified data generation job and its associated output.

EXEC azure.ai_projects.beta_datasets.delete_generation_job 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

cancel_generation_job

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

EXEC azure.ai_projects.beta_datasets.cancel_generation_job 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;