Package com.google.cloud.aiplatform.v1

Class Candidate.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Candidate.Builder>
com.google.cloud.aiplatform.v1.Candidate.Builder
All Implemented Interfaces:
CandidateOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Candidate
public static final class Candidate.Builder extends com.google.protobuf.GeneratedMessage.Builder<Candidate.Builder> implements CandidateOrBuilder
 A response candidate generated from the model.
Protobuf type google.cloud.aiplatform.v1.Candidate

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Candidate.Builder>

    • clear

      public Candidate.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Candidate.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Candidate.Builder>

    • getDefaultInstanceForType

      public Candidate getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Candidate build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Candidate buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Candidate.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Candidate.Builder>

    • mergeFrom

      public Candidate.Builder mergeFrom(Candidate other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Candidate.Builder>

    • mergeFrom

      public Candidate.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Candidate.Builder>
      Throws:
      IOException

    • getIndex

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

    • setIndex

      public Candidate.Builder setIndex(int value)
       Output only. Index of the candidate.
      int32 index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The index to set.
      Returns:
      This builder for chaining.

    • clearIndex

      public Candidate.Builder clearIndex()
       Output only. Index of the candidate.
      int32 index = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasContent

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

    • getContent

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

    • setContent

      public Candidate.Builder setContent(Content value)
       Output only. Content parts of the candidate.
      .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setContent

      public Candidate.Builder setContent(Content.Builder builderForValue)
       Output only. Content parts of the candidate.
      .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeContent

      public Candidate.Builder mergeContent(Content value)
       Output only. Content parts of the candidate.
      .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearContent

      public Candidate.Builder clearContent()
       Output only. Content parts of the candidate.
      .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getContentBuilder

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

    • getContentOrBuilder

      public ContentOrBuilder getContentOrBuilder()
       Output only. Content parts of the candidate.
      .google.cloud.aiplatform.v1.Content content = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getContentOrBuilder in interface CandidateOrBuilder

    • getScore

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

    • setScore

      public Candidate.Builder setScore(double value)
       Output only. Confidence score of the candidate.
      double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The score to set.
      Returns:
      This builder for chaining.

    • clearScore

      public Candidate.Builder clearScore()
       Output only. Confidence score of the candidate.
      double score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • getAvgLogprobs

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

    • setAvgLogprobs

      public Candidate.Builder setAvgLogprobs(double value)
       Output only. Average log probability score of the candidate.
      double avg_logprobs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The avgLogprobs to set.
      Returns:
      This builder for chaining.

    • clearAvgLogprobs

      public Candidate.Builder clearAvgLogprobs()
       Output only. Average log probability score of the candidate.
      double avg_logprobs = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasLogprobsResult

      public 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];
      Specified by:
      hasLogprobsResult in interface CandidateOrBuilder
      Returns:
      Whether the logprobsResult field is set.

    • getLogprobsResult

      public 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];
      Specified by:
      getLogprobsResult in interface CandidateOrBuilder
      Returns:
      The logprobsResult.

    • setLogprobsResult

      public Candidate.Builder setLogprobsResult(LogprobsResult value)
       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];

    • setLogprobsResult

      public Candidate.Builder setLogprobsResult(LogprobsResult.Builder builderForValue)
       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];

    • mergeLogprobsResult

      public Candidate.Builder mergeLogprobsResult(LogprobsResult value)
       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];

    • clearLogprobsResult

      public Candidate.Builder clearLogprobsResult()
       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];

    • getLogprobsResultBuilder

      public LogprobsResult.Builder getLogprobsResultBuilder()
       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];

    • getLogprobsResultOrBuilder

      public 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];
      Specified by:
      getLogprobsResultOrBuilder in interface CandidateOrBuilder

    • getFinishReasonValue

      public 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];
      Specified by:
      getFinishReasonValue in interface CandidateOrBuilder
      Returns:
      The enum numeric value on the wire for finishReason.

    • setFinishReasonValue

      public Candidate.Builder setFinishReasonValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for finishReason to set.
      Returns:
      This builder for chaining.

    • getFinishReason

      public 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];
      Specified by:
      getFinishReason in interface CandidateOrBuilder
      Returns:
      The finishReason.

    • setFinishReason

      public Candidate.Builder setFinishReason(Candidate.FinishReason value)
       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];
      Parameters:
      value - The finishReason to set.
      Returns:
      This builder for chaining.

    • clearFinishReason

      public Candidate.Builder clearFinishReason()
       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:
      This builder for chaining.

    • getSafetyRatingsList

      public 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];
      Specified by:
      getSafetyRatingsList in interface CandidateOrBuilder

    • getSafetyRatingsCount

      public 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];
      Specified by:
      getSafetyRatingsCount in interface CandidateOrBuilder

    • getSafetyRatings

      public 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];
      Specified by:
      getSafetyRatings in interface CandidateOrBuilder

    • setSafetyRatings

      public Candidate.Builder setSafetyRatings(int index, SafetyRating value)
       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];

    • setSafetyRatings

      public Candidate.Builder setSafetyRatings(int index, SafetyRating.Builder builderForValue)
       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];

    • addSafetyRatings

      public Candidate.Builder addSafetyRatings(SafetyRating value)
       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];

    • addSafetyRatings

      public Candidate.Builder addSafetyRatings(int index, SafetyRating value)
       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];

    • addSafetyRatings

      public Candidate.Builder addSafetyRatings(SafetyRating.Builder builderForValue)
       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];

    • addSafetyRatings

      public Candidate.Builder addSafetyRatings(int index, SafetyRating.Builder builderForValue)
       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];

    • addAllSafetyRatings

      public Candidate.Builder addAllSafetyRatings(Iterable<? extends SafetyRating> values)
       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];

    • clearSafetyRatings

      public Candidate.Builder clearSafetyRatings()
       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];

    • removeSafetyRatings

      public Candidate.Builder removeSafetyRatings(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];

    • getSafetyRatingsBuilder

      public SafetyRating.Builder getSafetyRatingsBuilder(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];

    • getSafetyRatingsOrBuilder

      public 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];
      Specified by:
      getSafetyRatingsOrBuilder in interface CandidateOrBuilder

    • getSafetyRatingsOrBuilderList

      public 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];
      Specified by:
      getSafetyRatingsOrBuilderList in interface CandidateOrBuilder

    • addSafetyRatingsBuilder

      public SafetyRating.Builder addSafetyRatingsBuilder()
       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];

    • addSafetyRatingsBuilder

      public SafetyRating.Builder addSafetyRatingsBuilder(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];

    • getSafetyRatingsBuilderList

      public List<SafetyRating.Builder> getSafetyRatingsBuilderList()
       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

      public 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];
      Specified by:
      hasFinishMessage in interface CandidateOrBuilder
      Returns:
      Whether the finishMessage field is set.

    • getFinishMessage

      public 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];
      Specified by:
      getFinishMessage in interface CandidateOrBuilder
      Returns:
      The finishMessage.

    • getFinishMessageBytes

      public 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];
      Specified by:
      getFinishMessageBytes in interface CandidateOrBuilder
      Returns:
      The bytes for finishMessage.

    • setFinishMessage

      public Candidate.Builder setFinishMessage(String value)
       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];
      Parameters:
      value - The finishMessage to set.
      Returns:
      This builder for chaining.

    • clearFinishMessage

      public Candidate.Builder clearFinishMessage()
       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:
      This builder for chaining.

    • setFinishMessageBytes

      public Candidate.Builder setFinishMessageBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for finishMessage to set.
      Returns:
      This builder for chaining.

    • hasCitationMetadata

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

    • getCitationMetadata

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

    • setCitationMetadata

      public Candidate.Builder setCitationMetadata(CitationMetadata value)
       Output only. Source attribution of the generated content.
      .google.cloud.aiplatform.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setCitationMetadata

      public Candidate.Builder setCitationMetadata(CitationMetadata.Builder builderForValue)
       Output only. Source attribution of the generated content.
      .google.cloud.aiplatform.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeCitationMetadata

      public Candidate.Builder mergeCitationMetadata(CitationMetadata value)
       Output only. Source attribution of the generated content.
      .google.cloud.aiplatform.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearCitationMetadata

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

    • getCitationMetadataBuilder

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

    • getCitationMetadataOrBuilder

      public CitationMetadataOrBuilder getCitationMetadataOrBuilder()
       Output only. Source attribution of the generated content.
      .google.cloud.aiplatform.v1.CitationMetadata citation_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCitationMetadataOrBuilder in interface CandidateOrBuilder

    • hasGroundingMetadata

      public 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];
      Specified by:
      hasGroundingMetadata in interface CandidateOrBuilder
      Returns:
      Whether the groundingMetadata field is set.

    • getGroundingMetadata

      public 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];
      Specified by:
      getGroundingMetadata in interface CandidateOrBuilder
      Returns:
      The groundingMetadata.

    • setGroundingMetadata

      public Candidate.Builder setGroundingMetadata(GroundingMetadata value)
       Output only. Metadata specifies sources used to ground generated content.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setGroundingMetadata

      public Candidate.Builder setGroundingMetadata(GroundingMetadata.Builder builderForValue)
       Output only. Metadata specifies sources used to ground generated content.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeGroundingMetadata

      public Candidate.Builder mergeGroundingMetadata(GroundingMetadata value)
       Output only. Metadata specifies sources used to ground generated content.
      .google.cloud.aiplatform.v1.GroundingMetadata grounding_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearGroundingMetadata

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

    • getGroundingMetadataBuilder

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

    • getGroundingMetadataOrBuilder

      public 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];
      Specified by:
      getGroundingMetadataOrBuilder in interface CandidateOrBuilder

    • hasUrlContextMetadata

      public 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];
      Specified by:
      hasUrlContextMetadata in interface CandidateOrBuilder
      Returns:
      Whether the urlContextMetadata field is set.

    • getUrlContextMetadata

      public 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];
      Specified by:
      getUrlContextMetadata in interface CandidateOrBuilder
      Returns:
      The urlContextMetadata.

    • setUrlContextMetadata

      public Candidate.Builder setUrlContextMetadata(UrlContextMetadata value)
       Output only. Metadata related to url context retrieval tool.
      .google.cloud.aiplatform.v1.UrlContextMetadata url_context_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setUrlContextMetadata

      public Candidate.Builder setUrlContextMetadata(UrlContextMetadata.Builder builderForValue)
       Output only. Metadata related to url context retrieval tool.
      .google.cloud.aiplatform.v1.UrlContextMetadata url_context_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeUrlContextMetadata

      public Candidate.Builder mergeUrlContextMetadata(UrlContextMetadata value)
       Output only. Metadata related to url context retrieval tool.
      .google.cloud.aiplatform.v1.UrlContextMetadata url_context_metadata = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearUrlContextMetadata

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

    • getUrlContextMetadataBuilder

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

    • getUrlContextMetadataOrBuilder

      public 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];
      Specified by:
      getUrlContextMetadataOrBuilder in interface CandidateOrBuilder