AgentOptimizationJobCandidates.GetCandidate 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.
Overloads
| Name | Description |
|---|---|
| GetCandidate(String, String, RequestOptions) |
[Protocol Method] Retrieves a single candidate. Mutation values are always included.
|
| GetCandidate(String, String, CancellationToken) |
Retrieves a single candidate. Mutation values are always included. |
GetCandidate(String, String, RequestOptions)
[Protocol Method] Retrieves a single candidate. Mutation values are always included.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.ClientModel.ClientResult GetCandidate(string jobId, string candidateId, System.ClientModel.Primitives.RequestOptions options);
abstract member GetCandidate : string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
override this.GetCandidate : string * string * System.ClientModel.Primitives.RequestOptions -> System.ClientModel.ClientResult
Public Overridable Function GetCandidate (jobId As String, candidateId As String, options As RequestOptions) As ClientResult
Parameters
- jobId
- String
The ID of the parent optimization job.
- candidateId
- String
The candidate identifier.
- options
- RequestOptions
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
jobId or candidateId is null.
jobId or candidateId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetCandidate(String, String, CancellationToken)
Retrieves a single candidate. Mutation values are always included.
public virtual System.ClientModel.ClientResult<Azure.AI.Projects.Agents.AgentOptimizationCandidate> GetCandidate(string jobId, string candidateId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetCandidate : string * string * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.Agents.AgentOptimizationCandidate>
override this.GetCandidate : string * string * System.Threading.CancellationToken -> System.ClientModel.ClientResult<Azure.AI.Projects.Agents.AgentOptimizationCandidate>
Public Overridable Function GetCandidate (jobId As String, candidateId As String, Optional cancellationToken As CancellationToken = Nothing) As ClientResult(Of AgentOptimizationCandidate)
Parameters
- jobId
- String
The ID of the parent optimization job.
- candidateId
- String
The candidate identifier.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
jobId or candidateId is null.
jobId or candidateId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.