Package com.google.cloud.aiplatform.v1

Interface CandidateOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Candidate, Candidate.Builder
@Generated public interface CandidateOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getIndex

      int getIndex()
       Output only. Index of the candidate.
      int32 index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The index.

    • hasContent

      boolean hasContent()
       Output only. Content parts of the candidate.
      .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the content field is set.

    • getContent

      Content getContent()
       Output only. Content parts of the candidate.
      .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The content.

    • getContentOrBuilder

      ContentOrBuilder getContentOrBuilder()
       Output only. Content parts of the candidate.
      .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getScore

      double getScore()
       Output only. Confidence score of the candidate.
      double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The score.

    • getAvgLogprobs

      double getAvgLogprobs()
       Output only. Average log probability score of the candidate.
      double avg_logprobs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The avgLogprobs.

    • hasLogprobsResult

      boolean hasLogprobsResult()
       Output only. Log-likelihood scores for the response tokens and top tokens
      .google.cloud.aiplatform.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the logprobsResult field is set.

    • getLogprobsResult

      LogprobsResult getLogprobsResult()
       Output only. Log-likelihood scores for the response tokens and top tokens
      .google.cloud.aiplatform.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The logprobsResult.

    • getLogprobsResultOrBuilder

      LogprobsResultOrBuilder getLogprobsResultOrBuilder()
       Output only. Log-likelihood scores for the response tokens and top tokens
      .google.cloud.aiplatform.v1.LogprobsResult logprobs_result = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getFinishReasonValue

      int getFinishReasonValue()
       Output only. The reason why the model stopped generating tokens.
 If empty, the model has not stopped generating the tokens.
      .google.cloud.aiplatform.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for finishReason.

    • getFinishReason

      Candidate.FinishReason getFinishReason()
       Output only. The reason why the model stopped generating tokens.
 If empty, the model has not stopped generating the tokens.
      .google.cloud.aiplatform.v1.Candidate.FinishReason finish_reason = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The finishReason.

    • getSafetyRatingsList

      List<SafetyRating> getSafetyRatingsList()
       Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
      repeated .google.cloud.aiplatform.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSafetyRatings

      SafetyRating getSafetyRatings(int index)
       Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
      repeated .google.cloud.aiplatform.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSafetyRatingsCount

      int getSafetyRatingsCount()
       Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
      repeated .google.cloud.aiplatform.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSafetyRatingsOrBuilderList

      List<? extends SafetyRatingOrBuilder> getSafetyRatingsOrBuilderList()
       Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
      repeated .google.cloud.aiplatform.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getSafetyRatingsOrBuilder

      SafetyRatingOrBuilder getSafetyRatingsOrBuilder(int index)
       Output only. List of ratings for the safety of a response candidate.

 There is at most one rating per category.
      repeated .google.cloud.aiplatform.v1.SafetyRating safety_ratings = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasFinishMessage

      boolean hasFinishMessage()
       Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
      optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the finishMessage field is set.

    • getFinishMessage

      String getFinishMessage()
       Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
      optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The finishMessage.

    • getFinishMessageBytes

      com.google.protobuf.ByteString getFinishMessageBytes()
       Output only. Describes the reason the mode stopped generating tokens in
 more detail. This is only filled when `finish_reason` is set.
      optional string finish_message = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for finishMessage.

    • hasCitationMetadata

      boolean hasCitationMetadata()
       Output only. Source attribution of the generated content.
      .google.cloud.aiplatform.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the citationMetadata field is set.

    • getCitationMetadata

      CitationMetadata getCitationMetadata()
       Output only. Source attribution of the generated content.
      .google.cloud.aiplatform.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The citationMetadata.

    • getCitationMetadataOrBuilder

      CitationMetadataOrBuilder getCitationMetadataOrBuilder()
       Output only. Source attribution of the generated content.
      .google.cloud.aiplatform.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasGroundingMetadata

      boolean hasGroundingMetadata()
       Output only. Metadata specifies sources used to ground generated content.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the groundingMetadata field is set.

    • getGroundingMetadata

      GroundingMetadata getGroundingMetadata()
       Output only. Metadata specifies sources used to ground generated content.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The groundingMetadata.

    • getGroundingMetadataOrBuilder

      GroundingMetadataOrBuilder getGroundingMetadataOrBuilder()
       Output only. Metadata specifies sources used to ground generated content.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUrlContextMetadata

      boolean hasUrlContextMetadata()
       Output only. Metadata related to url context retrieval tool.
      .google.cloud.aiplatform.v1.UrlContextMetadata url_context_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the urlContextMetadata field is set.

    • getUrlContextMetadata

      UrlContextMetadata getUrlContextMetadata()
       Output only. Metadata related to url context retrieval tool.
      .google.cloud.aiplatform.v1.UrlContextMetadata url_context_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The urlContextMetadata.

    • getUrlContextMetadataOrBuilder

      UrlContextMetadataOrBuilder getUrlContextMetadataOrBuilder()
       Output only. Metadata related to url context retrieval tool.
      .google.cloud.aiplatform.v1.UrlContextMetadata url_context_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];