Package com.redis.vl.utils.vectorize

Class VectorizerBuilder

java.lang.Object

com.redis.vl.utils.vectorize.VectorizerBuilder

public class VectorizerBuilder
extends Object

Factory class for creating vectorizers with common providers. This builder provides convenience methods to create vectorizers for popular embedding providers supported by LangChain4J.

Example usage:

 // OpenAI vectorizer
 var vectorizer = VectorizerBuilder.openAI("your-api-key")
     .withCache(cache)
     .build();

 // Local model vectorizer
 var vectorizer = VectorizerBuilder.local("all-minilm-l6-v2")
     .withCache(cache)
     .build();

 // Custom LangChain4J model
 EmbeddingModel customModel = new MyCustomEmbeddingModel();
 var vectorizer = VectorizerBuilder.custom("my-model", customModel)
     .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VectorizerBuilder.AbstractVectorizerBuilder<T extends VectorizerBuilder.AbstractVectorizerBuilder<T>>	Abstract base builder for all vectorizer builders.
static class	VectorizerBuilder.AzureOpenAIVectorizerBuilder	Builder for Azure OpenAI embedding vectorizers.
static class	VectorizerBuilder.CustomVectorizerBuilder	Builder for custom LangChain4J embedding vectorizers.
static class	VectorizerBuilder.HuggingFaceVectorizerBuilder	Builder for HuggingFace embedding vectorizers.
static class	VectorizerBuilder.LocalVectorizerBuilder	Builder for local ONNX embedding vectorizers.
static class	VectorizerBuilder.OllamaVectorizerBuilder	Builder for Ollama embedding vectorizers.
static class	VectorizerBuilder.OpenAIVectorizerBuilder	Builder for OpenAI embedding vectorizers.

Method Summary

Modifier and Type	Method	Description
static VectorizerBuilder.AzureOpenAIVectorizerBuilder	azure(String endpoint, String apiKey)	Create a builder for Azure OpenAI embeddings.
static VectorizerBuilder.CustomVectorizerBuilder	custom(String modelName, Object embeddingModel)	Create a builder for a custom LangChain4J EmbeddingModel.
static VectorizerBuilder.HuggingFaceVectorizerBuilder	huggingFace(String apiKey)	Create a builder for HuggingFace embeddings.
static VectorizerBuilder.LocalVectorizerBuilder	local(String modelName)	Create a builder for local embedding models.
static VectorizerBuilder.OllamaVectorizerBuilder	ollama(String baseUrl)	Create a builder for Ollama embeddings.
static VectorizerBuilder.OpenAIVectorizerBuilder	openAI(String apiKey)	Create a builder for OpenAI embeddings.

Methods inherited from class java.lang.Object

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

Method Details

openAI

public static VectorizerBuilder.OpenAIVectorizerBuilder openAI(String apiKey)

Create a builder for OpenAI embeddings. Requires: dev.langchain4j:langchain4j-open-ai

Parameters:

apiKey - The OpenAI API key

Returns:

Builder for OpenAI vectorizer

azure

public static VectorizerBuilder.AzureOpenAIVectorizerBuilder azure(String endpoint,
 String apiKey)

Create a builder for Azure OpenAI embeddings. Requires: dev.langchain4j:langchain4j-azure-open-ai

Parameters:

endpoint - The Azure OpenAI endpoint

apiKey - The Azure OpenAI API key

Returns:

Builder for Azure OpenAI vectorizer

huggingFace

public static VectorizerBuilder.HuggingFaceVectorizerBuilder huggingFace(String apiKey)

Create a builder for HuggingFace embeddings. Requires: dev.langchain4j:langchain4j-hugging-face

Parameters:

apiKey - The HuggingFace API key

Returns:

Builder for HuggingFace vectorizer

ollama

public static VectorizerBuilder.OllamaVectorizerBuilder ollama(String baseUrl)

Create a builder for Ollama embeddings. Requires: dev.langchain4j:langchain4j-ollama

Parameters:

baseUrl - The Ollama base URL (e.g., "http://localhost:11434")

Returns:

Builder for Ollama vectorizer

local

public static VectorizerBuilder.LocalVectorizerBuilder local(String modelName)

Create a builder for local embedding models. Available models: - "all-minilm-l6-v2" (requires: langchain4j-embeddings-all-minilm-l6-v2) - "bge-small-en-v15" (requires: langchain4j-embeddings-bge-small-en-v15) - "e5-small-v2" (requires: langchain4j-embeddings-e5-small-v2)

Parameters:

modelName - The name of the local model

Returns:

Builder for local model vectorizer

custom

public static VectorizerBuilder.CustomVectorizerBuilder custom(String modelName,
 Object embeddingModel)

Create a builder for a custom LangChain4J EmbeddingModel.

Parameters:

modelName - The name to use for this model

embeddingModel - The LangChain4J embedding model instance

Returns:

Builder for custom vectorizer