gemini4kt/io.github.ugaikit.gemini4kt/Candidate

Candidate

@Serializable

data class Candidate(val content: Content, val finishReason: String, val index: Int, val safetyRatings: List<SafetyRating>, val citationMetadata: CitationMetadata? = null, val tokenCount: Int? = null, val groundingAttributions: List<GroundingAttribution> = emptyList())

Represents a candidate entity with associated content and metadata.

Constructors

Candidate

constructor(content: Content, finishReason: String, index: Int, safetyRatings: List<SafetyRating>, citationMetadata: CitationMetadata? = null, tokenCount: Int? = null, groundingAttributions: List<GroundingAttribution> = emptyList())

Properties

citationMetadata

val citationMetadata: CitationMetadata? = null

content

val content: Content

The io.github.ugaikit.gemini4kt.Content associated with this candidate, containing the actual content details.

finishReason

val finishReason: String

A string describing the reason why the processing of this candidate was finished.

groundingAttributions

val groundingAttributions: List<GroundingAttribution>

index

val index: Int

The index of this candidate in a sequence or batch, indicating its order or position.

safetyRatings

val safetyRatings: List<SafetyRating>

A list of io.github.ugaikit.gemini4kt.SafetyRating objects, each representing a safety rating assigned to this candidate's content.

tokenCount

val tokenCount: Int? = null