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 \ V1Methods
__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 |
|