org.noear.solon.ai.llm.dialect.gemini.model

类 Schema

java.lang.Object

org.noear.solon.ai.llm.dialect.gemini.model.Schema

public class Schema
extends java.lang.Object

JSON Schema 配置

用于定义 API 响应的 JSON Schema 结构。 支持描述对象的属性、数组的元素类型、枚举值等。

示例：定义一个用户对象的 Schema

 Schema userSchema = new Schema()
     .setType(Schema.Type.OBJECT)
     .setDescription("用户信息")
     .addProperty("name", new Schema().setType(Schema.Type.STRING))
     .addProperty("age", new Schema().setType(Schema.Type.INTEGER));
 

从以下版本开始:

3.1

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	Schema.Type Schema 类型枚举

构造器概要

构造器

构造器和说明
Schema()

方法概要

限定符和类型	方法和说明
Schema	addProperty(java.lang.String name, Schema schema) 便捷方法：添加属性
java.util.List<Schema>	getAnyOf()
java.lang.String	getDescription()
java.lang.Object	getExample()
java.lang.String	getFormat()
Schema	getItems()
java.lang.Number	getMaximum()
java.lang.Long	getMaxItems()
java.lang.Long	getMaxLength()
java.lang.Long	getMaxProperties()
java.lang.Number	getMinimum()
java.lang.Long	getMinItems()
java.lang.Long	getMinLength()
java.lang.Long	getMinProperties()
java.lang.Boolean	getNullable()
java.lang.String	getPattern()
java.util.Map<java.lang.String,Schema>	getProperties()
java.util.List<java.lang.String>	getPropertyOrdering()
java.util.List<java.lang.String>	getRequiredList()
java.lang.String	getTitle()
Schema.Type	getType()
Schema	setAnyOf(java.util.List<Schema> anyOf)
Schema	setDescription(java.lang.String description)
Schema	setExample(java.lang.Object example)
Schema	setFormat(java.lang.String format)
Schema	setItems(Schema items)
Schema	setMaximum(java.lang.Number maximum)
Schema	setMaxItems(java.lang.Long maxItems)
Schema	setMaxLength(java.lang.Long maxLength)
Schema	setMaxProperties(java.lang.Long maxProperties)
Schema	setMinimum(java.lang.Number minimum)
Schema	setMinItems(java.lang.Long minItems)
Schema	setMinLength(java.lang.Long minLength)
Schema	setMinProperties(java.lang.Long minProperties)
Schema	setNullable(java.lang.Boolean nullable)
Schema	setPattern(java.lang.String pattern)
Schema	setProperties(java.util.Map<java.lang.String,Schema> properties)
Schema	setPropertyOrdering(java.util.List<java.lang.String> propertyOrdering)
Schema	setRequiredList(java.util.List<java.lang.String> required)
Schema	setTitle(java.lang.String title)
Schema	setType(Schema.Type type)

从类继承的方法 java.lang.Object

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

构造器详细资料

Schema

public Schema()

方法详细资料

getType

public Schema.Type getType()

setType

public Schema setType(Schema.Type type)

getDescription

public java.lang.String getDescription()

setDescription

public Schema setDescription(java.lang.String description)

getTitle

public java.lang.String getTitle()

setTitle

public Schema setTitle(java.lang.String title)

getFormat

public java.lang.String getFormat()

setFormat

public Schema setFormat(java.lang.String format)

getProperties

public java.util.Map<java.lang.String,Schema> getProperties()

setProperties

public Schema setProperties(java.util.Map<java.lang.String,Schema> properties)

getRequiredList

public java.util.List<java.lang.String> getRequiredList()

setRequiredList

public Schema setRequiredList(java.util.List<java.lang.String> required)

getMinProperties

public java.lang.Long getMinProperties()

setMinProperties

public Schema setMinProperties(java.lang.Long minProperties)

getMaxProperties

public java.lang.Long getMaxProperties()

setMaxProperties

public Schema setMaxProperties(java.lang.Long maxProperties)

getItems

public Schema getItems()

setItems

public Schema setItems(Schema items)

getMinItems

public java.lang.Long getMinItems()

setMinItems

public Schema setMinItems(java.lang.Long minItems)

getMaxItems

public java.lang.Long getMaxItems()

setMaxItems

public Schema setMaxItems(java.lang.Long maxItems)

getMinLength

public java.lang.Long getMinLength()

setMinLength

public Schema setMinLength(java.lang.Long minLength)

getMaxLength

public java.lang.Long getMaxLength()

setMaxLength

public Schema setMaxLength(java.lang.Long maxLength)

getPattern

public java.lang.String getPattern()

setPattern

public Schema setPattern(java.lang.String pattern)

getMinimum

public java.lang.Number getMinimum()

setMinimum

public Schema setMinimum(java.lang.Number minimum)

getMaximum

public java.lang.Number getMaximum()

setMaximum

public Schema setMaximum(java.lang.Number maximum)

getNullable

public java.lang.Boolean getNullable()

setNullable

public Schema setNullable(java.lang.Boolean nullable)

getExample

public java.lang.Object getExample()

setExample

public Schema setExample(java.lang.Object example)

getAnyOf

public java.util.List<Schema> getAnyOf()

setAnyOf

public Schema setAnyOf(java.util.List<Schema> anyOf)

getPropertyOrdering

public java.util.List<java.lang.String> getPropertyOrdering()

setPropertyOrdering

public Schema setPropertyOrdering(java.util.List<java.lang.String> propertyOrdering)

addProperty

public Schema addProperty(java.lang.String name,
                          Schema schema)

便捷方法：添加属性

参数:

name - 属性名称

schema - 属性 Schema

返回:

当前 Schema 实例