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 |
VertexAISearch
Set to use data source powered by Vertex AI Search. |
↳ vertex_rag_store |
VertexRagStore
Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. |
↳ disable_attribution |
bool
Optional. Deprecated. This option is no longer supported. |
getVertexAiSearch
Set to use data source powered by Vertex AI Search.
Returns | |
---|---|
Type | Description |
VertexAISearch|null |
hasVertexAiSearch
setVertexAiSearch
Set to use data source powered by Vertex AI Search.
Parameter | |
---|---|
Name | Description |
var |
VertexAISearch
|
Returns | |
---|---|
Type | Description |
$this |
getVertexRagStore
Set to use data source powered by Vertex RAG store.
User data is uploaded via the VertexRagDataService.
Returns | |
---|---|
Type | Description |
VertexRagStore|null |
hasVertexRagStore
setVertexRagStore
Set to use data source powered by Vertex RAG store.
User data is uploaded via the VertexRagDataService.
Parameter | |
---|---|
Name | Description |
var |
VertexRagStore
|
Returns | |
---|---|
Type | Description |
$this |
getDisableAttribution
Optional. Deprecated. This option is no longer supported.
Returns | |
---|---|
Type | Description |
bool |
setDisableAttribution
Optional. Deprecated. This option is no longer supported.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getSource
Returns | |
---|---|
Type | Description |
string |