Package com.google.genkit.ai

Class Candidate

java.lang.Object
com.google.genkit.ai.Candidate
public class Candidate extends Object
Candidate represents a single model response candidate.

  • Constructor Details

    • Candidate

      public Candidate()
      Default constructor.

    • Candidate

      public Candidate(Message message)
      Creates a Candidate with a message.
      Parameters:
      message - the candidate message

    • Candidate

      public Candidate(Message message, FinishReason finishReason)
      Creates a Candidate with message and finish reason.
      Parameters:
      message - the candidate message
      finishReason - the finish reason

  • Method Details

    • getIndex

      public int getIndex()

    • setIndex

      public void setIndex(int index)

    • getMessage

      public Message getMessage()

    • setMessage

      public void setMessage(Message message)

    • getFinishReason

      public FinishReason getFinishReason()

    • setFinishReason

      public void setFinishReason(FinishReason finishReason)

    • getFinishMessage

      public String getFinishMessage()

    • setFinishMessage

      public void setFinishMessage(String finishMessage)

    • getCustom

      public Map<String,Object> getCustom()

    • setCustom

      public void setCustom(Map<String,Object> custom)

    • text

      public String text()
      Extracts the text content from this candidate.
      Returns:
      the concatenated text content