Google Cloud Ai Platform V1 Client - Class Retrieval (0.37.1)

Version 0.37.1

• 1.13.1 (latest)
• 1.13.0
• 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 Retrieval.

Defines a retrieval tool that model can call to access external knowledge.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ vertex_ai_search	Google\Cloud\AIPlatform\V1\VertexAISearch Set to use data source powered by Vertex AI Search.
↳ disable_attribution	bool Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.

getVertexAiSearch

Set to use data source powered by Vertex AI Search.

Returns
Type	Description
Google\Cloud\AIPlatform\V1\VertexAISearch|null

hasVertexAiSearch

setVertexAiSearch

Set to use data source powered by Vertex AI Search.

Parameter
Name	Description
var	Google\Cloud\AIPlatform\V1\VertexAISearch

Returns
Type	Description
$this

getDisableAttribution

Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.

Returns
Type	Description
bool

setDisableAttribution

Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getSource

Returns
Type	Description
string