Google Cloud Discovery Engine V1 Client - Class GroundingMetadata (1.3.2)

Version latest

• 1.3.2 (latest)
• 1.3.1
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

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

Citation for the generated content.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ GenerateGroundedContentResponse \ Candidate

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ retrieval_metadata	array<GroundingMetadata\RetrievalMetadata> Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.
↳ support_chunks	array<Google\Cloud\DiscoveryEngine\V1\FactChunk> List of chunks to be attributed across all claims in the candidate. These are derived from the grounding sources supplied in the request.
↳ web_search_queries	array Web search queries for the following-up web search.
↳ search_entry_point	GroundingMetadata\SearchEntryPoint Google search entry for the following-up web searches.
↳ grounding_support	array<GroundingMetadata\GroundingSupport> GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

getRetrievalMetadata

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setRetrievalMetadata

Retrieval metadata to provide an understanding in the retrieval steps performed by the model. There can be multiple such messages which can correspond to different parts of the retrieval. This is a mechanism used to ensure transparency to our users.

Parameter
Name	Description
var	array<GroundingMetadata\RetrievalMetadata>

Returns
Type	Description
$this

getSupportChunks

List of chunks to be attributed across all claims in the candidate.

These are derived from the grounding sources supplied in the request.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setSupportChunks

List of chunks to be attributed across all claims in the candidate.

These are derived from the grounding sources supplied in the request.

Parameter
Name	Description
var	array<Google\Cloud\DiscoveryEngine\V1\FactChunk>

Returns
Type	Description
$this

getWebSearchQueries

Web search queries for the following-up web search.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setWebSearchQueries

Web search queries for the following-up web search.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getSearchEntryPoint

Google search entry for the following-up web searches.

Returns
Type	Description
GroundingMetadata\SearchEntryPoint|null

hasSearchEntryPoint

clearSearchEntryPoint

setSearchEntryPoint

Google search entry for the following-up web searches.

Parameter
Name	Description
var	GroundingMetadata\SearchEntryPoint

Returns
Type	Description
$this

getGroundingSupport

GroundingSupport across all claims in the answer candidate.

An support to a fact indicates that the claim is supported by the fact.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setGroundingSupport

GroundingSupport across all claims in the answer candidate.

An support to a fact indicates that the claim is supported by the fact.

Parameter
Name	Description
var	array<GroundingMetadata\GroundingSupport>

Returns
Type	Description
$this