BetaAgentsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AIProjectClient's

<xref:agents> attribute.

Constructor

BetaAgentsOperations(*args, **kwargs)

Methods

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.
create_optimization_job

Creates an agent optimization job.

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

Deletes an agent optimization job.

Delete the job and its candidate artifacts. Cancels first if non-terminal.
get_optimization_job

Get info about an agent optimization job.

Get an optimization job by id.
list_optimization_jobs

Returns a list of agent optimization jobs.

List optimization jobs. Supports cursor pagination and optional status / agent_name filters.

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.

cancel_optimization_job(job_id: str, **kwargs: Any) -> OptimizationJob

Parameters

Name Description
job_id
Required
str

The ID of the job to cancel. Required.

Returns

Type Description
OptimizationJob

OptimizationJob. The OptimizationJob is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

create_optimization_job

Creates an agent optimization job.

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

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

Parameters

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

The job to create. Is one of the following types: OptimizationJob, 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
OptimizationJob

OptimizationJob. The OptimizationJob is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

delete_optimization_job

Deletes an agent optimization job.

Delete the job and its candidate artifacts. Cancels first if non-terminal.

delete_optimization_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_optimization_job

Get info about an agent optimization job.

Get an optimization job by id.

get_optimization_job(job_id: str, **kwargs: Any) -> OptimizationJob

Parameters

Name Description
job_id
Required
str

The ID of the job. Required.

Returns

Type Description
OptimizationJob

OptimizationJob. The OptimizationJob is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list_optimization_jobs

Returns a list of agent optimization jobs.

List optimization jobs. Supports cursor pagination and optional status / agent_name filters.

list_optimization_jobs(*, limit: int | None = None, order: str | PageOrder | None = None, before: str | None = None, status: str | JobStatus | None = None, agent_name: str | None = None, **kwargs: Any) -> ItemPaged[OptimizationJobListItem]

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
status
str or JobStatus

Filter to jobs in this lifecycle state. Known values are: "queued", "in_progress", "succeeded", "failed", and "cancelled". Default value is None.

Default value: None
agent_name
str

Filter to jobs targeting this agent name. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[OptimizationJobListItem]

An iterator like instance of OptimizationJobListItem

Exceptions

Type Description
HttpResponseError