Package com.google.genkit.plugins.compatoai

Class CompatOAIModel

java.lang.Object

com.google.genkit.plugins.compatoai.CompatOAIModel

All Implemented Interfaces:

Model, Action<ModelRequest,ModelResponse,ModelResponseChunk>, Registerable

public class CompatOAIModel
extends Object
implements Model

OpenAI-compatible API model implementation for Genkit. This implementation can be used by any provider that offers an OpenAI-compatible API endpoint.

Constructor Summary

Constructors

Constructor	Description
CompatOAIModel(String modelName, String label, CompatOAIPluginOptions options)	Creates a new CompatOAIModel (backward compatible - uses modelName for both).
CompatOAIModel(String modelName, String apiModelName, String label, CompatOAIPluginOptions options)	Creates a new CompatOAIModel with separate Genkit and API model names.

Method Summary

Modifier and Type	Method	Description
ModelInfo	getInfo()	Gets information about the model's capabilities.
String	getName()	Returns the name of the action.
ModelResponse	run(ActionContext context, ModelRequest request)	Generates a response from the given request.
ModelResponse	run(ActionContext context, ModelRequest request, Consumer<ModelResponseChunk> streamCallback)	Generates a streaming response from the given request.
boolean	supportsStreaming()	Returns whether this model supports streaming.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.genkit.ai.Model

getDesc, getInputSchema, getMetadata, getOutputSchema, getType, register, runJson, runJsonWithTelemetry

Constructor Details

CompatOAIModel

public CompatOAIModel(String modelName,
 String apiModelName,
 String label,
 CompatOAIPluginOptions options)

Creates a new CompatOAIModel with separate Genkit and API model names.

Parameters:

modelName - the Genkit model name (e.g., "groq/llama-3.3-70b-versatile")

apiModelName - the API model name (e.g., "llama-3.3-70b-versatile")

label - the display label (e.g., "Groq llama-3.3-70b-versatile")

options - the plugin options

CompatOAIModel

public CompatOAIModel(String modelName,
 String label,
 CompatOAIPluginOptions options)

Creates a new CompatOAIModel (backward compatible - uses modelName for both).

Parameters:

modelName - the model name (e.g., "gpt-4", "grok-beta")

label - the display label (e.g., "XAI grok-beta")

options - the plugin options

Method Details

getName

public String getName()

Description copied from interface: Action

Returns the name of the action.

Specified by:

getName in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Returns:

the action name

getInfo

public ModelInfo getInfo()

Description copied from interface: Model

Gets information about the model's capabilities.

Specified by:

getInfo in interface Model

Returns:

the model info

supportsStreaming

public boolean supportsStreaming()

Description copied from interface: Model

Returns whether this model supports streaming.

Specified by:

supportsStreaming in interface Model

Returns:

true if streaming is supported

run

public ModelResponse run(ActionContext context,
 ModelRequest request)

Description copied from interface: Model

Generates a response from the given request.

Specified by:

run in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Specified by:

run in interface Model

Parameters:

context - the action context

request - the model request

Returns:

the model response

run

public ModelResponse run(ActionContext context,
 ModelRequest request,
 Consumer<ModelResponseChunk> streamCallback)

Description copied from interface: Model

Generates a streaming response from the given request.

Specified by:

run in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Specified by:

run in interface Model

Parameters:

context - the action context

request - the model request

streamCallback - callback for streaming chunks

Returns:

the final model response