llm4s-docs/org.llm4s/org.llm4s.toolapi/IntegerSchema

IntegerSchema

org.llm4s.toolapi.IntegerSchema

@Stable

case class IntegerSchema(description: String, minimum: Option[Int], maximum: Option[Int], exclusiveMinimum: Option[Int], exclusiveMaximum: Option[Int], multipleOf: Option[Int]) 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

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

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

Add exclusive minimum and/or maximum range constraints.

Value parameters

max: Optional exclusive upper bound
min: Optional exclusive lower bound

Attributes

Require the value to be an integer multiple of multiple.

Value parameters

multiple: The divisor

Attributes

Add inclusive minimum and/or maximum range constraints.

Value parameters

max: Optional inclusive upper bound
min: Optional inclusive lower bound

Attributes

Inherited methods

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

In this article

Generated with