public static final class Fact.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder> implements FactOrBuilder
The fact used in grounding.Protobuf type
google.cloud.aiplatform.v1.Fact| Modifier and Type | Method and Description |
|---|---|
Fact.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Fact |
build() |
Fact |
buildPartial() |
Fact.Builder |
clear() |
Fact.Builder |
clearChunk()
If present, chunk properties.
|
Fact.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Fact.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Fact.Builder |
clearQuery()
Query that is used to retrieve this fact.
|
Fact.Builder |
clearScore()
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.
|
Fact.Builder |
clearSummary()
If present, the summary/snippet of the fact.
|
Fact.Builder |
clearTitle()
If present, it refers to the title of this fact.
|
Fact.Builder |
clearUri()
If present, this uri links to the source of the fact.
|
Fact.Builder |
clearVectorDistance()
Deprecated.
google.cloud.aiplatform.v1.Fact.vector_distance is deprecated. See
google/cloud/aiplatform/v1/vertex_rag_service.proto;l=288
|
Fact.Builder |
clone() |
RagChunk |
getChunk()
If present, chunk properties.
|
RagChunk.Builder |
getChunkBuilder()
If present, chunk properties.
|
RagChunkOrBuilder |
getChunkOrBuilder()
If present, chunk properties.
|
Fact |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
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. See
google/cloud/aiplatform/v1/vertex_rag_service.proto;l=288
|
boolean |
hasChunk()
If present, chunk properties.
|
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. See
google/cloud/aiplatform/v1/vertex_rag_service.proto;l=288
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Fact.Builder |
mergeChunk(RagChunk value)
If present, chunk properties.
|
Fact.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Fact.Builder |
mergeFrom(Fact other) |
Fact.Builder |
mergeFrom(com.google.protobuf.Message other) |
Fact.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Fact.Builder |
setChunk(RagChunk.Builder builderForValue)
If present, chunk properties.
|
Fact.Builder |
setChunk(RagChunk value)
If present, chunk properties.
|
Fact.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Fact.Builder |
setQuery(String value)
Query that is used to retrieve this fact.
|
Fact.Builder |
setQueryBytes(com.google.protobuf.ByteString value)
Query that is used to retrieve this fact.
|
Fact.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Fact.Builder |
setScore(double value)
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.
|
Fact.Builder |
setSummary(String value)
If present, the summary/snippet of the fact.
|
Fact.Builder |
setSummaryBytes(com.google.protobuf.ByteString value)
If present, the summary/snippet of the fact.
|
Fact.Builder |
setTitle(String value)
If present, it refers to the title of this fact.
|
Fact.Builder |
setTitleBytes(com.google.protobuf.ByteString value)
If present, it refers to the title of this fact.
|
Fact.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Fact.Builder |
setUri(String value)
If present, this uri links to the source of the fact.
|
Fact.Builder |
setUriBytes(com.google.protobuf.ByteString value)
If present, this uri links to the source of the fact.
|
Fact.Builder |
setVectorDistance(double value)
Deprecated.
google.cloud.aiplatform.v1.Fact.vector_distance is deprecated. See
google/cloud/aiplatform/v1/vertex_rag_service.proto;l=288
|
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Fact build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Fact buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Fact.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Fact.Builder>public Fact.Builder mergeFrom(Fact other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public Fact.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Fact.Builder>IOExceptionpublic boolean hasQuery()
Query that is used to retrieve this fact.
optional string query = 1;hasQuery in interface FactOrBuilderpublic String getQuery()
Query that is used to retrieve this fact.
optional string query = 1;getQuery in interface FactOrBuilderpublic com.google.protobuf.ByteString getQueryBytes()
Query that is used to retrieve this fact.
optional string query = 1;getQueryBytes in interface FactOrBuilderpublic Fact.Builder setQuery(String value)
Query that is used to retrieve this fact.
optional string query = 1;value - The query to set.public Fact.Builder clearQuery()
Query that is used to retrieve this fact.
optional string query = 1;public Fact.Builder setQueryBytes(com.google.protobuf.ByteString value)
Query that is used to retrieve this fact.
optional string query = 1;value - The bytes for query to set.public boolean hasTitle()
If present, it refers to the title of this fact.
optional string title = 2;hasTitle in interface FactOrBuilderpublic String getTitle()
If present, it refers to the title of this fact.
optional string title = 2;getTitle in interface FactOrBuilderpublic com.google.protobuf.ByteString getTitleBytes()
If present, it refers to the title of this fact.
optional string title = 2;getTitleBytes in interface FactOrBuilderpublic Fact.Builder setTitle(String value)
If present, it refers to the title of this fact.
optional string title = 2;value - The title to set.public Fact.Builder clearTitle()
If present, it refers to the title of this fact.
optional string title = 2;public Fact.Builder setTitleBytes(com.google.protobuf.ByteString value)
If present, it refers to the title of this fact.
optional string title = 2;value - The bytes for title to set.public boolean hasUri()
If present, this uri links to the source of the fact.
optional string uri = 3;hasUri in interface FactOrBuilderpublic String getUri()
If present, this uri links to the source of the fact.
optional string uri = 3;getUri in interface FactOrBuilderpublic com.google.protobuf.ByteString getUriBytes()
If present, this uri links to the source of the fact.
optional string uri = 3;getUriBytes in interface FactOrBuilderpublic Fact.Builder setUri(String value)
If present, this uri links to the source of the fact.
optional string uri = 3;value - The uri to set.public Fact.Builder clearUri()
If present, this uri links to the source of the fact.
optional string uri = 3;public Fact.Builder setUriBytes(com.google.protobuf.ByteString value)
If present, this uri links to the source of the fact.
optional string uri = 3;value - The bytes for uri to set.public boolean hasSummary()
If present, the summary/snippet of the fact.
optional string summary = 4;hasSummary in interface FactOrBuilderpublic String getSummary()
If present, the summary/snippet of the fact.
optional string summary = 4;getSummary in interface FactOrBuilderpublic com.google.protobuf.ByteString getSummaryBytes()
If present, the summary/snippet of the fact.
optional string summary = 4;getSummaryBytes in interface FactOrBuilderpublic Fact.Builder setSummary(String value)
If present, the summary/snippet of the fact.
optional string summary = 4;value - The summary to set.public Fact.Builder clearSummary()
If present, the summary/snippet of the fact.
optional string summary = 4;public Fact.Builder setSummaryBytes(com.google.protobuf.ByteString value)
If present, the summary/snippet of the fact.
optional string summary = 4;value - The bytes for summary to set.@Deprecated public boolean hasVectorDistance()
If present, the distance between the query vector and this fact vector.
optional double vector_distance = 5 [deprecated = true];hasVectorDistance in interface FactOrBuilder@Deprecated public double getVectorDistance()
If present, the distance between the query vector and this fact vector.
optional double vector_distance = 5 [deprecated = true];getVectorDistance in interface FactOrBuilder@Deprecated public Fact.Builder setVectorDistance(double value)
If present, the distance between the query vector and this fact vector.
optional double vector_distance = 5 [deprecated = true];value - The vectorDistance to set.@Deprecated public Fact.Builder clearVectorDistance()
If present, the distance between the query vector and this fact vector.
optional double vector_distance = 5 [deprecated = true];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;hasScore in interface FactOrBuilderpublic 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;getScore in interface FactOrBuilderpublic Fact.Builder setScore(double value)
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;value - The score to set.public Fact.Builder clearScore()
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;public boolean hasChunk()
If present, chunk properties.
optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;hasChunk in interface FactOrBuilderpublic RagChunk getChunk()
If present, chunk properties.
optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;getChunk in interface FactOrBuilderpublic Fact.Builder setChunk(RagChunk value)
If present, chunk properties.
optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;public Fact.Builder setChunk(RagChunk.Builder builderForValue)
If present, chunk properties.
optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;public Fact.Builder mergeChunk(RagChunk value)
If present, chunk properties.
optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;public Fact.Builder clearChunk()
If present, chunk properties.
optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;public RagChunk.Builder getChunkBuilder()
If present, chunk properties.
optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;public RagChunkOrBuilder getChunkOrBuilder()
If present, chunk properties.
optional .google.cloud.aiplatform.v1.RagChunk chunk = 7;getChunkOrBuilder in interface FactOrBuilderpublic final Fact.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>public final Fact.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Fact.Builder>Copyright © 2025 Google LLC. All rights reserved.