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

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
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ sourceint

Describes the source to which the metadata is referring to.

↳ dynamic_retrieval_metadataDynamicRetrievalMetadata

Metadata for dynamic retrieval.

getSource

Describes the source to which the metadata is referring to.

Returns
TypeDescription
int

setSource

Describes the source to which the metadata is referring to.

Parameter
NameDescription
varint
Returns
TypeDescription
$this

getDynamicRetrievalMetadata

Metadata for dynamic retrieval.

Returns
TypeDescription
DynamicRetrievalMetadata|null

hasDynamicRetrievalMetadata

clearDynamicRetrievalMetadata

setDynamicRetrievalMetadata

Metadata for dynamic retrieval.

Parameter
NameDescription
varDynamicRetrievalMetadata
Returns
TypeDescription
$this