Package com.google.genkit.ai

Class GenerateOptions.Builder<T>

java.lang.Object

com.google.genkit.ai.GenerateOptions.Builder<T>

Type Parameters:

T - the output type for structured output

Enclosing class:

GenerateOptions<T>

public static class GenerateOptions.Builder<T>
extends Object

Builder for GenerateOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GenerateOptions<T>	build()
GenerateOptions.Builder<T>	config(GenerationConfig config)
GenerateOptions.Builder<T>	context(Map<String,Object> context)
GenerateOptions.Builder<T>	docs(List<Document> docs)
GenerateOptions.Builder<T>	maxTurns(Integer maxTurns)
GenerateOptions.Builder<T>	messages(List<Message> messages)
GenerateOptions.Builder<T>	model(String model)
GenerateOptions.Builder<T>	output(OutputConfig output)
<U> GenerateOptions.Builder<U>	outputClass(Class<U> outputClass)	Sets the output class for typed structured output.
GenerateOptions.Builder<T>	prompt(String prompt)
GenerateOptions.Builder<T>	resume(ResumeOptions resume)	Sets the resume options for continuing after an interrupt.
GenerateOptions.Builder<T>	system(String system)
GenerateOptions.Builder<T>	toolChoice(Object toolChoice)
GenerateOptions.Builder<T>	tools(List<Tool<?,?>> tools)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

model

public GenerateOptions.Builder<T> model(String model)

prompt

public GenerateOptions.Builder<T> prompt(String prompt)

messages

public GenerateOptions.Builder<T> messages(List<Message> messages)

docs

public GenerateOptions.Builder<T> docs(List<Document> docs)

system

public GenerateOptions.Builder<T> system(String system)

tools

public GenerateOptions.Builder<T> tools(List<Tool<?,?>> tools)

toolChoice

public GenerateOptions.Builder<T> toolChoice(Object toolChoice)

output

public GenerateOptions.Builder<T> output(OutputConfig output)

outputClass

public <U> GenerateOptions.Builder<U> outputClass(Class<U> outputClass)

Sets the output class for typed structured output.

When set, the schema is automatically generated from the class. Use @JsonPropertyDescription to add descriptions to fields:

 public class MenuItem {
 	@JsonPropertyDescription("The name of the menu item")
 	private String name;
 
 	@JsonPropertyDescription("The estimated number of calories")
 	private int calories;
 }
 
 // Usage:
 MenuItem item = genkit.generate(GenerateOptions.<MenuItem>builder().model("openai/gpt-4o-mini")
 		.prompt("Suggest a menu item").outputClass(MenuItem.class).build());
 

Parameters:

outputClass - the output class

Returns:

this builder

config

public GenerateOptions.Builder<T> config(GenerationConfig config)

context

public GenerateOptions.Builder<T> context(Map<String,Object> context)

maxTurns

public GenerateOptions.Builder<T> maxTurns(Integer maxTurns)

resume

public GenerateOptions.Builder<T> resume(ResumeOptions resume)

Sets the resume options for continuing after an interrupt.

Parameters:

resume - the resume options

Returns:

this builder

build

public GenerateOptions<T> build()