ProjectsAgentsModelFactory.CandidateMetadata Method

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v2.1.0-beta.3

Source:

ProjectsAgentsModelFactory.cs

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

public static Azure.AI.Projects.Agents.CandidateMetadata CandidateMetadata(string candidateId = default, string jobId = default, string candidateName = default, string status = default, double? score = default, bool hasResults = false, DateTimeOffset createdAt = default, DateTimeOffset updatedAt = default, Azure.AI.Projects.Agents.PromotionInfo promotion = default, System.Collections.Generic.IEnumerable<Azure.AI.Projects.Agents.CandidateFileInfo> files = default);

static member CandidateMetadata : string * string * string * string * Nullable<double> * bool * DateTimeOffset * DateTimeOffset * Azure.AI.Projects.Agents.PromotionInfo * seq<Azure.AI.Projects.Agents.CandidateFileInfo> -> Azure.AI.Projects.Agents.CandidateMetadata

Public Shared Function CandidateMetadata (Optional candidateId As String = Nothing, Optional jobId As String = Nothing, Optional candidateName As String = Nothing, Optional status As String = Nothing, Optional score As Nullable(Of Double) = Nothing, Optional hasResults As Boolean = false, Optional createdAt As DateTimeOffset = Nothing, Optional updatedAt As DateTimeOffset = Nothing, Optional promotion As PromotionInfo = Nothing, Optional files As IEnumerable(Of CandidateFileInfo) = Nothing) As CandidateMetadata

Parameters

candidateId

String

Server-assigned candidate identifier.

jobId

String

Owning optimization job id.

candidateName

String

Display name of the candidate.

status

String

Candidate lifecycle status.

score

Nullable<Double>

Candidate's aggregate score.

hasResults

Boolean

Whether detailed results are available for this candidate.

createdAt

DateTimeOffset

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

updatedAt

DateTimeOffset

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

promotion

PromotionInfo

Promotion metadata. Null if not promoted.

files

IEnumerable<CandidateFileInfo>

Files in the candidate's blob directory.

Returns

CandidateMetadata

A new CandidateMetadata instance for mocking.