Interface Retrieval

Defines a retrieval tool that model can call to access external knowledge. This data type is not supported in Gemini API.

interface Retrieval {
    disableAttribution?: boolean;
    externalApi?: ExternalApi;
    vertexAiSearch?: VertexAISearch;
    vertexRagStore?: VertexRagStore;
}

Properties

disableAttribution? externalApi? vertexAiSearch? vertexRagStore?

Properties

OptionaldisableAttribution

disableAttribution?: boolean

Optional. Deprecated. This option is no longer supported.

OptionalexternalApi

externalApi?: ExternalApi

Use data source powered by external API for grounding.

OptionalvertexAiSearch

vertexAiSearch?: VertexAISearch

Set to use data source powered by Vertex AI Search.

OptionalvertexRagStore

vertexRagStore?: VertexRagStore

Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService.

Settings

On This Page

Properties