com.google.cloud.aiplatform.v1beta1

Class RagContexts.Context.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

com.google.cloud.aiplatform.v1beta1.RagContexts.Context.Builder

All Implemented Interfaces:

RagContexts.ContextOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

RagContexts.Context

public static final class RagContexts.Context.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>
implements RagContexts.ContextOrBuilder

 A context of the query.
 

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

Method Summary

Modifier and Type	Method and Description
RagContexts.Context.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RagContexts.Context	build()
RagContexts.Context	buildPartial()
RagContexts.Context.Builder	clear()
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
RagContexts.Context.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RagContexts.Context.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
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.
RagContexts.Context.Builder	clearSourceDisplayName() The file display name.
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.
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
RagContexts.Context.Builder	clearText() The text chunk.
RagContexts.Context.Builder	clone()
RagContexts.Context	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
double	getDistance() Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=181
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.
String	getSourceDisplayName() The file display name.
com.google.protobuf.ByteString	getSourceDisplayNameBytes() The file display name.
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.
com.google.protobuf.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.
double	getSparseDistance() Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.sparse_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=185
String	getText() The text chunk.
com.google.protobuf.ByteString	getTextBytes() The text chunk.
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RagContexts.Context.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RagContexts.Context.Builder	mergeFrom(com.google.protobuf.Message other)
RagContexts.Context.Builder	mergeFrom(RagContexts.Context other)
RagContexts.Context.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
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
RagContexts.Context.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RagContexts.Context.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
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.
RagContexts.Context.Builder	setSourceDisplayName(String value) The file display name.
RagContexts.Context.Builder	setSourceDisplayNameBytes(com.google.protobuf.ByteString value) The file display name.
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.
RagContexts.Context.Builder	setSourceUriBytes(com.google.protobuf.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.
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
RagContexts.Context.Builder	setText(String value) The text chunk.
RagContexts.Context.Builder	setTextBytes(com.google.protobuf.ByteString value) The text chunk.
RagContexts.Context.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

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, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

clear

public RagContexts.Context.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

getDefaultInstanceForType

public RagContexts.Context getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RagContexts.Context build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RagContexts.Context buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RagContexts.Context.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

clearField

public RagContexts.Context.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

clearOneof

public RagContexts.Context.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

addRepeatedField

public RagContexts.Context.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                    Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

mergeFrom

public RagContexts.Context.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RagContexts.Context.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

mergeFrom

public RagContexts.Context.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RagContexts.Context.Builder>

Throws:

IOException

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;

Specified by:

getSourceUri in interface RagContexts.ContextOrBuilder

Returns:

The sourceUri.

getSourceUriBytes

public com.google.protobuf.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;

Specified by:

getSourceUriBytes in interface RagContexts.ContextOrBuilder

Returns:

The bytes for sourceUri.

setSourceUri

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;

Parameters:

value - The sourceUri to set.

Returns:

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:

This builder for chaining.

setSourceUriBytes

public RagContexts.Context.Builder setSourceUriBytes(com.google.protobuf.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;

Parameters:

value - The bytes for sourceUri to set.

Returns:

This builder for chaining.

getSourceDisplayName

public String getSourceDisplayName()

 The file display name.
 

string source_display_name = 5;

Specified by:

getSourceDisplayName in interface RagContexts.ContextOrBuilder

Returns:

The sourceDisplayName.

getSourceDisplayNameBytes

public com.google.protobuf.ByteString getSourceDisplayNameBytes()

 The file display name.
 

string source_display_name = 5;

Specified by:

getSourceDisplayNameBytes in interface RagContexts.ContextOrBuilder

Returns:

The bytes for sourceDisplayName.

setSourceDisplayName

public RagContexts.Context.Builder setSourceDisplayName(String value)

 The file display name.
 

string source_display_name = 5;

Parameters:

value - The sourceDisplayName to set.

Returns:

This builder for chaining.

clearSourceDisplayName

public RagContexts.Context.Builder clearSourceDisplayName()

 The file display name.
 

string source_display_name = 5;

Returns:

This builder for chaining.

setSourceDisplayNameBytes

public RagContexts.Context.Builder setSourceDisplayNameBytes(com.google.protobuf.ByteString value)

 The file display name.
 

string source_display_name = 5;

Parameters:

value - The bytes for sourceDisplayName to set.

Returns:

This builder for chaining.

getText

public String getText()

 The text chunk.
 

string text = 2;

Specified by:

getText in interface RagContexts.ContextOrBuilder

Returns:

The text.

getTextBytes

public com.google.protobuf.ByteString getTextBytes()

 The text chunk.
 

string text = 2;

Specified by:

getTextBytes in interface RagContexts.ContextOrBuilder

Returns:

The bytes for text.

setText

public RagContexts.Context.Builder setText(String value)

 The text chunk.
 

string text = 2;

Parameters:

value - The text to set.

Returns:

This builder for chaining.

clearText

public RagContexts.Context.Builder clearText()

 The text chunk.
 

string text = 2;

Returns:

This builder for chaining.

setTextBytes

public RagContexts.Context.Builder setTextBytes(com.google.protobuf.ByteString value)

 The text chunk.
 

string text = 2;

Parameters:

value - The bytes for text to set.

Returns:

This builder for chaining.

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

Specified by:

getDistance in interface RagContexts.ContextOrBuilder

Returns:

The distance.

setDistance

@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];

Parameters:

value - The distance to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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

Specified by:

getSparseDistance in interface RagContexts.ContextOrBuilder

Returns:

The sparseDistance.

setSparseDistance

@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];

Parameters:

value - The sparseDistance to set.

Returns:

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:

This builder for chaining.

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;

Specified by:

hasScore in interface RagContexts.ContextOrBuilder

Returns:

Whether the score field is set.

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;

Specified by:

getScore in interface RagContexts.ContextOrBuilder

Returns:

The score.

setScore

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;

Parameters:

value - The score to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setUnknownFields

public final RagContexts.Context.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>

mergeUnknownFields

public final RagContexts.Context.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RagContexts.Context.Builder>