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

PropertyDefinition

org.llm4s.toolapi.PropertyDefinition
See thePropertyDefinition companion object
@Stable
final case class PropertyDefinition[T]

A named property within an ObjectSchema.

Value parameters

name

Property key in the JSON object

required

Whether the property is required

schema

Schema applied to the property value

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def withName(name: String): PropertyDefinition[T]

Replace the property key.

Replace the property key.

Attributes

def withRequired(required: Boolean): PropertyDefinition[T]

Set whether the property is required.

Set whether the property is required.

Attributes

def withSchema[U](schema: SchemaDefinition[U]): PropertyDefinition[U]

Replace the schema applied to the property value.

Replace the schema applied to the property value.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with