Interface GenerativeModel

All Known Implementing Classes:

OllamaBackend

public interface GenerativeModel

Interface representing a Generative AI model (e.g., Large Language Model).

Provides methods for generating text and embeddings.

Since:

2.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GenerativeModel.Response	Represent a response from the model, which can be text or a tool call.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<float[]>	embed(String text)	Generates vector embeddings for the given text.
CompletableFuture<String>	generate(String prompt)	Generates a response for the given prompt.
default CompletableFuture<GenerativeModel.Response>	generate(String prompt, List<Tool> tools)	Generates a response considering available tools.
String	getModelName()	Returns the name of the model being used (e.g., "gpt-4", "llama3").

Method Details

generate

CompletableFuture<String> generate(String prompt)

Generates a response for the given prompt.

Parameters:

prompt - the input text.

Returns:

a future containing the generated text.

generate

default CompletableFuture<GenerativeModel.Response> generate(String prompt,
 List<Tool> tools)

Generates a response considering available tools.

Parameters:

prompt - the input text.

tools - list of available tools.

Returns:

a future containing either text or a tool call.

embed

CompletableFuture<float[]> embed(String text)

Generates vector embeddings for the given text.

Parameters:

text - the input text.

Returns:

a future containing the embedding vector (as float array).

getModelName

String getModelName()

Returns the name of the model being used (e.g., "gpt-4", "llama3").