ToolParameterError

org.llm4s.toolapi.ToolParameterError
See theToolParameterError companion trait

Attributes

Companion
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class InvalidNesting(parameterName: String, parentPath: String, parentType: String) extends ToolParameterError

Cannot access a nested property because parent is not an object.

Cannot access a nested property because parent is not an object.

Value parameters

parameterName

name of the parameter being accessed

parentPath

JSON path to the parent element

parentType

actual type of the parent element (e.g. "string", "array")

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MissingParameter(parameterName: String, expectedType: String, availableParameters: List[String]) extends ToolParameterError

A required parameter is completely missing from the arguments.

A required parameter is completely missing from the arguments.

Value parameters

availableParameters

list of parameter names that were provided (hint for self-correction)

expectedType

the expected type of the parameter

parameterName

name of the missing parameter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class MultipleErrors(errors: List[ToolParameterError]) extends ToolParameterError

Aggregation of multiple parameter errors from a single tool call.

Aggregation of multiple parameter errors from a single tool call.

Value parameters

errors

the individual parameter errors

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class NullParameter(parameterName: String, expectedType: String) extends ToolParameterError

A required parameter is present but has a null value.

A required parameter is present but has a null value.

Value parameters

expectedType

the expected non-null type

parameterName

name of the null parameter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class TypeMismatch(parameterName: String, expectedType: String, actualType: String) extends ToolParameterError

A parameter has the wrong type.

A parameter has the wrong type.

Value parameters

actualType

the type that was received

expectedType

the type that was expected

parameterName

name of the mistyped parameter

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror