- 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 interface FactOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getQuery()
public abstract String getQuery()Query that is used to retrieve this fact.
optional string query = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public abstract ByteString getQueryBytes()Query that is used to retrieve this fact.
optional string query = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for query. |
getScore()
public abstract 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 | |
|---|---|
| Type | Description |
double |
The score. |
getSummary()
public abstract String getSummary()If present, the summary/snippet of the fact.
optional string summary = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The summary. |
getSummaryBytes()
public abstract ByteString getSummaryBytes()If present, the summary/snippet of the fact.
optional string summary = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for summary. |
getTitle()
public abstract String getTitle()If present, it refers to the title of this fact.
optional string title = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The title. |
getTitleBytes()
public abstract ByteString getTitleBytes()If present, it refers to the title of this fact.
optional string title = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for title. |
getUri()
public abstract String getUri()If present, this uri links to the source of the fact.
optional string uri = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The uri. |
getUriBytes()
public abstract ByteString getUriBytes()If present, this uri links to the source of the fact.
optional string uri = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for uri. |
getVectorDistance() (deprecated)
public abstract double getVectorDistance()Deprecated. google.cloud.aiplatform.v1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1/vertex_rag_service.proto;l=284
If present, the distance between the query vector and this fact vector.
optional double vector_distance = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
double |
The vectorDistance. |
hasQuery()
public abstract boolean hasQuery()Query that is used to retrieve this fact.
optional string query = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the query field is set. |
hasScore()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the score field is set. |
hasSummary()
public abstract boolean hasSummary()If present, the summary/snippet of the fact.
optional string summary = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the summary field is set. |
hasTitle()
public abstract boolean hasTitle()If present, it refers to the title of this fact.
optional string title = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the title field is set. |
hasUri()
public abstract boolean hasUri()If present, this uri links to the source of the fact.
optional string uri = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the uri field is set. |
hasVectorDistance() (deprecated)
public abstract boolean hasVectorDistance()Deprecated. google.cloud.aiplatform.v1.Fact.vector_distance is deprecated. See google/cloud/aiplatform/v1/vertex_rag_service.proto;l=284
If present, the distance between the query vector and this fact vector.
optional double vector_distance = 5 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vectorDistance field is set. |