BetaAgentsOperations interface

Package:

@azure/ai-projects

Interface representing a BetaAgents operations.

Properties

cancelOptimizationJob	Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state.
createOptimizationJob	Create an optimization job. Returns 201 with the queued job. Honours Operation-Id for idempotent retry.
deleteOptimizationJob	Delete the job and its candidate artifacts. Cancels first if non-terminal.
getOptimizationJob	Get an optimization job by id.
listOptimizationJobs	List optimization jobs. Supports cursor pagination and optional status / agent_name filters.

Property Details

cancelOptimizationJob

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

cancelOptimizationJob: (jobId: string, options?: BetaAgentsCancelOptimizationJobOptionalParams) => Promise<OptimizationJob>

Property Value

(jobId: string, options?: BetaAgentsCancelOptimizationJobOptionalParams) => Promise<OptimizationJob>

createOptimizationJob

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

createOptimizationJob: (job: OptimizationJob, options?: BetaAgentsCreateOptimizationJobOptionalParams) => Promise<OptimizationJob>

Property Value

(job: OptimizationJob, options?: BetaAgentsCreateOptimizationJobOptionalParams) => Promise<OptimizationJob>

deleteOptimizationJob

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

deleteOptimizationJob: (jobId: string, options?: BetaAgentsDeleteOptimizationJobOptionalParams) => Promise<void>

Property Value

(jobId: string, options?: BetaAgentsDeleteOptimizationJobOptionalParams) => Promise<void>

getOptimizationJob

Get an optimization job by id.

getOptimizationJob: (jobId: string, options?: BetaAgentsGetOptimizationJobOptionalParams) => Promise<OptimizationJob>

Property Value

(jobId: string, options?: BetaAgentsGetOptimizationJobOptionalParams) => Promise<OptimizationJob>

listOptimizationJobs

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

listOptimizationJobs: (options?: BetaAgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<OptimizationJobListItem, OptimizationJobListItem[], PageSettings>

Property Value

(options?: BetaAgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<OptimizationJobListItem, OptimizationJobListItem[], PageSettings>