CandidateMetadata interface

Package:

@azure/ai-projects

Candidate metadata returned by GET /candidates/{id}.

Properties

candidate_id	Server-assigned candidate identifier.
candidate_name	Display name of the candidate.
created_at	Timestamp when the candidate was created, represented in Unix time.
files	Files in the candidate's blob directory.
has_results	Whether detailed results are available for this candidate.
job_id	Owning optimization job id.
promotion	Promotion metadata. Null if not promoted.
score	Candidate's aggregate score.
status	Candidate lifecycle status.
updated_at	Timestamp when the candidate was last updated, represented in Unix time.

Property Details

candidate_id

Server-assigned candidate identifier.

candidate_id: string

Property Value

string

candidate_name

Display name of the candidate.

candidate_name: string

Property Value

string

created_at

Timestamp when the candidate was created, represented in Unix time.

created_at: Date

Property Value

Date

files

Files in the candidate's blob directory.

files: CandidateFileInfo[]

Property Value

CandidateFileInfo[]

has_results

Whether detailed results are available for this candidate.

has_results: boolean

Property Value

boolean

job_id

Owning optimization job id.

job_id: string

Property Value

string

promotion

Promotion metadata. Null if not promoted.

promotion?: PromotionInfo

Property Value

PromotionInfo

score

Candidate's aggregate score.

score?: number

Property Value

number

status

Candidate lifecycle status.

status: string

Property Value

string

updated_at

Timestamp when the candidate was last updated, represented in Unix time.

updated_at: Date

Property Value

Date