Package com.google.genkit.ai

Interface Model

All Superinterfaces:

Action<ModelRequest,ModelResponse,ModelResponseChunk>, Registerable

All Known Implementing Classes:

AnthropicModel, AwsBedrockModel, CompatOAIModel, GeminiModel, ImagenModel, OllamaModel, OpenAIImageModel, OpenAIModel, TtsModel, VeoModel

public interface Model
extends Action<ModelRequest,ModelResponse,ModelResponseChunk>

Model is the interface for AI model implementations. Models are registered as actions and can be invoked to generate responses from prompts.

Method Summary

Modifier and Type	Method	Description
default ActionDesc	getDesc()	Returns the descriptor of the action containing metadata, schemas, etc.
ModelInfo	getInfo()	Gets information about the model's capabilities.
default Map<String,Object>	getInputSchema()	Returns the JSON schema for the action's input type.
default Map<String,Object>	getMetadata()	Returns additional metadata for the action.
default Map<String,Object>	getOutputSchema()	Returns the JSON schema for the action's output type.
default ActionType	getType()	Returns the type of the action.
default void	register(Registry registry)	Registers this primitive with the given registry.
ModelResponse	run(ActionContext ctx, ModelRequest request)	Generates a response from the given request.
default ModelResponse	run(ActionContext ctx, ModelRequest request, Consumer<ModelResponseChunk> streamCallback)	Generates a streaming response from the given request.
default com.fasterxml.jackson.databind.JsonNode	runJson(ActionContext ctx, com.fasterxml.jackson.databind.JsonNode input, Consumer<com.fasterxml.jackson.databind.JsonNode> streamCallback)	Runs the action with JSON input and returns JSON output.
default ActionRunResult<com.fasterxml.jackson.databind.JsonNode>	runJsonWithTelemetry(ActionContext ctx, com.fasterxml.jackson.databind.JsonNode input, Consumer<com.fasterxml.jackson.databind.JsonNode> streamCallback)	Runs the action with JSON input and returns the result with telemetry information.
default boolean	supportsStreaming()	Returns whether this model supports streaming.

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

getName

Method Details

getInfo

ModelInfo getInfo()

Gets information about the model's capabilities.

Returns:

the model info

run

ModelResponse run(ActionContext ctx,
 ModelRequest request)
           throws GenkitException

Generates a response from the given request.

Specified by:

run in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Parameters:

ctx - the action context

request - the model request

Returns:

the model response

Throws:

GenkitException - if generation fails

run

default ModelResponse run(ActionContext ctx,
 ModelRequest request,
 Consumer<ModelResponseChunk> streamCallback)
                   throws GenkitException

Generates a streaming response from the given request.

Specified by:

run in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Parameters:

ctx - the action context

request - the model request

streamCallback - callback for streaming chunks

Returns:

the final model response

Throws:

GenkitException - if generation fails

supportsStreaming

default boolean supportsStreaming()

Returns whether this model supports streaming.

Returns:

true if streaming is supported

getType

default ActionType getType()

Description copied from interface: Action

Returns the type of the action.

Specified by:

getType in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Returns:

the action type

getDesc

default ActionDesc getDesc()

Description copied from interface: Action

Returns the descriptor of the action containing metadata, schemas, etc.

Specified by:

getDesc in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Returns:

the action descriptor

runJson

default com.fasterxml.jackson.databind.JsonNode runJson(ActionContext ctx,
 com.fasterxml.jackson.databind.JsonNode input,
 Consumer<com.fasterxml.jackson.databind.JsonNode> streamCallback)
                                                 throws GenkitException

Description copied from interface: Action

Runs the action with JSON input and returns JSON output.

Specified by:

runJson in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Parameters:

ctx - the action context

input - the JSON input

streamCallback - callback for receiving streaming JSON chunks, may be null

Returns:

the JSON output

Throws:

GenkitException - if the action fails

runJsonWithTelemetry

default ActionRunResult<com.fasterxml.jackson.databind.JsonNode> runJsonWithTelemetry(ActionContext ctx,
 com.fasterxml.jackson.databind.JsonNode input,
 Consumer<com.fasterxml.jackson.databind.JsonNode> streamCallback)
                                                                               throws GenkitException

Description copied from interface: Action

Runs the action with JSON input and returns the result with telemetry information.

Specified by:

runJsonWithTelemetry in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Parameters:

ctx - the action context

input - the JSON input

streamCallback - callback for receiving streaming JSON chunks, may be null

Returns:

the action result including telemetry data

Throws:

GenkitException - if the action fails

getInputSchema

default Map<String,Object> getInputSchema()

Description copied from interface: Action

Returns the JSON schema for the action's input type.

Specified by:

getInputSchema in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Returns:

the input schema as a map, or null if not defined

getOutputSchema

default Map<String,Object> getOutputSchema()

Description copied from interface: Action

Returns the JSON schema for the action's output type.

Specified by:

getOutputSchema in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Returns:

the output schema as a map, or null if not defined

getMetadata

default Map<String,Object> getMetadata()

Description copied from interface: Action

Returns additional metadata for the action.

Specified by:

getMetadata in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Returns:

the metadata map

register

default void register(Registry registry)

Description copied from interface: Registerable

Registers this primitive with the given registry.

Specified by:

register in interface Registerable

Parameters:

registry - the registry to register with