Class RagContexts.Context (3.52.0)

public static final class RagContexts.Context extends GeneratedMessageV3 implements RagContexts.ContextOrBuilder

A context of the query.

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

Static Fields

DISTANCE_FIELD_NUMBER

public static final int DISTANCE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_URI_FIELD_NUMBER

public static final int SOURCE_URI_FIELD_NUMBER
Field Value
Type Description
int

SPARSE_DISTANCE_FIELD_NUMBER

public static final int SPARSE_DISTANCE_FIELD_NUMBER
Field Value
Type Description
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RagContexts.Context getDefaultInstance()
Returns
Type Description
RagContexts.Context

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RagContexts.Context.Builder newBuilder()
Returns
Type Description
RagContexts.Context.Builder

newBuilder(RagContexts.Context prototype)

public static RagContexts.Context.Builder newBuilder(RagContexts.Context prototype)
Parameter
Name Description
prototype RagContexts.Context
Returns
Type Description
RagContexts.Context.Builder

parseDelimitedFrom(InputStream input)

public static RagContexts.Context parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContexts.Context parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RagContexts.Context parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RagContexts.Context parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RagContexts.Context parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RagContexts.Context parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RagContexts.Context parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContexts.Context parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RagContexts.Context parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RagContexts.Context parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RagContexts.Context parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RagContexts.Context parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RagContexts.Context
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RagContexts.Context> parser()
Returns
Type Description
Parser<Context>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RagContexts.Context getDefaultInstanceForType()
Returns
Type Description
RagContexts.Context

getDistance()

public double getDistance()

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

double distance = 3;

Returns
Type Description
double

The distance.

getParserForType()

public Parser<RagContexts.Context> getParserForType()
Returns
Type Description
Parser<Context>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceUri()

public String getSourceUri()

For vertex RagStore, 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()

For vertex RagStore, 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()

public double getSparseDistance()

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

double sparse_distance = 4;

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RagContexts.Context.Builder newBuilderForType()
Returns
Type Description
RagContexts.Context.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RagContexts.Context.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RagContexts.Context.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RagContexts.Context.Builder toBuilder()
Returns
Type Description
RagContexts.Context.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException