Class RagContexts.Context.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 RagContexts.Context.Builder extends GeneratedMessageV3.Builder<RagContexts.Context.Builder> implements RagContexts.ContextOrBuilder

A context of the query.

Protobuf type google.cloud.aiplatform.v1beta1.RagContexts.Context

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RagContexts.Context.Builder

Implements

RagContexts.ContextOrBuilder

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 RagContexts.Context.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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

build()

public RagContexts.Context build()

Returns
Type	Description
RagContexts.Context

buildPartial()

public RagContexts.Context buildPartial()

Returns
Type	Description
RagContexts.Context

clear()

public RagContexts.Context.Builder clear()

Returns
Type	Description
RagContexts.Context.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDistance() (deprecated)

public RagContexts.Context.Builder clearDistance()

Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=181

The distance between the query dense embedding vector and the context text vector.

double distance = 3 [deprecated = true];

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RagContexts.Context.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public RagContexts.Context.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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

clearScore()

public RagContexts.Context.Builder clearScore()

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;

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

clearSourceDisplayName()

public RagContexts.Context.Builder clearSourceDisplayName()

The file display name.

string source_display_name = 5;

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

clearSourceUri()

public RagContexts.Context.Builder clearSourceUri()

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;

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

clearSparseDistance() (deprecated)

public RagContexts.Context.Builder clearSparseDistance()

Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.sparse_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=185

The distance between the query sparse embedding vector and the context text vector.

double sparse_distance = 4 [deprecated = true];

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

clearText()

public RagContexts.Context.Builder clearText()

The text chunk.

string text = 2;

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

clone()

public RagContexts.Context.Builder clone()

Returns
Type	Description
RagContexts.Context.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public RagContexts.Context getDefaultInstanceForType()

Returns
Type	Description
RagContexts.Context

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDistance() (deprecated)

public double getDistance()

Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=181

The distance between the query dense embedding vector and the context text vector.

double distance = 3 [deprecated = true];

Returns
Type	Description
double	The distance.

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;

Returns
Type	Description
double	The score.

getSourceDisplayName()

public String getSourceDisplayName()

The file display name.

string source_display_name = 5;

Returns
Type	Description
String	The sourceDisplayName.

getSourceDisplayNameBytes()

public ByteString getSourceDisplayNameBytes()

The file display name.

string source_display_name = 5;

Returns
Type	Description
ByteString	The bytes for sourceDisplayName.

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;

Returns
Type	Description
String	The sourceUri.

getSourceUriBytes()

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

Returns
Type	Description
ByteString	The bytes for sourceUri.

getSparseDistance() (deprecated)

public double getSparseDistance()

Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.sparse_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=185

The distance between the query sparse embedding vector and the context text vector.

double sparse_distance = 4 [deprecated = true];

Returns
Type	Description
double	The sparseDistance.

getText()

public String getText()

The text chunk.

string text = 2;

Returns
Type	Description
String	The text.

getTextBytes()

public ByteString getTextBytes()

The text chunk.

string text = 2;

Returns
Type	Description
ByteString	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;

Returns
Type	Description
boolean	Whether the score 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(RagContexts.Context other)

public RagContexts.Context.Builder mergeFrom(RagContexts.Context other)

Parameter
Name	Description
other	RagContexts.Context

Returns
Type	Description
RagContexts.Context.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RagContexts.Context.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public RagContexts.Context.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RagContexts.Context.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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

setDistance(double value) (deprecated)

public RagContexts.Context.Builder setDistance(double value)

Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=181

The distance between the query dense embedding vector and the context text vector.

double distance = 3 [deprecated = true];

Parameter
Name	Description
value	double The distance to set.

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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

setScore(double value)

public RagContexts.Context.Builder setScore(double value)

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;

Parameter
Name	Description
value	double The score to set.

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setSourceDisplayName(String value)

public RagContexts.Context.Builder setSourceDisplayName(String value)

The file display name.

string source_display_name = 5;

Parameter
Name	Description
value	String The sourceDisplayName to set.

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setSourceDisplayNameBytes(ByteString value)

public RagContexts.Context.Builder setSourceDisplayNameBytes(ByteString value)

The file display name.

string source_display_name = 5;

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

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setSourceUri(String value)

public RagContexts.Context.Builder setSourceUri(String value)

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;

Parameter
Name	Description
value	String The sourceUri to set.

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setSourceUriBytes(ByteString value)

public RagContexts.Context.Builder setSourceUriBytes(ByteString value)

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;

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

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setSparseDistance(double value) (deprecated)

public RagContexts.Context.Builder setSparseDistance(double value)

Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.sparse_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=185

The distance between the query sparse embedding vector and the context text vector.

double sparse_distance = 4 [deprecated = true];

Parameter
Name	Description
value	double The sparseDistance to set.

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setText(String value)

public RagContexts.Context.Builder setText(String value)

The text chunk.

string text = 2;

Parameter
Name	Description
value	String The text to set.

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setTextBytes(ByteString value)

public RagContexts.Context.Builder setTextBytes(ByteString value)

The text chunk.

string text = 2;

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

Returns
Type	Description
RagContexts.Context.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final RagContexts.Context.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
RagContexts.Context.Builder

Overrides

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