Package com.google.genkit.ai

Class OutputConfig

java.lang.Object
com.google.genkit.ai.OutputConfig
public class OutputConfig extends Object
OutputConfig contains configuration for model output generation.

  • Constructor Details

    • OutputConfig

      public OutputConfig()
      Default constructor.

    • OutputConfig

      public OutputConfig(OutputFormat format)
      Creates an OutputConfig with the given format.
      Parameters:
      format - the output format

  • Method Details

    • json

      public static OutputConfig json(Map<String,Object> schema)
      Creates an OutputConfig for JSON output with schema.
      Parameters:
      schema - the JSON schema
      Returns:
      an OutputConfig configured for JSON

    • fromClass

      public static OutputConfig fromClass(Class<?> clazz)
      Creates an OutputConfig for JSON output from a class.

      The schema is automatically generated from the class using reflection. You can add descriptions to fields using @JsonPropertyDescription: 

      
 public class MenuItem {
 	@JsonPropertyDescription("The name of the menu item")
 	private String name;
 
 	@JsonPropertyDescription("The estimated number of calories")
 	private int calories;
 
 	// getters/setters...
 }
 
 // Usage:
 OutputConfig output = OutputConfig.fromClass(MenuItem.class);
      Parameters:
      clazz - the class to generate schema from
      Returns:
      an OutputConfig configured for JSON with inferred schema

    • text

      public static OutputConfig text()
      Creates an OutputConfig for text output.
      Returns:
      an OutputConfig configured for text

    • getFormat

      public OutputFormat getFormat()

    • setFormat

      public void setFormat(OutputFormat format)

    • getSchema

      public Map<String,Object> getSchema()

    • setSchema

      public void setSchema(Map<String,Object> schema)

    • getConstrained

      public Boolean getConstrained()

    • setConstrained

      public void setConstrained(Boolean constrained)

    • getContentType

      public String getContentType()

    • setContentType

      public void setContentType(String contentType)

    • getInstructions

      public String getInstructions()

    • setInstructions

      public void setInstructions(String instructions)