Google Cloud Ai Platform V1 Client - Class GroundingMetadata (1.3.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 Google\Cloud\AIPlatform\V1\SearchEntryPoint

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

↳ grounding_chunks array<Google\Cloud\AIPlatform\V1\GroundingChunk>

List of supporting references retrieved from specified grounding source.

↳ grounding_supports array<Google\Cloud\AIPlatform\V1\GroundingSupport>

Optional. List of grounding support.

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
Google\Cloud\AIPlatform\V1\SearchEntryPoint|null

hasSearchEntryPoint

clearSearchEntryPoint

setSearchEntryPoint

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

Parameter
Name Description
var Google\Cloud\AIPlatform\V1\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<Google\Cloud\AIPlatform\V1\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<Google\Cloud\AIPlatform\V1\GroundingSupport>
Returns
Type Description
$this