Package com.google.genkit.core

Interface BidiAction<I,O,S,Init>

Type Parameters:

I - per-turn input type

O - final output type

S - stream chunk type

Init - session-init type (pass Void / null when not needed)

All Superinterfaces:

Action<I,O,S>, Registerable

All Known Implementing Classes:

Agent, BidiActionImpl

public interface BidiAction<I,O,S,Init>
extends Action<I,O,S>

A bidirectional streaming action.

A BidiAction accepts a one-time session-init value (Init), a stream of per-turn inputs (InputSource<I>), streams chunk values of type S via a callback, and returns a final output of type O.

Callers that only need a single input can use the inherited Action.run(com.google.genkit.core.ActionContext, I) methods, which wrap the single input in a BufferedInputSource and invoke the bidi handler transparently.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BidiAction.BidiHandler<I,O,S,Init>	Functional interface that implements the bidirectional streaming logic.

Method Summary

Modifier and Type	Method	Description
O	runBidi(ActionContext ctx, Init init, InputSource<I> inputs, Consumer<S> streamCallback)	Runs the action in bidirectional-streaming mode.
com.fasterxml.jackson.databind.JsonNode	runBidiJson(ActionContext ctx, com.fasterxml.jackson.databind.JsonNode init, InputSource<com.fasterxml.jackson.databind.JsonNode> inputs, Consumer<com.fasterxml.jackson.databind.JsonNode> streamCallback)	Runs the action in bidirectional-streaming mode with JSON-typed arguments.
ActionRunResult<com.fasterxml.jackson.databind.JsonNode>	runBidiJsonWithTelemetry(ActionContext ctx, com.fasterxml.jackson.databind.JsonNode init, InputSource<com.fasterxml.jackson.databind.JsonNode> inputs, Consumer<com.fasterxml.jackson.databind.JsonNode> streamCallback)	Runs the action in bidirectional-streaming mode with JSON-typed arguments and telemetry.

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

getDesc, getInputSchema, getMetadata, getName, getOutputSchema, getType, run, run, runJson, runJsonWithTelemetry

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

register

Method Details

runBidi

O runBidi(ActionContext ctx,
 Init init,
 InputSource<I> inputs,
 Consumer<S> streamCallback)
   throws GenkitException

Runs the action in bidirectional-streaming mode.

Parameters:

ctx - the action context

init - the one-time session-init value; may be null

inputs - the stream of per-turn inputs

streamCallback - callback invoked for each emitted chunk; may be null

Returns:

the final output

Throws:

GenkitException - if execution fails

runBidiJson

com.fasterxml.jackson.databind.JsonNode runBidiJson(ActionContext ctx,
 com.fasterxml.jackson.databind.JsonNode init,
 InputSource<com.fasterxml.jackson.databind.JsonNode> inputs,
 Consumer<com.fasterxml.jackson.databind.JsonNode> streamCallback)
                                             throws GenkitException

Runs the action in bidirectional-streaming mode with JSON-typed arguments.

Deserializes init and each element from inputs before handing them to the typed handler, and serializes all chunks and the final result back to JsonNode.

Parameters:

ctx - the action context

init - the one-time session-init as a JsonNode; may be null

inputs - the stream of per-turn inputs as JsonNode values

streamCallback - callback invoked for each emitted chunk serialized to JsonNode; may be null

Returns:

the final output serialized to JsonNode

Throws:

GenkitException - if execution fails

runBidiJsonWithTelemetry

ActionRunResult<com.fasterxml.jackson.databind.JsonNode> runBidiJsonWithTelemetry(ActionContext ctx,
 com.fasterxml.jackson.databind.JsonNode init,
 InputSource<com.fasterxml.jackson.databind.JsonNode> inputs,
 Consumer<com.fasterxml.jackson.databind.JsonNode> streamCallback)
                                                                           throws GenkitException

Runs the action in bidirectional-streaming mode with JSON-typed arguments and telemetry.

Behaves like runBidiJson(com.google.genkit.core.ActionContext, com.fasterxml.jackson.databind.JsonNode, com.google.genkit.core.InputSource<com.fasterxml.jackson.databind.JsonNode>, java.util.function.Consumer<com.fasterxml.jackson.databind.JsonNode>) (deserializing init and each element from inputs, serializing all chunks and the final result back to JsonNode) but additionally creates a new tracing span and captures the resulting trace/span IDs, returning them in an ActionRunResult. Unlike the unary Action.runJsonWithTelemetry(com.google.genkit.core.ActionContext, com.fasterxml.jackson.databind.JsonNode, java.util.function.Consumer<com.fasterxml.jackson.databind.JsonNode>), this threads the real init and the full stream of inputs through to the handler.

Parameters:

ctx - the action context

init - the one-time session-init as a JsonNode; may be null

inputs - the stream of per-turn inputs as JsonNode values

streamCallback - callback invoked for each emitted chunk serialized to JsonNode; may be null

Returns:

the final output serialized to JsonNode together with the captured trace/span IDs

Throws:

GenkitException - if execution fails