llm4s-docs
API
Generated with
llm4s-docs/org.llm4s/org.llm4s.toolapi/IntegerSchema

IntegerSchema

org.llm4s.toolapi.IntegerSchema
See theIntegerSchema companion object
@Stable
final case class IntegerSchema extends SchemaDefinition[Int]

Integer schema with range and divisibility constraints.

Value parameters

description

Human-readable description shown to the LLM

exclusiveMaximum

Exclusive upper bound

exclusiveMinimum

Exclusive lower bound

maximum

Inclusive upper bound

minimum

Inclusive lower bound

multipleOf

Value must be a multiple of this integer

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait SchemaDefinition[Int]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def toJsonSchema(strict: Boolean): Value

Serialise this schema to a JSON Schema ujson.Value.

Serialise this schema to a JSON Schema ujson.Value.

Value parameters

strict

When true, all object properties are treated as required, matching OpenAI strict-mode tool definitions.

Attributes

def withDescription(description: String): IntegerSchema

Replace the description shown to the LLM.

Replace the description shown to the LLM.

Attributes

def withExclusiveMaximum(max: Int): IntegerSchema

Set the exclusive upper bound.

Set the exclusive upper bound.

Attributes

def withExclusiveMaximum(max: Option[Int]): IntegerSchema

Set or clear the exclusive upper bound.

Set or clear the exclusive upper bound.

Attributes

def withExclusiveMinimum(min: Int): IntegerSchema

Set the exclusive lower bound.

Set the exclusive lower bound.

Attributes

def withExclusiveMinimum(min: Option[Int]): IntegerSchema

Set or clear the exclusive lower bound.

Set or clear the exclusive lower bound.

Attributes

def withExclusiveRange(min: Option[Int], max: Option[Int]): IntegerSchema

Add exclusive minimum and/or maximum range constraints.

Add exclusive minimum and/or maximum range constraints.

Value parameters

max

Optional exclusive upper bound

min

Optional exclusive lower bound

Attributes

def withMaximum(max: Int): IntegerSchema

Set the inclusive upper bound.

Set the inclusive upper bound.

Attributes

def withMaximum(max: Option[Int]): IntegerSchema

Set or clear the inclusive upper bound.

Set or clear the inclusive upper bound.

Attributes

def withMinimum(min: Int): IntegerSchema

Set the inclusive lower bound.

Set the inclusive lower bound.

Attributes

def withMinimum(min: Option[Int]): IntegerSchema

Set or clear the inclusive lower bound.

Set or clear the inclusive lower bound.

Attributes

def withMultipleOf(multiple: Int): IntegerSchema

Require the value to be an integer multiple of multiple.

Require the value to be an integer multiple of multiple.

Value parameters

multiple

The divisor

Attributes

def withMultipleOf(multiple: Option[Int]): IntegerSchema

Set or clear the divisor the value must be a multiple of.

Set or clear the divisor the value must be a multiple of.

Attributes

def withRange(min: Option[Int], max: Option[Int]): IntegerSchema

Add inclusive minimum and/or maximum range constraints.

Add inclusive minimum and/or maximum range constraints.

Value parameters

max

Optional inclusive upper bound

min

Optional inclusive lower bound

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with