Package com.google.genkit.plugins.compatoai

Class CompatOAIPlugin

java.lang.Object

com.google.genkit.plugins.compatoai.CompatOAIPlugin

All Implemented Interfaces:

Plugin

public class CompatOAIPlugin
extends Object
implements Plugin

CompatOAIPlugin provides a generic OpenAI-compatible API integration for Genkit. This plugin allows you to use any OpenAI-compatible API endpoint by configuring the base URL and providing model definitions. Useful for: - Custom or self-hosted OpenAI-compatible endpoints - New providers before dedicated plugins are available - Testing and experimentation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompatOAIPlugin.Builder	Builder for CompatOAIPlugin.
static class	CompatOAIPlugin.ModelDefinition	Model definition for a compat-oai model.

Constructor Summary

Constructors

Constructor	Description
CompatOAIPlugin(String pluginName, CompatOAIPluginOptions options, List<CompatOAIPlugin.ModelDefinition> models)	Creates a CompatOAIPlugin with the specified configuration.

Method Summary

Modifier and Type	Method	Description
static CompatOAIPlugin.Builder	builder()	Creates a CompatOAIPlugin builder.
String	getName()	Returns the unique identifier for the plugin.
CompatOAIPluginOptions	getOptions()	Gets the plugin options.
List<Action<?,?,?>>	init()	Initializes the plugin.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.genkit.core.Plugin

init

Constructor Details

CompatOAIPlugin

public CompatOAIPlugin(String pluginName,
 CompatOAIPluginOptions options,
 List<CompatOAIPlugin.ModelDefinition> models)

Creates a CompatOAIPlugin with the specified configuration.

Parameters:

pluginName - the plugin name (e.g., "my-provider")

options - the plugin options (API key, base URL, etc.)

models - the list of models to register

Method Details

builder

public static CompatOAIPlugin.Builder builder()

Creates a CompatOAIPlugin builder.

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

getOptions

public CompatOAIPluginOptions getOptions()

Gets the plugin options.

Returns:

the options