Google Cloud Ai Platform V1 Client - Class GroundingMetadata (1.34.0)

Version latest

• 1.34.0 (latest)
• 1.33.0
• 1.32.1
• 1.31.0
• 1.30.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class GroundingMetadata.

Metadata returned to client when grounding is enabled.

Generated from protobuf message google.cloud.aiplatform.v1.GroundingMetadata

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ web_search_queries	array Optional. Web search queries for the following-up web search.
↳ search_entry_point	SearchEntryPoint Optional. Google search entry for the following-up web searches.
↳ grounding_chunks	array<GroundingChunk> List of supporting references retrieved from specified grounding source.
↳ grounding_supports	array<GroundingSupport> Optional. List of grounding support.
↳ retrieval_metadata	RetrievalMetadata Optional. Output only. Retrieval metadata.
↳ google_maps_widget_context_token	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.

getWebSearchQueries

Optional. Web search queries for the following-up web search.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setWebSearchQueries

Optional. Web search queries for the following-up web search.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getSearchEntryPoint

Optional. Google search entry for the following-up web searches.

Returns
Type	Description
SearchEntryPoint|null

hasSearchEntryPoint

clearSearchEntryPoint

setSearchEntryPoint

Optional. Google search entry for the following-up web searches.

Parameter
Name	Description
var	SearchEntryPoint

Returns
Type	Description
$this

getGroundingChunks

List of supporting references retrieved from specified grounding source.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setGroundingChunks

List of supporting references retrieved from specified grounding source.

Parameter
Name	Description
var	array<GroundingChunk>

Returns
Type	Description
$this

getGroundingSupports

Optional. List of grounding support.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setGroundingSupports

Optional. List of grounding support.

Parameter
Name	Description
var	array<GroundingSupport>

Returns
Type	Description
$this

getRetrievalMetadata

Optional. Output only. Retrieval metadata.

Returns
Type	Description
RetrievalMetadata|null

hasRetrievalMetadata

clearRetrievalMetadata

setRetrievalMetadata

Optional. Output only. Retrieval metadata.

Parameter
Name	Description
var	RetrievalMetadata

Returns
Type	Description
$this

getGoogleMapsWidgetContextToken

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.

Returns
Type	Description
string

hasGoogleMapsWidgetContextToken

clearGoogleMapsWidgetContextToken

setGoogleMapsWidgetContextToken

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this