[#genai] Added Schema option (#117)

Author: nandagopalan

data/schema.go

@@ -0,0 +1,51 @@
+package data
+
+// Schema used to define structure of the data
+// This is a subset of OpenAPI 3.0 schema
+type Schema struct {
+	Id               string             `json:"id,omitempty" yaml:"id,omitempty"`
+	Ref              string             `json:"$ref,omitempty" yaml:"$ref,omitempty"`
+	Schema           string             `json:"-" yaml:"-"`
+	Description      string             `json:"description,omitempty" yaml:"description,omitempty"`
+	Type             string             `json:"type,omitempty" yaml:"type,omitempty"`
+	Nullable         bool               `json:"nullable,omitempty" yaml:"nullable,omitempty"`
+	Format           *string            `json:"format,omitempty" yaml:"format,omitempty"`
+	Title            string             `json:"title,omitempty" yaml:"title,omitempty"`
+	Default          any                `json:"default,omitempty" yaml:"default,omitempty"`
+	Maximum          *float64           `json:"maximum,omitempty" yaml:"maximum,omitempty"`
+	ExclusiveMaximum *float64           `json:"exclusiveMaximum,omitempty" yaml:"exclusiveMaximum,omitempty"`
+	Minimum          *float64           `json:"minimum,omitempty" yaml:"minimum,omitempty"`
+	ExclusiveMinimum *float64           `json:"exclusiveMinimum,omitempty" yaml:"exclusiveMinimum,omitempty"`
+	MaxLength        *int               `json:"maxLength,omitempty" yaml:"maxLength,omitempty"`
+	MinLength        *int               `json:"minLength,omitempty" yaml:"minLength,omitempty"`
+	Pattern          *string            `json:"pattern,omitempty" yaml:"pattern,omitempty"`
+	MaxItems         *int               `json:"maxItems,omitempty" yaml:"maxItems,omitempty"`
+	MinItems         *int               `json:"minItems,omitempty" yaml:"minItems,omitempty"`
+	UniqueItems      bool               `json:"uniqueItems,omitempty" yaml:"uniqueItems,omitempty"`
+	MultipleOf       *float64           `json:"multipleOf,omitempty" yaml:"multipleOf,omitempty"`
+	Enum             []any              `json:"enum,omitempty" yaml:"enum,omitempty"`
+	MaxProperties    *int               `json:"maxProperties,omitempty" yaml:"maxProperties,omitempty"`
+	MinProperties    *int               `json:"minProperties,omitempty" yaml:"minProperties,omitempty"`
+	Required         []string           `json:"required,omitempty" yaml:"required,omitempty"`
+	Items            *Schema            `json:"items,omitempty" yaml:"items,omitempty"`
+	AllOf            []*Schema          `json:"allOf,omitempty" yaml:"allOf,omitempty"`
+	OneOf            []*Schema          `json:"oneOf,omitempty" yaml:"oneOf,omitempty"`
+	AnyOf            []*Schema          `json:"anyOf,omitempty" yaml:"anyOf,omitempty"`
+	Not              *Schema            `json:"not,omitempty" yaml:"not,omitempty"`
+	Properties       map[string]*Schema `json:"properties,omitempty" yaml:"properties,omitempty"`
+	AdditionalItems  *Schema            `json:"additionalItems,omitempty" yaml:"additionalItems,omitempty"`
+	Xml              *Xml               `json:"xml,omitempty" yaml:"xml,omitempty"`
+	ReadOnly         bool               `json:"readOnly,omitempty" yaml:"readOnly,omitempty"`
+	WriteOnly        bool               `json:"writeOnly,omitempty" yaml:"writeOnly,omitempty"`
+	Example          any                `json:"example,omitempty" yaml:"example,omitempty"`
+	Examples         []any              `json:"examples,omitempty" yaml:"examples,omitempty"`
+	Deprecated       bool               `json:"deprecated,omitempty" yaml:"deprecated,omitempty"`
+}
+
+type Xml struct {
+	Name      *string `json:"name,omitempty" yaml:"name,omitempty"`
+	Namespace *string `json:"namespace,omitempty" yaml:"namespace,omitempty"`
+	Prefix    *string `json:"prefix,omitempty" yaml:"prefix,omitempty"`
+	Attribute *bool   `json:"attribute,omitempty" yaml:"attribute,omitempty"`
+	Wrapped   *bool   `json:"wrapped,omitempty" yaml:"wrapped,omitempty"`
+}

genai/provider.go

@@ -1,6 +1,7 @@
 package genai
 
 import (
+	"oss.nandlabs.io/golly/data"
 	"oss.nandlabs.io/golly/errutils"
 	"oss.nandlabs.io/golly/managers"
 )
@@ -22,7 +23,8 @@ const (
 	OptionBestOf            = "best_of"
 	OptionLogProbs          = "log_probs"
 	OptionEcho              = "echo"
-	OptionOutputMimes       = "output_mimes"
+	OptionOutputMime        = "output_mime"
+	OptionSchema            = "schema"
 )
 
 var GetUnsupportedModelErr = errutils.NewCustomError("unsupported model %s")
@@ -395,12 +397,24 @@ func (o *Options) GetEcho(defaultValue bool) bool {
 // GetOutputMimes retrieves the "output_mimes" option from the Options.
 // Returns the value as a slice of strings, or the provided default value if the option does not exist.
 func (o *Options) GetOutputMimes(defaultValue []string) []string {
-	if o.Has(OptionOutputMimes) {
-		return o.GetStrings(OptionOutputMimes)
+	if o.Has(OptionOutputMime) {
+		return o.GetStrings(OptionOutputMime)
 	}
 	return defaultValue
 }
 
+// GetSchema retrieves the "schema" option from the Options.
+// Returns the value as a *data.Schema, or nil if the option does not exist.
+func (o *Options) GetSchema() (schema *data.Schema) {
+	if o.Has(OptionSchema) {
+		val, ok := o.Get(OptionSchema).(*data.Schema)
+		if ok {
+			schema = val
+		}
+	}
+	return
+}
+
 // OptionsBuilder is a builder for the Options struct
 
 type OptionsBuilder struct {
@@ -691,12 +705,31 @@ func (o *OptionsBuilder) SetEcho(echo bool) *OptionsBuilder {
 //
 // Parameters:
 //
-//	outputMimes: A variable number of strings representing the desired output MIME types.
+//	outputMimes: A string representing the desired output MIME types.
 //
 // Returns:
 //
 //	*OptionsBuilder: A pointer to the updated OptionsBuilder instance.
-func (o *OptionsBuilder) SetOutputMimes(outputMimes ...string) *OptionsBuilder {
-	o.options.values[OptionOutputMimes] = outputMimes
+func (o *OptionsBuilder) SetOutputMimes(outputMimes string) *OptionsBuilder {
+	o.options.values[OptionOutputMime] = outputMimes
+	return o
+}
+
+// SetSchema sets the schema option in the OptionsBuilder.
+// Example usage:
+//
+//	builder := &OptionsBuilder{}
+//	schema := data.NewSchema()
+//	builder.SetSchema(schema)
+//
+// Parameters:
+//
+//	schema (data.Schema): The schema to set in the OptionsBuilder.
+//
+// Returns:
+//
+//	*OptionsBuilder: The updated OptionsBuilder instance.
+func (o *OptionsBuilder) SetSchema(schema *data.Schema) *OptionsBuilder {
+	o.options.values[OptionSchema] = schema
 	return o
 }