Package com.google.cloud.aiplatform.v1

Class GroundingSupport

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.GroundingSupport
All Implemented Interfaces:
GroundingSupportOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class GroundingSupport extends com.google.protobuf.GeneratedMessage implements GroundingSupportOrBuilder
 Grounding support.
Protobuf type google.cloud.aiplatform.v1.GroundingSupport
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    GroundingSupport.Builder
    Grounding support.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONFIDENCE_SCORES_FIELD_NUMBER
     
    static final int
    GROUNDING_CHUNK_INDICES_FIELD_NUMBER
     
    static final int
    SEGMENT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    float
    getConfidenceScores(int index)
    Confidence score of the support references.
    int
    getConfidenceScoresCount()
    Confidence score of the support references.
    List<Float>
    getConfidenceScoresList()
    Confidence score of the support references.
    static GroundingSupport
    getDefaultInstance()
     
    GroundingSupport
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    int
    getGroundingChunkIndices(int index)
    A list of indices (into 'grounding_chunk') specifying the citations associated with the claim.
    int
    getGroundingChunkIndicesCount()
    A list of indices (into 'grounding_chunk') specifying the citations associated with the claim.
    List<Integer>
    getGroundingChunkIndicesList()
    A list of indices (into 'grounding_chunk') specifying the citations associated with the claim.
    com.google.protobuf.Parser<GroundingSupport>
    getParserForType()
     
    Segment
    getSegment()
    Segment of the content this support belongs to.
    SegmentOrBuilder
    getSegmentOrBuilder()
    Segment of the content this support belongs to.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasSegment()
    Segment of the content this support belongs to.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static GroundingSupport.Builder
    newBuilder()
     
    static GroundingSupport.Builder
    newBuilder(GroundingSupport prototype)
     
    GroundingSupport.Builder
    newBuilderForType()
     
    protected GroundingSupport.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static GroundingSupport
    parseDelimitedFrom(InputStream input)
     
    static GroundingSupport
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GroundingSupport
    parseFrom(byte[] data)
     
    static GroundingSupport
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GroundingSupport
    parseFrom(com.google.protobuf.ByteString data)
     
    static GroundingSupport
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GroundingSupport
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static GroundingSupport
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GroundingSupport
    parseFrom(InputStream input)
     
    static GroundingSupport
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GroundingSupport
    parseFrom(ByteBuffer data)
     
    static GroundingSupport
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<GroundingSupport>
    parser()
     
    GroundingSupport.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • SEGMENT_FIELD_NUMBER

      public static final int SEGMENT_FIELD_NUMBER
      See Also:

    • GROUNDING_CHUNK_INDICES_FIELD_NUMBER

      public static final int GROUNDING_CHUNK_INDICES_FIELD_NUMBER
      See Also:

    • CONFIDENCE_SCORES_FIELD_NUMBER

      public static final int CONFIDENCE_SCORES_FIELD_NUMBER
      See Also:

  • 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

    • hasSegment

      public boolean hasSegment()
       Segment of the content this support belongs to.
      optional .google.cloud.aiplatform.v1.Segment segment = 1;
      Specified by:
      hasSegment in interface GroundingSupportOrBuilder
      Returns:
      Whether the segment field is set.

    • getSegment

      public Segment getSegment()
       Segment of the content this support belongs to.
      optional .google.cloud.aiplatform.v1.Segment segment = 1;
      Specified by:
      getSegment in interface GroundingSupportOrBuilder
      Returns:
      The segment.

    • getSegmentOrBuilder

      public SegmentOrBuilder getSegmentOrBuilder()
       Segment of the content this support belongs to.
      optional .google.cloud.aiplatform.v1.Segment segment = 1;
      Specified by:
      getSegmentOrBuilder in interface GroundingSupportOrBuilder

    • getGroundingChunkIndicesList

      public List<Integer> getGroundingChunkIndicesList()
       A list of indices (into 'grounding_chunk') specifying the
 citations associated with the claim. For instance [1,3,4] means
 that grounding_chunk[1], grounding_chunk[3],
 grounding_chunk[4] are the retrieved content attributed to the claim.
      repeated int32 grounding_chunk_indices = 2;
      Specified by:
      getGroundingChunkIndicesList in interface GroundingSupportOrBuilder
      Returns:
      A list containing the groundingChunkIndices.

    • getGroundingChunkIndicesCount

      public int getGroundingChunkIndicesCount()
       A list of indices (into 'grounding_chunk') specifying the
 citations associated with the claim. For instance [1,3,4] means
 that grounding_chunk[1], grounding_chunk[3],
 grounding_chunk[4] are the retrieved content attributed to the claim.
      repeated int32 grounding_chunk_indices = 2;
      Specified by:
      getGroundingChunkIndicesCount in interface GroundingSupportOrBuilder
      Returns:
      The count of groundingChunkIndices.

    • getGroundingChunkIndices

      public int getGroundingChunkIndices(int index)
       A list of indices (into 'grounding_chunk') specifying the
 citations associated with the claim. For instance [1,3,4] means
 that grounding_chunk[1], grounding_chunk[3],
 grounding_chunk[4] are the retrieved content attributed to the claim.
      repeated int32 grounding_chunk_indices = 2;
      Specified by:
      getGroundingChunkIndices in interface GroundingSupportOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The groundingChunkIndices at the given index.

    • getConfidenceScoresList

      public List<Float> getConfidenceScoresList()
       Confidence score of the support references. Ranges from 0 to 1. 1 is the
 most confident. This list must have the same size as the
 grounding_chunk_indices.
      repeated float confidence_scores = 3;
      Specified by:
      getConfidenceScoresList in interface GroundingSupportOrBuilder
      Returns:
      A list containing the confidenceScores.

    • getConfidenceScoresCount

      public int getConfidenceScoresCount()
       Confidence score of the support references. Ranges from 0 to 1. 1 is the
 most confident. This list must have the same size as the
 grounding_chunk_indices.
      repeated float confidence_scores = 3;
      Specified by:
      getConfidenceScoresCount in interface GroundingSupportOrBuilder
      Returns:
      The count of confidenceScores.

    • getConfidenceScores

      public float getConfidenceScores(int index)
       Confidence score of the support references. Ranges from 0 to 1. 1 is the
 most confident. This list must have the same size as the
 grounding_chunk_indices.
      repeated float confidence_scores = 3;
      Specified by:
      getConfidenceScores in interface GroundingSupportOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The confidenceScores at the given index.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static GroundingSupport parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GroundingSupport parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GroundingSupport parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GroundingSupport parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GroundingSupport parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GroundingSupport parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GroundingSupport parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GroundingSupport parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GroundingSupport parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static GroundingSupport parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GroundingSupport parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static GroundingSupport parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public GroundingSupport.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static GroundingSupport.Builder newBuilder()

    • newBuilder

      public static GroundingSupport.Builder newBuilder(GroundingSupport prototype)

    • toBuilder

      public GroundingSupport.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected GroundingSupport.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static GroundingSupport getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<GroundingSupport> parser()

    • getParserForType

      public com.google.protobuf.Parser<GroundingSupport> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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