beta_agents

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

Overview

Name	beta_agents
Type	Resource
Id	azure.ai_projects.beta_agents

Fields

The following fields are returned by SELECT queries:

get_optimization_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. Required.
error	object	Error details — populated only on failure.
inputs	object	Caller-supplied inputs.
progress	object	Progress snapshot. May be present in terminal states reflecting last-known progress.
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)
updated_at	string (date-time)	The timestamp when the job was last updated, represented in Unix time. Required.
warnings	array	Non-fatal warnings emitted at any point during optimization.

list_optimization_jobs

Name	Datatype	Description
id	string	Server-assigned unique identifier. Required.
agent	object	The agent targeted by this optimization job.
created_at	string (date-time)	The timestamp when the job was created, represented in Unix time. Required.
error	object	Error details — populated only on failure.
progress	object	Progress snapshot. May be present in terminal states reflecting last-known progress.
status	string	Current lifecycle status. Required. Known values are: "queued", "in_progress", "succeeded", "failed", and "cancelled". (queued, in_progress, succeeded, failed, cancelled)
updated_at	string (date-time)	The timestamp when the job was last updated, represented in Unix time. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_optimization_job	select	job_id, endpoint		Get info about an agent optimization job. Get an optimization job by id.
list_optimization_jobs	select	endpoint	limit, order, after, before, status, agent_name	Returns a list of agent optimization jobs. List optimization jobs. Supports cursor pagination and optional status / agent_name filters.
create_optimization_job	exec	endpoint	Operation-Id	Creates an agent optimization job. Create an optimization job. Returns 201 with the queued job. Honours Operation-Id for idempotent retry.
delete_optimization_job	exec	job_id, endpoint		Deletes an agent optimization job. Delete the job and its candidate artifacts. Cancels first if non-terminal.
cancel_optimization_job	exec	job_id, endpoint		Cancels an agent optimization job. Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state.

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
agent_name	string	Filter to jobs targeting this agent name. Default value is None.
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.
status	string	Filter to jobs in this lifecycle state. Known values are: "queued", "in_progress", "succeeded", "failed", and "cancelled". Default value is None.

SELECT examples

get_optimization_job

Get info about an agent optimization job. Get an optimization job by id.

SELECT
id,
created_at,
error,
inputs,
progress,
result,
status,
updated_at,
warnings
FROM azure.ai_projects.beta_agents
WHERE job_id = '{{ job_id }}' -- required
AND endpoint = '{{ endpoint }}' -- required
;

list_optimization_jobs

Returns a list of agent optimization jobs. List optimization jobs. Supports cursor pagination and optional status / agent_name filters.

SELECT
id,
agent,
created_at,
error,
progress,
status,
updated_at
FROM azure.ai_projects.beta_agents
WHERE endpoint = '{{ endpoint }}' -- required
AND limit = '{{ limit }}'
AND order = '{{ order }}'
AND after = '{{ after }}'
AND before = '{{ before }}'
AND status = '{{ status }}'
AND agent_name = '{{ agent_name }}'
;

Lifecycle Methods

create_optimization_job

Creates an agent optimization job. Create an optimization job. Returns 201 with the queued job. Honours Operation-Id for idempotent retry.

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

delete_optimization_job

Deletes an agent optimization job. Delete the job and its candidate artifacts. Cancels first if non-terminal.

EXEC azure.ai_projects.beta_agents.delete_optimization_job 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;

cancel_optimization_job

Cancels an agent optimization job. Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state.

EXEC azure.ai_projects.beta_agents.cancel_optimization_job 
@job_id='{{ job_id }}' --required, 
@endpoint='{{ endpoint }}' --required
;