Interface RagContexts.ContextOrBuilder (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 interface RagContexts.ContextOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDistance() (deprecated)

public abstract 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 abstract 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 abstract String getSourceDisplayName()

The file display name.

string source_display_name = 5;

Returns
Type	Description
String	The sourceDisplayName.

getSourceDisplayNameBytes()

public abstract ByteString getSourceDisplayNameBytes()

The file display name.

string source_display_name = 5;

Returns
Type	Description
ByteString	The bytes for sourceDisplayName.

getSourceUri()

public abstract 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 abstract 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 abstract 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 abstract String getText()

The text chunk.

string text = 2;

Returns
Type	Description
String	The text.

getTextBytes()

public abstract ByteString getTextBytes()

The text chunk.

string text = 2;

Returns
Type	Description
ByteString	The bytes for text.

hasScore()

public abstract 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.