Class Fact.Builder (3.56.0)

Version latest

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class Fact.Builder extends GeneratedMessageV3.Builder<Fact.Builder> implements FactOrBuilder

The fact used in grounding.

Protobuf type google.cloud.aiplatform.v1.Fact

Inheritance

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

Implements

FactOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Fact.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Fact build()

Returns
Type	Description
Fact

buildPartial()

public Fact buildPartial()

Returns
Type	Description
Fact

clear()

public Fact.Builder clear()

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Fact.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Fact.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQuery()

public Fact.Builder clearQuery()

Query that is used to retrieve this fact.

optional string query = 1;

Returns
Type	Description
Fact.Builder	This builder for chaining.

clearScore()

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;

Returns
Type	Description
Fact.Builder	This builder for chaining.

clearSummary()

public Fact.Builder clearSummary()

If present, the summary/snippet of the fact.

optional string summary = 4;

Returns
Type	Description
Fact.Builder	This builder for chaining.

clearTitle()

public Fact.Builder clearTitle()

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

optional string title = 2;

Returns
Type	Description
Fact.Builder	This builder for chaining.

clearUri()

public Fact.Builder clearUri()

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

optional string uri = 3;

Returns
Type	Description
Fact.Builder	This builder for chaining.

clearVectorDistance() (deprecated)

public Fact.Builder clearVectorDistance()

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

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

optional double vector_distance = 5 [deprecated = true];

Returns
Type	Description
Fact.Builder	This builder for chaining.

clone()

public Fact.Builder clone()

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Fact getDefaultInstanceForType()

Returns
Type	Description
Fact

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.v1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1/vertex_rag_service.proto;l=284

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.

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()

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
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.v1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1/vertex_rag_service.proto;l=284

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Fact other)

public Fact.Builder mergeFrom(Fact other)

Parameter
Name	Description
other	Fact

Returns
Type	Description
Fact.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Fact.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Fact.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Fact.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Fact.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Fact.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public Fact.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setQuery(String value)

public Fact.Builder setQuery(String value)

Query that is used to retrieve this fact.

optional string query = 1;

Parameter
Name	Description
value	String The query to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setQueryBytes(ByteString value)

public Fact.Builder setQueryBytes(ByteString value)

Query that is used to retrieve this fact.

optional string query = 1;

Parameter
Name	Description
value	ByteString The bytes for query to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Fact.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setScore(double value)

public 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;

Parameter
Name	Description
value	double The score to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setSummary(String value)

public Fact.Builder setSummary(String value)

If present, the summary/snippet of the fact.

optional string summary = 4;

Parameter
Name	Description
value	String The summary to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setSummaryBytes(ByteString value)

public Fact.Builder setSummaryBytes(ByteString value)

If present, the summary/snippet of the fact.

optional string summary = 4;

Parameter
Name	Description
value	ByteString The bytes for summary to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setTitle(String value)

public Fact.Builder setTitle(String value)

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

optional string title = 2;

Parameter
Name	Description
value	String The title to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setTitleBytes(ByteString value)

public Fact.Builder setTitleBytes(ByteString value)

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

optional string title = 2;

Parameter
Name	Description
value	ByteString The bytes for title to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Fact.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Fact.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUri(String value)

public Fact.Builder setUri(String value)

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

optional string uri = 3;

Parameter
Name	Description
value	String The uri to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setUriBytes(ByteString value)

public Fact.Builder setUriBytes(ByteString value)

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

optional string uri = 3;

Parameter
Name	Description
value	ByteString The bytes for uri to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.

setVectorDistance(double value) (deprecated)

public 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=284

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

optional double vector_distance = 5 [deprecated = true];

Parameter
Name	Description
value	double The vectorDistance to set.

Returns
Type	Description
Fact.Builder	This builder for chaining.