orkes.shared.ToolParameter

pydantic model orkes.shared.ToolParameter

Represents the JSON Schema for the parameters of a tool.

This class defines the structure of the parameters that a tool can accept, following the JSON Schema specification. This allows for clear and unambiguous definition of a tool’s inputs.

type

The type of the parameter, which is ‘object’ by default.

Type:

str

properties

A dictionary defining the properties of the object, where each key is a parameter name and the value is its schema.

Type:

Dict[str, Any]

required

A list of required parameter names.

Type:

Optional[List[str]]

Fields:

• properties (Dict[str, Any])

• required (List[str] | None)

• type (str)

field properties: Dict[str, Any] [Required]

field required: List[str] | None = None

field type: str = 'object'