AgentOptimizationJobs.GetCandidatesAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
List candidates produced by a job.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.AgentsPagedResultOptimizationCandidate>> GetCandidatesAsync(string jobId, int? limit = default, Azure.AI.Projects.Agents.AgentListOrder? order = default, string after = default, string before = default, System.Threading.CancellationToken cancellationToken = default);abstract member GetCandidatesAsync : string * Nullable<int> * Nullable<Azure.AI.Projects.Agents.AgentListOrder> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.AgentsPagedResultOptimizationCandidate>>
override this.GetCandidatesAsync : string * Nullable<int> * Nullable<Azure.AI.Projects.Agents.AgentListOrder> * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.Agents.AgentsPagedResultOptimizationCandidate>>Public Overridable Function GetCandidatesAsync (jobId As String, Optional limit As Nullable(Of Integer) = Nothing, Optional order As Nullable(Of AgentListOrder) = Nothing, Optional after As String = Nothing, Optional before As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of AgentsPagedResultOptimizationCandidate))Parameters
- jobId
- String
The optimization job id.
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.
- order
- Nullable<AgentListOrder>
Sort order by the created_at timestamp of the objects. asc for ascending order anddesc
for descending order.
- after
- String
A cursor for use in pagination. after 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 after=obj_foo in order to fetch the next page of the list.
- 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.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
jobId is null.
jobId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
