CandidateMetadata Class
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.
Candidate metadata returned by GET /candidates/{id}.
public class CandidateMetadata : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.CandidateMetadata>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.CandidateMetadata>
type CandidateMetadata = class
interface IJsonModel<CandidateMetadata>
interface IPersistableModel<CandidateMetadata>
Public Class CandidateMetadata
Implements IJsonModel(Of CandidateMetadata), IPersistableModel(Of CandidateMetadata)
- Inheritance
-
CandidateMetadata
- Implements
Properties
| Name | Description |
|---|---|
| CandidateId |
Server-assigned candidate identifier. |
| CandidateName |
Display name of the candidate. |
| CreatedAt |
Timestamp when the candidate was created, represented in Unix time. |
| Files |
Files in the candidate's blob directory. |
| HasResults |
Whether detailed results are available for this candidate. |
| JobId |
Owning optimization job id. |
| Promotion |
Promotion metadata. Null if not promoted. |
| Score |
Candidate's aggregate score. |
| Status |
Candidate lifecycle status. |
| UpdatedAt |
Timestamp when the candidate was last updated, represented in Unix time. |
Methods
Operators
| Name | Description |
|---|---|
| Explicit(ClientResult to CandidateMetadata) | |