Package com.google.cloud.aiplatform.v1

Class Fact

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Fact
All Implemented Interfaces:
FactOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Fact extends com.google.protobuf.GeneratedMessage implements FactOrBuilder
 The fact used in grounding.
Protobuf type google.cloud.aiplatform.v1.Fact
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Fact.Builder
    The fact used in grounding.

    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
    QUERY_FIELD_NUMBER
     
    static final int
    SCORE_FIELD_NUMBER
     
    static final int
    SUMMARY_FIELD_NUMBER
     
    static final int
    TITLE_FIELD_NUMBER
     
    static final int
    URI_FIELD_NUMBER
     
    static final int
    VECTOR_DISTANCE_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()
    If present, chunk properties.
    RagChunkOrBuilder
    getChunkOrBuilder()
    If present, chunk properties.
    static Fact
    getDefaultInstance()
     
    Fact
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<Fact>
    getParserForType()
     
    String
    getQuery()
    Query that is used to retrieve this fact.
    com.google.protobuf.ByteString
    getQueryBytes()
    Query that is used to retrieve this fact.
    double
    getScore()
    If present, 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 fact and its range depends on the metric type.
    int
    getSerializedSize()
     
    String
    getSummary()
    If present, the summary/snippet of the fact.
    com.google.protobuf.ByteString
    getSummaryBytes()
    If present, the summary/snippet of the fact.
    String
    getTitle()
    If present, it refers to the title of this fact.
    com.google.protobuf.ByteString
    getTitleBytes()
    If present, it refers to the title of this fact.
    String
    getUri()
    If present, this uri links to the source of the fact.
    com.google.protobuf.ByteString
    getUriBytes()
    If present, this uri links to the source of the fact.
    double
    getVectorDistance()
    Deprecated.
    google.cloud.aiplatform.v1.Fact.vector_distance is deprecated.
    boolean
    hasChunk()
    If present, chunk properties.
    int
    hashCode()
     
    boolean
    hasQuery()
    Query that is used to retrieve this fact.
    boolean
    hasScore()
    If present, 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 fact and its range depends on the metric type.
    boolean
    hasSummary()
    If present, the summary/snippet of the fact.
    boolean
    hasTitle()
    If present, it refers to the title of this fact.
    boolean
    hasUri()
    If present, this uri links to the source of the fact.
    boolean
    hasVectorDistance()
    Deprecated.
    google.cloud.aiplatform.v1.Fact.vector_distance is deprecated.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Fact.Builder
    newBuilder()
     
    static Fact.Builder
    newBuilder(Fact prototype)
     
    Fact.Builder
    newBuilderForType()
     
    protected Fact.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Fact
    parseDelimitedFrom(InputStream input)
     
    static Fact
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Fact
    parseFrom(byte[] data)
     
    static Fact
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Fact
    parseFrom(com.google.protobuf.ByteString data)
     
    static Fact
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Fact
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Fact
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Fact
    parseFrom(InputStream input)
     
    static Fact
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Fact
    parseFrom(ByteBuffer data)
     
    static Fact
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Fact>
    parser()
     
    Fact.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

    • hasQuery

      public boolean hasQuery()
       Query that is used to retrieve this fact.
      optional string query = 1;
      Specified by:
      hasQuery in interface FactOrBuilder
      Returns:
      Whether the query field is set.

    • getQuery

      public String getQuery()
       Query that is used to retrieve this fact.
      optional string query = 1;
      Specified by:
      getQuery in interface FactOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Query that is used to retrieve this fact.
      optional string query = 1;
      Specified by:
      getQueryBytes in interface FactOrBuilder
      Returns:
      The bytes for query.

    • hasTitle

      public boolean hasTitle()
       If present, it refers to the title of this fact.
      optional string title = 2;
      Specified by:
      hasTitle in interface FactOrBuilder
      Returns:
      Whether the title field is set.

    • getTitle

      public String getTitle()
       If present, it refers to the title of this fact.
      optional string title = 2;
      Specified by:
      getTitle in interface FactOrBuilder
      Returns:
      The title.

    • getTitleBytes

      public com.google.protobuf.ByteString getTitleBytes()
       If present, it refers to the title of this fact.
      optional string title = 2;
      Specified by:
      getTitleBytes in interface FactOrBuilder
      Returns:
      The bytes for title.

    • hasUri

      public boolean hasUri()
       If present, this uri links to the source of the fact.
      optional string uri = 3;
      Specified by:
      hasUri in interface FactOrBuilder
      Returns:
      Whether the uri field is set.

    • getUri

      public String getUri()
       If present, this uri links to the source of the fact.
      optional string uri = 3;
      Specified by:
      getUri in interface FactOrBuilder
      Returns:
      The uri.

    • getUriBytes

      public com.google.protobuf.ByteString getUriBytes()
       If present, this uri links to the source of the fact.
      optional string uri = 3;
      Specified by:
      getUriBytes in interface FactOrBuilder
      Returns:
      The bytes for uri.

    • hasSummary

      public boolean hasSummary()
       If present, the summary/snippet of the fact.
      optional string summary = 4;
      Specified by:
      hasSummary in interface FactOrBuilder
      Returns:
      Whether the summary field is set.

    • getSummary

      public String getSummary()
       If present, the summary/snippet of the fact.
      optional string summary = 4;
      Specified by:
      getSummary in interface FactOrBuilder
      Returns:
      The summary.

    • getSummaryBytes

      public com.google.protobuf.ByteString getSummaryBytes()
       If present, the summary/snippet of the fact.
      optional string summary = 4;
      Specified by:
      getSummaryBytes in interface FactOrBuilder
      Returns:
      The bytes for summary.

    • hasVectorDistance

      @Deprecated public boolean hasVectorDistance()
      Deprecated.
      google.cloud.aiplatform.v1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1/vertex_rag_service.proto;l=313
       If present, the distance between the query vector and this fact vector.
      optional double vector_distance = 5 [deprecated = true];
      Specified by:
      hasVectorDistance in interface FactOrBuilder
      Returns:
      Whether the vectorDistance field is set.

    • getVectorDistance

      @Deprecated public double getVectorDistance()
      Deprecated.
      google.cloud.aiplatform.v1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1/vertex_rag_service.proto;l=313
       If present, the distance between the query vector and this fact vector.
      optional double vector_distance = 5 [deprecated = true];
      Specified by:
      getVectorDistance in interface FactOrBuilder
      Returns:
      The vectorDistance.

    • hasScore

      public boolean hasScore()
       If present, 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 fact 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 fact. The larger the distance, the less
 relevant the fact 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 FactOrBuilder
      Returns:
      Whether the score field is set.

    • getScore

      public double getScore()
       If present, 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 fact 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 fact. The larger the distance, the less
 relevant the fact 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 FactOrBuilder
      Returns:
      The score.

    • hasChunk

      public boolean hasChunk()
       If present, chunk properties.
      optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;
      Specified by:
      hasChunk in interface FactOrBuilder
      Returns:
      Whether the chunk field is set.

    • getChunk

      public RagChunk getChunk()
       If present, chunk properties.
      optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;
      Specified by:
      getChunk in interface FactOrBuilder
      Returns:
      The chunk.

    • getChunkOrBuilder

      public RagChunkOrBuilder getChunkOrBuilder()
       If present, chunk properties.
      optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;
      Specified by:
      getChunkOrBuilder in interface FactOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Fact.Builder newBuilder()

    • newBuilder

      public static Fact.Builder newBuilder(Fact prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Fact getDefaultInstance()

    • parser

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

    • getParserForType

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