Package com.google.cloud.aiplatform.v1

Class RagContexts.Context

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.RagContexts.Context
All Implemented Interfaces:
RagContexts.ContextOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
RagContexts
public static final class RagContexts.Context extends com.google.protobuf.GeneratedMessage implements RagContexts.ContextOrBuilder
 A context of the query.
Protobuf type google.cloud.aiplatform.v1.RagContexts.Context
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RagContexts.Context.Builder
    A context of the query.

    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
    CHUNK_FIELD_NUMBER
     
    static final int
    SCORE_FIELD_NUMBER
     
    static final int
    SOURCE_DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    SOURCE_URI_FIELD_NUMBER
     
    static final int
    TEXT_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)
     
    RagChunk
    getChunk()
    Context of the retrieved chunk.
    RagChunkOrBuilder
    getChunkOrBuilder()
    Context of the retrieved chunk.
    static RagContexts.Context
    getDefaultInstance()
     
    RagContexts.Context
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<RagContexts.Context>
    getParserForType()
     
    double
    getScore()
    According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type.
    int
    getSerializedSize()
     
    String
    getSourceDisplayName()
    The file display name.
    com.google.protobuf.ByteString
    getSourceDisplayNameBytes()
    The file display name.
    String
    getSourceUri()
    If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.
    com.google.protobuf.ByteString
    getSourceUriBytes()
    If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.
    String
    getText()
    The text chunk.
    com.google.protobuf.ByteString
    getTextBytes()
    The text chunk.
    boolean
    hasChunk()
    Context of the retrieved chunk.
    int
    hashCode()
     
    boolean
    hasScore()
    According to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the context and its range depends on the metric type.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RagContexts.Context.Builder
    newBuilder()
     
    static RagContexts.Context.Builder
    newBuilder(RagContexts.Context prototype)
     
    RagContexts.Context.Builder
    newBuilderForType()
     
    protected RagContexts.Context.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static RagContexts.Context
    parseDelimitedFrom(InputStream input)
     
    static RagContexts.Context
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RagContexts.Context
    parseFrom(byte[] data)
     
    static RagContexts.Context
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RagContexts.Context
    parseFrom(com.google.protobuf.ByteString data)
     
    static RagContexts.Context
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RagContexts.Context
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RagContexts.Context
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RagContexts.Context
    parseFrom(InputStream input)
     
    static RagContexts.Context
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RagContexts.Context
    parseFrom(ByteBuffer data)
     
    static RagContexts.Context
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RagContexts.Context>
    parser()
     
    RagContexts.Context.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

  • 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

    • getSourceUri

      public String getSourceUri()
       If the file is imported from Cloud Storage or Google Drive, source_uri
 will be original file URI in Cloud Storage or Google Drive; if file is
 uploaded, source_uri will be file display name.
      string source_uri = 1;
      Specified by:
      getSourceUri in interface RagContexts.ContextOrBuilder
      Returns:
      The sourceUri.

    • getSourceUriBytes

      public com.google.protobuf.ByteString getSourceUriBytes()
       If the file is imported from Cloud Storage or Google Drive, source_uri
 will be original file URI in Cloud Storage or Google Drive; if file is
 uploaded, source_uri will be file display name.
      string source_uri = 1;
      Specified by:
      getSourceUriBytes in interface RagContexts.ContextOrBuilder
      Returns:
      The bytes for sourceUri.

    • getSourceDisplayName

      public String getSourceDisplayName()
       The file display name.
      string source_display_name = 5;
      Specified by:
      getSourceDisplayName in interface RagContexts.ContextOrBuilder
      Returns:
      The sourceDisplayName.

    • getSourceDisplayNameBytes

      public com.google.protobuf.ByteString getSourceDisplayNameBytes()
       The file display name.
      string source_display_name = 5;
      Specified by:
      getSourceDisplayNameBytes in interface RagContexts.ContextOrBuilder
      Returns:
      The bytes for sourceDisplayName.

    • getText

      public String getText()
       The text chunk.
      string text = 2;
      Specified by:
      getText in interface RagContexts.ContextOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       The text chunk.
      string text = 2;
      Specified by:
      getTextBytes in interface RagContexts.ContextOrBuilder
      Returns:
      The bytes for text.

    • hasScore

      public boolean hasScore()
       According to the underlying Vector DB and the selected metric type, the
 score can be either the distance or the similarity between the query and
 the context and its range depends on the metric type.

 For example, if the metric type is COSINE_DISTANCE, it represents the
 distance between the query and the context. The larger the distance, the
 less relevant the context is to the query. The range is [0, 2], while 0
 means the most relevant and 2 means the least relevant.
      optional double score = 6;
      Specified by:
      hasScore in interface RagContexts.ContextOrBuilder
      Returns:
      Whether the score field is set.

    • getScore

      public double getScore()
       According to the underlying Vector DB and the selected metric type, the
 score can be either the distance or the similarity between the query and
 the context and its range depends on the metric type.

 For example, if the metric type is COSINE_DISTANCE, it represents the
 distance between the query and the context. The larger the distance, the
 less relevant the context is to the query. The range is [0, 2], while 0
 means the most relevant and 2 means the least relevant.
      optional double score = 6;
      Specified by:
      getScore in interface RagContexts.ContextOrBuilder
      Returns:
      The score.

    • hasChunk

      public boolean hasChunk()
       Context of the retrieved chunk.
      .google.cloud.aiplatform.v1.RagChunk chunk = 7;
      Specified by:
      hasChunk in interface RagContexts.ContextOrBuilder
      Returns:
      Whether the chunk field is set.

    • getChunk

      public RagChunk getChunk()
       Context of the retrieved chunk.
      .google.cloud.aiplatform.v1.RagChunk chunk = 7;
      Specified by:
      getChunk in interface RagContexts.ContextOrBuilder
      Returns:
      The chunk.

    • getChunkOrBuilder

      public RagChunkOrBuilder getChunkOrBuilder()
       Context of the retrieved chunk.
      .google.cloud.aiplatform.v1.RagChunk chunk = 7;
      Specified by:
      getChunkOrBuilder in interface RagContexts.ContextOrBuilder

    • 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 RagContexts.Context parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RagContexts.Context parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RagContexts.Context parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RagContexts.Context.Builder newBuilder()

    • newBuilder

      public static RagContexts.Context.Builder newBuilder(RagContexts.Context prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RagContexts.Context getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RagContexts.Context> 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 RagContexts.Context getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder