Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::GroundingMetadata.
Metadata returned to client when grounding is enabled.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#google_maps_widget_context_token
def google_maps_widget_context_token() -> ::String
Returns
- (::String) — Optional. Output only. Resource name of the Google Maps widget context token to be used with the PlacesContextElement widget to render contextual data. This is populated only for Google Maps grounding.
#grounding_chunks
def grounding_chunks() -> ::Array<::Google::Cloud::AIPlatform::V1::GroundingChunk>
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::GroundingChunk>) — List of supporting references retrieved from specified grounding source.
#grounding_chunks=
def grounding_chunks=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::GroundingChunk>
Parameter
- value (::Array<::Google::Cloud::AIPlatform::V1::GroundingChunk>) — List of supporting references retrieved from specified grounding source.
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::GroundingChunk>) — List of supporting references retrieved from specified grounding source.
#grounding_supports
def grounding_supports() -> ::Array<::Google::Cloud::AIPlatform::V1::GroundingSupport>
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::GroundingSupport>) — Optional. List of grounding support.
#grounding_supports=
def grounding_supports=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::GroundingSupport>
Parameter
- value (::Array<::Google::Cloud::AIPlatform::V1::GroundingSupport>) — Optional. List of grounding support.
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::GroundingSupport>) — Optional. List of grounding support.
#retrieval_metadata
def retrieval_metadata() -> ::Google::Cloud::AIPlatform::V1::RetrievalMetadata
Returns
- (::Google::Cloud::AIPlatform::V1::RetrievalMetadata) — Optional. Output only. Retrieval metadata.
#search_entry_point
def search_entry_point() -> ::Google::Cloud::AIPlatform::V1::SearchEntryPoint
Returns
- (::Google::Cloud::AIPlatform::V1::SearchEntryPoint) — Optional. Google search entry for the following-up web searches.
#search_entry_point=
def search_entry_point=(value) -> ::Google::Cloud::AIPlatform::V1::SearchEntryPoint
Parameter
- value (::Google::Cloud::AIPlatform::V1::SearchEntryPoint) — Optional. Google search entry for the following-up web searches.
Returns
- (::Google::Cloud::AIPlatform::V1::SearchEntryPoint) — Optional. Google search entry for the following-up web searches.
#source_flagging_uris
def source_flagging_uris() -> ::Array<::Google::Cloud::AIPlatform::V1::GroundingMetadata::SourceFlaggingUri>
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::GroundingMetadata::SourceFlaggingUri>) — List of source flagging uris. This is currently populated only for Google Maps grounding.
#source_flagging_uris=
def source_flagging_uris=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::GroundingMetadata::SourceFlaggingUri>
Parameter
- value (::Array<::Google::Cloud::AIPlatform::V1::GroundingMetadata::SourceFlaggingUri>) — List of source flagging uris. This is currently populated only for Google Maps grounding.
Returns
- (::Array<::Google::Cloud::AIPlatform::V1::GroundingMetadata::SourceFlaggingUri>) — List of source flagging uris. This is currently populated only for Google Maps grounding.
#web_search_queries
def web_search_queries() -> ::Array<::String>
Returns
- (::Array<::String>) — Optional. Web search queries for the following-up web search.
#web_search_queries=
def web_search_queries=(value) -> ::Array<::String>
Parameter
- value (::Array<::String>) — Optional. Web search queries for the following-up web search.
Returns
- (::Array<::String>) — Optional. Web search queries for the following-up web search.