Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DynamicRetrievalPredictorMetadata.
Describes the metadata about the dynamic retrieval predictor.
Generated from protobuf message google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.DynamicRetrievalPredictorMetadata
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ GenerateGroundedContentResponse \ Candidate \ GroundingMetadataMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ version |
int
The version of the predictor which was used in dynamic retrieval. |
↳ prediction |
float
The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most. In between values allow to differentiate between different usefulness scores for grounding. |
getVersion
The version of the predictor which was used in dynamic retrieval.
| Returns | |
|---|---|
| Type | Description |
int |
|
setVersion
The version of the predictor which was used in dynamic retrieval.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrediction
The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most.
In between values allow to differentiate between different usefulness scores for grounding.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasPrediction
clearPrediction
setPrediction
The value of the predictor. This should be between [0, 1] where a value of 0 means that the query would not benefit from grounding, while a value of 1.0 means that the query would benefit the most.
In between values allow to differentiate between different usefulness scores for grounding.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|