com.google.cloud.aiplatform.v1beta1

Class RagContexts.Context

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

RagContexts.ContextOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

RagContexts

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

 A context of the query.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RagContexts.Context.Builder A context of the query.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISTANCE_FIELD_NUMBER
static int	SCORE_FIELD_NUMBER
static int	SOURCE_DISPLAY_NAME_FIELD_NUMBER
static int	SOURCE_URI_FIELD_NUMBER
static int	SPARSE_DISTANCE_FIELD_NUMBER
static int	TEXT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static RagContexts.Context	getDefaultInstance()
RagContexts.Context	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
double	getDistance() Deprecated. google.cloud.aiplatform.v1beta1.RagContexts.Context.distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=181
com.google.protobuf.Parser<RagContexts.Context>	getParserForType()
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.
int	getSerializedSize()
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.
int	hashCode()
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()
static RagContexts.Context.Builder	newBuilder()
static RagContexts.Context.Builder	newBuilder(RagContexts.Context prototype)
RagContexts.Context.Builder	newBuilderForType()
protected RagContexts.Context.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RagContexts.Context	parseDelimitedFrom(InputStream input)
static RagContexts.Context	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagContexts.Context	parseFrom(byte[] data)
static RagContexts.Context	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagContexts.Context	parseFrom(ByteBuffer data)
static RagContexts.Context	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagContexts.Context	parseFrom(com.google.protobuf.ByteString data)
static RagContexts.Context	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagContexts.Context	parseFrom(com.google.protobuf.CodedInputStream input)
static RagContexts.Context	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RagContexts.Context	parseFrom(InputStream input)
static RagContexts.Context	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RagContexts.Context>	parser()
RagContexts.Context.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SOURCE_URI_FIELD_NUMBER

public static final int SOURCE_URI_FIELD_NUMBER

See Also:

Constant Field Values

SOURCE_DISPLAY_NAME_FIELD_NUMBER

public static final int SOURCE_DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER

See Also:

Constant Field Values

DISTANCE_FIELD_NUMBER

public static final int DISTANCE_FIELD_NUMBER

See Also:

Constant Field Values

SPARSE_DISTANCE_FIELD_NUMBER

public static final int SPARSE_DISTANCE_FIELD_NUMBER

See Also:

Constant Field Values

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static RagContexts.Context parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagContexts.Context parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagContexts.Context parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagContexts.Context parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagContexts.Context parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagContexts.Context parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RagContexts.Context parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static RagContexts.Context parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static RagContexts.Context parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static RagContexts.Context parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static RagContexts.Context parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RagContexts.Context.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RagContexts.Context.Builder newBuilder()

newBuilder

public static RagContexts.Context.Builder newBuilder(RagContexts.Context prototype)

toBuilder

public RagContexts.Context.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RagContexts.Context.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RagContexts.Context getDefaultInstance()

parser

public static com.google.protobuf.Parser<RagContexts.Context> parser()

getParserForType

public com.google.protobuf.Parser<RagContexts.Context> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public RagContexts.Context getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder