google-genai/com.google.genai.types/FileSearch

FileSearch

public abstract class FileSearch extends JsonSerializable

The FileSearch tool that retrieves knowledge from Semantic Retrieval corpora. Files are imported to Semantic Retrieval corpora using the ImportFile API. This data type is not supported in Vertex AI.

Constructors

Link copied to clipboard
public void FileSearch()

Types

Link copied to clipboard
public abstract class Builder
Builder for FileSearch.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public static FileSearch.Builder builder()
Instantiates a builder for FileSearch.
Link copied to clipboard
public abstract Optional<List<String>> fileSearchStoreNames()
Required.
Link copied to clipboard
public static FileSearch fromJson(String jsonString)
Deserializes a JSON string to a FileSearch object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public abstract Optional<String> metadataFilter()
Optional.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract FileSearch.Builder toBuilder()
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<Integer> topK()
Optional.