com.google.cloud.aiplatform.v1beta1

Interface FactOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Fact, Fact.Builder

public interface FactOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getQuery() Query that is used to retrieve this fact.
com.google.protobuf.ByteString	getQueryBytes() Query that is used to retrieve this fact.
double	getScore() If present, 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 fact and its range depends on the metric type.
String	getSummary() If present, the summary/snippet of the fact.
com.google.protobuf.ByteString	getSummaryBytes() If present, the summary/snippet of the fact.
String	getTitle() If present, it refers to the title of this fact.
com.google.protobuf.ByteString	getTitleBytes() If present, it refers to the title of this fact.
String	getUri() If present, this uri links to the source of the fact.
com.google.protobuf.ByteString	getUriBytes() If present, this uri links to the source of the fact.
double	getVectorDistance() Deprecated. google.cloud.aiplatform.v1beta1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=314
boolean	hasQuery() Query that is used to retrieve this fact.
boolean	hasScore() If present, 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 fact and its range depends on the metric type.
boolean	hasSummary() If present, the summary/snippet of the fact.
boolean	hasTitle() If present, it refers to the title of this fact.
boolean	hasUri() If present, this uri links to the source of the fact.
boolean	hasVectorDistance() Deprecated. google.cloud.aiplatform.v1beta1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=314

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasQuery

boolean hasQuery()

 Query that is used to retrieve this fact.
 

optional string query = 1;

Returns:

Whether the query field is set.

getQuery

String getQuery()

 Query that is used to retrieve this fact.
 

optional string query = 1;

Returns:

The query.

getQueryBytes

com.google.protobuf.ByteString getQueryBytes()

 Query that is used to retrieve this fact.
 

optional string query = 1;

Returns:

The bytes for query.

hasTitle

boolean hasTitle()

 If present, it refers to the title of this fact.
 

optional string title = 2;

Returns:

Whether the title field is set.

getTitle

String getTitle()

 If present, it refers to the title of this fact.
 

optional string title = 2;

Returns:

The title.

getTitleBytes

com.google.protobuf.ByteString getTitleBytes()

 If present, it refers to the title of this fact.
 

optional string title = 2;

Returns:

The bytes for title.

hasUri

boolean hasUri()

 If present, this uri links to the source of the fact.
 

optional string uri = 3;

Returns:

Whether the uri field is set.

getUri

String getUri()

 If present, this uri links to the source of the fact.
 

optional string uri = 3;

Returns:

The uri.

getUriBytes

com.google.protobuf.ByteString getUriBytes()

 If present, this uri links to the source of the fact.
 

optional string uri = 3;

Returns:

The bytes for uri.

hasSummary

boolean hasSummary()

 If present, the summary/snippet of the fact.
 

optional string summary = 4;

Returns:

Whether the summary field is set.

getSummary

String getSummary()

 If present, the summary/snippet of the fact.
 

optional string summary = 4;

Returns:

The summary.

getSummaryBytes

com.google.protobuf.ByteString getSummaryBytes()

 If present, the summary/snippet of the fact.
 

optional string summary = 4;

Returns:

The bytes for summary.

hasVectorDistance

@Deprecated
boolean hasVectorDistance()

Deprecated. google.cloud.aiplatform.v1beta1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=314

 If present, the distance between the query vector and this fact vector.
 

optional double vector_distance = 5 [deprecated = true];

Returns:

Whether the vectorDistance field is set.

getVectorDistance

@Deprecated
double getVectorDistance()

Deprecated. google.cloud.aiplatform.v1beta1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1beta1/vertex_rag_service.proto;l=314

 If present, the distance between the query vector and this fact vector.
 

optional double vector_distance = 5 [deprecated = true];

Returns:

The vectorDistance.

hasScore

boolean hasScore()

 If present, 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 fact 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 fact. The larger the distance, the less
 relevant the fact 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:

Whether the score field is set.

getScore

double getScore()

 If present, 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 fact 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 fact. The larger the distance, the less
 relevant the fact 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:

The score.