public sealed class Fact : IMessage<Fact>, IEquatable<Fact>, IDeepCloneable<Fact>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1beta1 API class Fact.
The fact used in grounding.
Namespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
Fact()
public Fact()Fact(Fact)
public Fact(Fact other)| Parameter | |
|---|---|
| Name | Description |
other |
Fact |
Properties
HasQuery
public bool HasQuery { get; }Gets whether the "query" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasScore
public bool HasScore { get; }Gets whether the "score" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasSummary
public bool HasSummary { get; }Gets whether the "summary" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasTitle
public bool HasTitle { get; }Gets whether the "title" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasUri
public bool HasUri { get; }Gets whether the "uri" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasVectorDistance
[Obsolete]
public bool HasVectorDistance { get; }Gets whether the "vector_distance" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Query
public string Query { get; set; }Query that is used to retrieve this fact.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Score
public double Score { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
double |
|
Summary
public string Summary { get; set; }If present, the summary/snippet of the fact.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Title
public string Title { get; set; }If present, it refers to the title of this fact.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Uri
public string Uri { get; set; }If present, this uri links to the source of the fact.
| Property Value | |
|---|---|
| Type | Description |
string |
|
VectorDistance
[Obsolete]
public double VectorDistance { get; set; }If present, the distance between the query vector and this fact vector.
| Property Value | |
|---|---|
| Type | Description |
double |
|