Package com.google.genkit.plugins.localvec

Class LocalVecPlugin

java.lang.Object
com.google.genkit.plugins.localvec.LocalVecPlugin
All Implemented Interfaces:
Plugin
public class LocalVecPlugin extends Object implements Plugin
Local file-based vector store plugin for development and testing.

This plugin provides a simple file-based vector store implementation suitable for local development and testing. It stores document embeddings in JSON files and performs similarity search using cosine similarity.

NOT INTENDED FOR PRODUCTION USE.

Example usage with embedder name (recommended): 


 Genkit genkit = Genkit.builder().plugin(OpenAIPlugin.create())
 		.plugin(LocalVecPlugin.builder().addStore(
 				LocalVecConfig.builder().indexName("my-docs").embedderName("openai/text-embedding-3-small").build())
 				.build())
 		.build();

  • Field Details

  • Method Details

    • builder

      public static LocalVecPlugin.Builder builder()
      Creates a builder for LocalVecPlugin.
      Returns:
      a new builder

    • getName

      public String getName()
      Description copied from interface: Plugin
      Returns the unique identifier for the plugin. This name is used for registration and lookup.
      Specified by:
      getName in interface Plugin
      Returns:
      the plugin name

    • init

      public List<Action<?,?,?>> init()
      Description copied from interface: Plugin
      Initializes the plugin. This method is called once during Genkit initialization. The plugin should return a list of actions that it provides.
      Specified by:
      init in interface Plugin
      Returns:
      list of actions provided by this plugin

    • init

      public List<Action<?,?,?>> init(Registry registry)
      Description copied from interface: Plugin
      Initializes the plugin with access to the registry. This method is called once during Genkit initialization. The plugin should return a list of actions that it provides.

      Override this method instead of Plugin.init() when your plugin needs to resolve dependencies from the registry (e.g., embedders, models).

      Specified by:
      init in interface Plugin
      Parameters:
      registry - the Genkit registry for resolving dependencies
      Returns:
      list of actions provided by this plugin