Package com.google.genai.types

Class FileSearch

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.FileSearch

public abstract class FileSearch
extends JsonSerializable

Tool to retrieve knowledge from the File Search Stores.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileSearch.Builder	Builder for FileSearch.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
FileSearch()

Method Summary

Modifier and Type	Method	Description
static FileSearch.Builder	builder()	Instantiates a builder for FileSearch.
abstract Optional<List<String>>	fileSearchStoreNames()	The names of the file_search_stores to retrieve from.
static FileSearch	fromJson(String jsonString)	Deserializes a JSON string to a FileSearch object.
abstract Optional<String>	metadataFilter()	Metadata filter to apply to the file search retrieval documents.
abstract FileSearch.Builder	toBuilder()	Creates a builder with the same values as this instance.
abstract Optional<Integer>	topK()	The number of file search retrieval chunks to retrieve.

Methods inherited from class com.google.genai.JsonSerializable

setMaxReadLength, stringToJsonNode, toJson

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileSearch

public FileSearch()

Method Details

fileSearchStoreNames

public abstract Optional<List<String>> fileSearchStoreNames()

The names of the file_search_stores to retrieve from. Example: `fileSearchStores/my-file-search-store-123`

topK

public abstract Optional<Integer> topK()

The number of file search retrieval chunks to retrieve.

metadataFilter

public abstract Optional<String> metadataFilter()

Metadata filter to apply to the file search retrieval documents. See https://google.aip.dev/160 for the syntax of the filter expression.

builder

public static FileSearch.Builder builder()

Instantiates a builder for FileSearch.

toBuilder

public abstract FileSearch.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static FileSearch fromJson(String jsonString)

Deserializes a JSON string to a FileSearch object.