Class GroundingMetadata (0.12.3)

GroundingMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Citation for the generated content.

Attributes

Name Description
retrieval_metadata MutableSequence[google.cloud.discoveryengine_v1.types.GenerateGroundedContentResponse.Candidate.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 MutableSequence[google.cloud.discoveryengine_v1.types.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 MutableSequence[str]
Web search queries for the following-up web search.
search_entry_point google.cloud.discoveryengine_v1.types.GenerateGroundedContentResponse.Candidate.GroundingMetadata.SearchEntryPoint
Google search entry for the following-up web searches.
grounding_support MutableSequence[google.cloud.discoveryengine_v1.types.GenerateGroundedContentResponse.Candidate.GroundingMetadata.GroundingSupport]
GroundingSupport across all claims in the answer candidate. An support to a fact indicates that the claim is supported by the fact.

Classes

DynamicRetrievalMetadata

DynamicRetrievalMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Describes the metadata about dynamic retrieval.

DynamicRetrievalPredictorMetadata

DynamicRetrievalPredictorMetadata(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Describes the metadata about the dynamic retrieval predictor.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GroundingSupport

GroundingSupport(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Grounding info for a claim in the candidate and its support.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RetrievalMetadata

RetrievalMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Describes the metadata associated with a retrieval step.

SearchEntryPoint

SearchEntryPoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Google search entry point.