Class RagContexts.Context (3.77.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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CHUNK_FIELD_NUMBER
public static final int CHUNK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISTANCE_FIELD_NUMBER
public static final int DISTANCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SCORE_FIELD_NUMBER
public static final int SCORE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOURCE_DISPLAY_NAME_FIELD_NUMBER
public static final int SOURCE_DISPLAY_NAME_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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RagContexts.Context.Builder newBuilder()
newBuilder(RagContexts.Context prototype)
public static RagContexts.Context.Builder newBuilder(RagContexts.Context prototype)
parseDelimitedFrom(InputStream input)
public static RagContexts.Context parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RagContexts.Context parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RagContexts.Context parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RagContexts.Context parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RagContexts.Context parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RagContexts.Context parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static RagContexts.Context parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RagContexts.Context parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static RagContexts.Context parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static RagContexts.Context parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RagContexts.Context parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RagContexts.Context parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RagContexts.Context> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getChunk()
public RagChunk getChunk()
Context of the retrieved chunk.
.google.cloud.aiplatform.v1beta1.RagChunk chunk = 7;
| Returns |
| Type |
Description |
RagChunk |
The chunk.
|
getChunkOrBuilder()
public RagChunkOrBuilder getChunkOrBuilder()
Context of the retrieved chunk.
.google.cloud.aiplatform.v1beta1.RagChunk chunk = 7;
getDefaultInstanceForType()
public RagContexts.Context getDefaultInstanceForType()
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=182
The distance between the query dense embedding vector and the context
text vector.
double distance = 3 [deprecated = true];
| Returns |
| Type |
Description |
double |
The distance.
|
getParserForType()
public Parser<RagContexts.Context> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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=186
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()
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.
|
hasChunk()
public boolean hasChunk()
Context of the retrieved chunk.
.google.cloud.aiplatform.v1beta1.RagChunk chunk = 7;
| Returns |
| Type |
Description |
boolean |
Whether the chunk field is set.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RagContexts.Context.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RagContexts.Context.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public RagContexts.Context.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
