Google Cloud Discovery Engine V1 Client - Class RetrievalMetadata (1.3.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class RetrievalMetadata.

Describes the metadata associated with a retrieval step.

Generated from protobuf message google.cloud.discoveryengine.v1.GenerateGroundedContentResponse.Candidate.GroundingMetadata.RetrievalMetadata

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ GenerateGroundedContentResponse \ Candidate \ GroundingMetadata

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ source int

Describes the source to which the metadata is referring to.
↳ dynamic_retrieval_metadata Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalMetadata

Metadata for dynamic retrieval.

getSource

Describes the source to which the metadata is referring to.

Returns
Type Description
int

setSource

Describes the source to which the metadata is referring to.

Parameter
Name Description
var int
Returns
Type Description
$this

getDynamicRetrievalMetadata

Metadata for dynamic retrieval.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalMetadata|null

hasDynamicRetrievalMetadata

clearDynamicRetrievalMetadata

setDynamicRetrievalMetadata

Metadata for dynamic retrieval.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\GenerateGroundedContentResponse\Candidate\GroundingMetadata\DynamicRetrievalMetadata
Returns
Type Description
$this