CandidateMetadata Class

Definition

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

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Explicit(ClientResult to CandidateMetadata)

Explicit Interface Implementations

Name Description
IJsonModel<CandidateMetadata>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<CandidateMetadata>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<CandidateMetadata>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<CandidateMetadata>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<CandidateMetadata>.Write(ModelReaderWriterOptions)

Applies to