Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class Fact (3.77.0)

public final class Fact extends GeneratedMessageV3 implements FactOrBuilder

The fact used in grounding.

Protobuf type google.cloud.aiplatform.v1beta1.Fact

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Fact

Implements

FactOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CHUNK_FIELD_NUMBER

public static final int CHUNK_FIELD_NUMBER

Field Value
Type	Description
`int`

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

Field Value
Type	Description
`int`

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER

Field Value
Type	Description
`int`

SUMMARY_FIELD_NUMBER

public static final int SUMMARY_FIELD_NUMBER

Field Value
Type	Description
`int`

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

Field Value
Type	Description
`int`

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

Field Value
Type	Description
`int`

VECTOR_DISTANCE_FIELD_NUMBER

public static final int VECTOR_DISTANCE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static Fact getDefaultInstance()

Returns
Type	Description
`Fact`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Fact.Builder newBuilder()

Returns
Type	Description
`Fact.Builder`

newBuilder(Fact prototype)

public static Fact.Builder newBuilder(Fact prototype)

Parameter
Name	Description
`prototype`	`Fact`

Returns
Type	Description
`Fact.Builder`

parseDelimitedFrom(InputStream input)

public static Fact parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Fact parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Fact parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Fact parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Fact parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Fact parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Fact parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Fact parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Fact parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Fact parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Fact parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Fact parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Fact`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Fact> parser()

Returns
Type	Description
`Parser<Fact>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getChunk()

public RagChunk getChunk()

If present, chunk properties.

optional .google.cloud.aiplatform.v1beta1.RagChunk chunk = 7;

Returns
Type	Description
`RagChunk`	The chunk.

getChunkOrBuilder()

public RagChunkOrBuilder getChunkOrBuilder()

If present, chunk properties.

optional .google.cloud.aiplatform.v1beta1.RagChunk chunk = 7;

Returns
Type	Description
`RagChunkOrBuilder`

getDefaultInstanceForType()

public Fact getDefaultInstanceForType()

Returns
Type	Description
`Fact`

getParserForType()

public Parser<Fact> getParserForType()

Returns
Type	Description
`Parser<Fact>`

Overrides

GeneratedMessageV3.getParserForType()

getQuery()

public String getQuery()

Query that is used to retrieve this fact.

optional string query = 1;

Returns
Type	Description
`String`	The query.

getQueryBytes()

public ByteString getQueryBytes()

Query that is used to retrieve this fact.

optional string query = 1;

Returns
Type	Description
`ByteString`	The bytes for query.

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;

Returns
Type	Description
`double`	The score.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getSummary()

public String getSummary()

If present, the summary/snippet of the fact.

optional string summary = 4;

Returns
Type	Description
`String`	The summary.

getSummaryBytes()

public ByteString getSummaryBytes()

If present, the summary/snippet of the fact.

optional string summary = 4;

Returns
Type	Description
`ByteString`	The bytes for summary.

getTitle()

public String getTitle()

If present, it refers to the title of this fact.

optional string title = 2;

Returns
Type	Description
`String`	The title.

getTitleBytes()

public ByteString getTitleBytes()

If present, it refers to the title of this fact.

optional string title = 2;

Returns
Type	Description
`ByteString`	The bytes for title.

getUri()

public String getUri()

If present, this uri links to the source of the fact.

optional string uri = 3;

Returns
Type	Description
`String`	The uri.

getUriBytes()

public ByteString getUriBytes()

If present, this uri links to the source of the fact.

optional string uri = 3;

Returns
Type	Description
`ByteString`	The bytes for uri.

getVectorDistance() (deprecated)

public double getVectorDistance()

Deprecated. google.cloud.aiplatform.v1beta1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=318

If present, the distance between the query vector and this fact vector.

optional double vector_distance = 5 [deprecated = true];

Returns
Type	Description
`double`	The vectorDistance.

hasChunk()

public boolean hasChunk()

If present, chunk properties.

optional .google.cloud.aiplatform.v1beta1.RagChunk chunk = 7;

Returns
Type	Description
`boolean`	Whether the chunk field is set.

hasQuery()

public boolean hasQuery()

Query that is used to retrieve this fact.

optional string query = 1;

Returns
Type	Description
`boolean`	Whether the query field is set.

hasScore()

public boolean hasScore()

optional double score = 6;

Returns
Type	Description
`boolean`	Whether the score field is set.

hasSummary()

public boolean hasSummary()

If present, the summary/snippet of the fact.

optional string summary = 4;

Returns
Type	Description
`boolean`	Whether the summary field is set.

hasTitle()

public boolean hasTitle()

If present, it refers to the title of this fact.

optional string title = 2;

Returns
Type	Description
`boolean`	Whether the title field is set.

hasUri()

public boolean hasUri()

If present, this uri links to the source of the fact.

optional string uri = 3;

Returns
Type	Description
`boolean`	Whether the uri field is set.

hasVectorDistance() (deprecated)

public boolean hasVectorDistance()

Deprecated. google.cloud.aiplatform.v1beta1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=318

If present, the distance between the query vector and this fact vector.

optional double vector_distance = 5 [deprecated = true];

Returns
Type	Description
`boolean`	Whether the vectorDistance field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Fact.Builder newBuilderForType()

Returns
Type	Description
`Fact.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Fact.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`Fact.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Fact.Builder toBuilder()

Returns
Type	Description
`Fact.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`