Package com.google.genai.gaos.models.interactions

Class Retrieval

java.lang.Object

com.google.genai.gaos.models.interactions.Retrieval

All Implemented Interfaces:

Tool

public class Retrieval
extends Object
implements Tool

Retrieval

A tool that can be used by the model to retrieve files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Retrieval.Builder

Constructor Summary

Constructors

Constructor	Description
Retrieval()
Retrieval(ExaAISearchConfig exaAiSearchConfig, ParallelAISearchConfig parallelAiSearchConfig, RagStoreConfig ragStoreConfig, List<RetrievalRetrievalType> retrievalTypes, VertexAISearchConfig vertexAiSearchConfig)

Method Summary

Modifier and Type	Method	Description
static Retrieval.Builder	builder()
boolean	equals(Object o)
Optional<ExaAISearchConfig>	exaAiSearchConfig()	Used to specify configuration for ExaAISearch.
int	hashCode()
Optional<ParallelAISearchConfig>	parallelAiSearchConfig()	Used to specify configuration for ParallelAISearch.
Optional<RagStoreConfig>	ragStoreConfig()	Use to specify configuration for RAG Store.
Optional<List<RetrievalRetrievalType>>	retrievalTypes()	The types of file retrieval to enable.
String	toString()
String	type()
Optional<VertexAISearchConfig>	vertexAiSearchConfig()	Used to specify configuration for VertexAISearch.
Retrieval	withExaAiSearchConfig(ExaAISearchConfig exaAiSearchConfig)	Used to specify configuration for ExaAISearch.
Retrieval	withParallelAiSearchConfig(ParallelAISearchConfig parallelAiSearchConfig)	Used to specify configuration for ParallelAISearch.
Retrieval	withRagStoreConfig(RagStoreConfig ragStoreConfig)	Use to specify configuration for RAG Store.
Retrieval	withRetrievalTypes(List<RetrievalRetrievalType> retrievalTypes)	The types of file retrieval to enable.
Retrieval	withVertexAiSearchConfig(VertexAISearchConfig vertexAiSearchConfig)	Used to specify configuration for VertexAISearch.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Retrieval

public Retrieval(@Nullable
 ExaAISearchConfig exaAiSearchConfig,
 @Nullable
 ParallelAISearchConfig parallelAiSearchConfig,
 @Nullable
 RagStoreConfig ragStoreConfig,
 @Nullable
 List<RetrievalRetrievalType> retrievalTypes,
 @Nullable
 VertexAISearchConfig vertexAiSearchConfig)

Retrieval

public Retrieval()

Method Details

exaAiSearchConfig

public Optional<ExaAISearchConfig> exaAiSearchConfig()

Used to specify configuration for ExaAISearch.

parallelAiSearchConfig

public Optional<ParallelAISearchConfig> parallelAiSearchConfig()

Used to specify configuration for ParallelAISearch.

ragStoreConfig

public Optional<RagStoreConfig> ragStoreConfig()

Use to specify configuration for RAG Store.

retrievalTypes

public Optional<List<RetrievalRetrievalType>> retrievalTypes()

The types of file retrieval to enable.

type

public String type()

Specified by:

type in interface Tool

vertexAiSearchConfig

public Optional<VertexAISearchConfig> vertexAiSearchConfig()

Used to specify configuration for VertexAISearch.

builder

public static Retrieval.Builder builder()

withExaAiSearchConfig

public Retrieval withExaAiSearchConfig(@Nullable
 ExaAISearchConfig exaAiSearchConfig)

Used to specify configuration for ExaAISearch.

withParallelAiSearchConfig

public Retrieval withParallelAiSearchConfig(@Nullable
 ParallelAISearchConfig parallelAiSearchConfig)

Used to specify configuration for ParallelAISearch.

withRagStoreConfig

public Retrieval withRagStoreConfig(@Nullable
 RagStoreConfig ragStoreConfig)

Use to specify configuration for RAG Store.

withRetrievalTypes

public Retrieval withRetrievalTypes(@Nullable
 List<RetrievalRetrievalType> retrievalTypes)

The types of file retrieval to enable.

withVertexAiSearchConfig

public Retrieval withVertexAiSearchConfig(@Nullable
 VertexAISearchConfig vertexAiSearchConfig)

Used to specify configuration for VertexAISearch.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object