Package com.google.genkit.ai

Class Retriever

java.lang.Object

com.google.genkit.ai.Retriever

All Implemented Interfaces:

Action<RetrieverRequest,RetrieverResponse,Void>, Registerable

public class Retriever
extends Object
implements Action<RetrieverRequest,RetrieverResponse,Void>

Retriever is an action that retrieves documents based on a query. Retrievers are used for RAG (Retrieval Augmented Generation) workflows to find relevant documents to include in model prompts.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Retriever.Builder	Builder for Retriever.

Constructor Summary

Constructors

Constructor	Description
Retriever(String name, BiFunction<ActionContext,RetrieverRequest,RetrieverResponse> handler)	Creates a new Retriever.

Method Summary

Modifier and Type	Method	Description
static Retriever.Builder	builder()	Creates a builder for Retriever.
ActionDesc	getDesc()	Returns the descriptor of the action containing metadata, schemas, etc.
Map<String,Object>	getInputSchema()	Returns the JSON schema for the action's input type.
Map<String,Object>	getMetadata()	Returns additional metadata for the action.
String	getName()	Returns the name of the action.
Map<String,Object>	getOutputSchema()	Returns the JSON schema for the action's output type.
ActionType	getType()	Returns the type of the action.
void	register(Registry registry)	Registers this primitive with the given registry.
RetrieverResponse	run(ActionContext ctx, RetrieverRequest input)	Runs the action with the given input.
RetrieverResponse	run(ActionContext ctx, RetrieverRequest input, Consumer<Void> streamCallback)	Runs the action with the given input and streaming callback.
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.
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.

Methods inherited from class java.lang.Object

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

Constructor Details

Retriever

public Retriever(String name,
 BiFunction<ActionContext,RetrieverRequest,RetrieverResponse> handler)

Creates a new Retriever.

Parameters:

name - the retriever name

handler - the retrieval function

Method Details

builder

public static Retriever.Builder builder()

Creates a builder for Retriever.

Returns:

a new builder

getName

public String getName()

Description copied from interface: Action

Returns the name of the action.

Specified by:

getName in interface Action<RetrieverRequest,RetrieverResponse,Void>

Returns:

the action name

getType

public ActionType getType()

Description copied from interface: Action

Returns the type of the action.

Specified by:

getType in interface Action<RetrieverRequest,RetrieverResponse,Void>

Returns:

the action type

getDesc

public ActionDesc getDesc()

Description copied from interface: Action

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

Specified by:

getDesc in interface Action<RetrieverRequest,RetrieverResponse,Void>

Returns:

the action descriptor

run

public RetrieverResponse run(ActionContext ctx,
 RetrieverRequest input)
                      throws GenkitException

Description copied from interface: Action

Runs the action with the given input.

Specified by:

run in interface Action<RetrieverRequest,RetrieverResponse,Void>

Parameters:

ctx - the action context

input - the input to the action

Returns:

the output of the action

Throws:

GenkitException - if the action fails

run

public RetrieverResponse run(ActionContext ctx,
 RetrieverRequest input,
 Consumer<Void> streamCallback)
                      throws GenkitException

Description copied from interface: Action

Runs the action with the given input and streaming callback.

Specified by:

run in interface Action<RetrieverRequest,RetrieverResponse,Void>

Parameters:

ctx - the action context

input - the input to the action

streamCallback - callback for receiving streaming chunks, may be null

Returns:

the output of the action

Throws:

GenkitException - if the action fails

runJson

public 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<RetrieverRequest,RetrieverResponse,Void>

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

public 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<RetrieverRequest,RetrieverResponse,Void>

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

public 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<RetrieverRequest,RetrieverResponse,Void>

Returns:

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

getOutputSchema

public 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<RetrieverRequest,RetrieverResponse,Void>

Returns:

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

getMetadata

public Map<String,Object> getMetadata()

Description copied from interface: Action

Returns additional metadata for the action.

Specified by:

getMetadata in interface Action<RetrieverRequest,RetrieverResponse,Void>

Returns:

the metadata map

register

public 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