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

Class FileSearch

java.lang.Object

com.google.genai.gaos.models.interactions.FileSearch

All Implemented Interfaces:

Tool

public class FileSearch
extends Object
implements Tool

FileSearch

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FileSearch.Builder

Constructor Summary

Constructors

Constructor	Description
FileSearch()
FileSearch(List<String> fileSearchStoreNames, String metadataFilter, Integer topK)

Method Summary

Modifier and Type	Method	Description
static FileSearch.Builder	builder()
boolean	equals(Object o)
Optional<List<String>>	fileSearchStoreNames()	The file search store names to search.
int	hashCode()
Optional<String>	metadataFilter()	Metadata filter to apply to the semantic retrieval documents and chunks.
Optional<Integer>	topK()	The number of semantic retrieval chunks to retrieve.
String	toString()
String	type()
FileSearch	withFileSearchStoreNames(List<String> fileSearchStoreNames)	The file search store names to search.
FileSearch	withMetadataFilter(String metadataFilter)	Metadata filter to apply to the semantic retrieval documents and chunks.
FileSearch	withTopK(Integer topK)	The number of semantic retrieval chunks to retrieve.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

FileSearch

public FileSearch(@Nullable
 List<String> fileSearchStoreNames,
 @Nullable
 String metadataFilter,
 @Nullable
 Integer topK)

FileSearch

public FileSearch()

Method Details

fileSearchStoreNames

public Optional<List<String>> fileSearchStoreNames()

The file search store names to search.

metadataFilter

public Optional<String> metadataFilter()

Metadata filter to apply to the semantic retrieval documents and chunks.

topK

public Optional<Integer> topK()

The number of semantic retrieval chunks to retrieve.

type

public String type()

Specified by:

type in interface Tool

builder

public static FileSearch.Builder builder()

withFileSearchStoreNames

public FileSearch withFileSearchStoreNames(@Nullable
 List<String> fileSearchStoreNames)

The file search store names to search.

withMetadataFilter

public FileSearch withMetadataFilter(@Nullable
 String metadataFilter)

Metadata filter to apply to the semantic retrieval documents and chunks.

withTopK

public FileSearch withTopK(@Nullable
 Integer topK)

The number of semantic retrieval chunks to retrieve.

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