Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata.
Citation for the generated content.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#grounding_support
def grounding_support() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::GroundingSupport>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::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.
#grounding_support=
def grounding_support=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::GroundingSupport>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1::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.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::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.
#retrieval_metadata
def retrieval_metadata() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::RetrievalMetadata>
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::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.
#retrieval_metadata=
def retrieval_metadata=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::RetrievalMetadata>
Parameter
- value (::Array<::Google::Cloud::DiscoveryEngine::V1::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.
Returns
- (::Array<::Google::Cloud::DiscoveryEngine::V1::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.
#search_entry_point
def search_entry_point() -> ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::SearchEntryPoint
Returns
- (::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::SearchEntryPoint) — Google search entry for the following-up web searches.
#search_entry_point=
def search_entry_point=(value) -> ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::SearchEntryPoint
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::SearchEntryPoint) — Google search entry for the following-up web searches.
Returns
- (::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse::Candidate::GroundingMetadata::SearchEntryPoint) — Google search entry for the following-up web searches.
#support_chunks
def support_chunks() -> ::Array<::Google::Cloud::DiscoveryEngine::V1::FactChunk>
Returns
- (::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.
#support_chunks=
def support_chunks=(value) -> ::Array<::Google::Cloud::DiscoveryEngine::V1::FactChunk>
Parameter
- value (::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.
Returns
- (::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
def web_search_queries() -> ::Array<::String>
Returns
- (::Array<::String>) — Web search queries for the following-up web search.
#web_search_queries=
def web_search_queries=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Web search queries for the following-up web search.
Returns
- (::Array<::String>) — Web search queries for the following-up web search.