Uses of Class
com.google.genkit.plugins.firebase.retriever.FirestoreRetrieverConfig.Builder
Packages that use FirestoreRetrieverConfig.Builder
Package
Description
Firestore vector search retriever and indexer components.
-
Uses of FirestoreRetrieverConfig.Builder in com.google.genkit.plugins.firebase.retriever
Methods in com.google.genkit.plugins.firebase.retriever that return FirestoreRetrieverConfig.BuilderModifier and TypeMethodDescriptionFirestoreRetrieverConfig.builder()Creates a builder for FirestoreRetrieverConfig.FirestoreRetrieverConfig.Builder.collection(String collection) Sets the Firestore collection name.FirestoreRetrieverConfig.Builder.contentExtractor(Function<com.google.cloud.firestore.QueryDocumentSnapshot, List<Part>> contentExtractor) Sets a custom content extractor function.FirestoreRetrieverConfig.Builder.contentField(String contentField) Sets the field name containing document content.FirestoreRetrieverConfig.Builder.createDatabaseIfNotExists(boolean createDatabaseIfNotExists) Sets whether to create the Firestore database if it doesn't exist.FirestoreRetrieverConfig.Builder.createVectorIndexIfNotExists(boolean createVectorIndexIfNotExists) Sets whether to create the Firestore vector index if it doesn't exist.FirestoreRetrieverConfig.Builder.databaseId(String databaseId) Sets the Firestore database ID to use.FirestoreRetrieverConfig.Builder.defaultLimit(int defaultLimit) Sets the default limit for retrieval results.FirestoreRetrieverConfig.Builder.distanceMeasure(FirestoreRetrieverConfig.DistanceMeasure distanceMeasure) Sets the distance measure for vector similarity.FirestoreRetrieverConfig.Builder.distanceResultField(String distanceResultField) Sets the field name to store the distance in result metadata.FirestoreRetrieverConfig.Builder.distanceThreshold(Double distanceThreshold) Sets the distance threshold for filtering results.Sets the embedder instance to use.FirestoreRetrieverConfig.Builder.embedderDimension(int embedderDimension) Sets the dimension of the embeddings for vector index creation.FirestoreRetrieverConfig.Builder.embedderName(String embedderName) Sets the embedder name for resolution from registry.Sets the display label for the Developer UI.FirestoreRetrieverConfig.Builder.metadataExtractor(Function<com.google.cloud.firestore.QueryDocumentSnapshot, Map<String, Object>> metadataExtractor) Sets a custom metadata extractor function.FirestoreRetrieverConfig.Builder.metadataFields(List<String> metadataFields) Sets the metadata fields to include in results.Sets the name of the retriever (required).FirestoreRetrieverConfig.Builder.vectorField(String vectorField) Sets the field name containing vector embeddings.