Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Fact.
The fact used in grounding.
Generated from protobuf message google.cloud.aiplatform.v1.Fact
Namespace
Google \ Cloud \ AIPlatform \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ query |
string
Query that is used to retrieve this fact. |
↳ title |
string
If present, it refers to the title of this fact. |
↳ uri |
string
If present, this uri links to the source of the fact. |
↳ summary |
string
If present, the summary/snippet of the fact. |
↳ vector_distance |
float
If present, the distance between the query vector and this fact vector. |
↳ score |
float
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. |
getQuery
Query that is used to retrieve this fact.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasQuery
clearQuery
setQuery
Query that is used to retrieve this fact.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTitle
If present, it refers to the title of this fact.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTitle
clearTitle
setTitle
If present, it refers to the title of this fact.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUri
If present, this uri links to the source of the fact.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasUri
clearUri
setUri
If present, this uri links to the source of the fact.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSummary
If present, the summary/snippet of the fact.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSummary
clearSummary
setSummary
If present, the summary/snippet of the fact.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVectorDistance
If present, the distance between the query vector and this fact vector.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasVectorDistance
clearVectorDistance
setVectorDistance
If present, the distance between the query vector and this fact vector.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasScore
clearScore
setScore
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.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|