orkes.shared.OrkesToolSchema#
- pydantic model orkes.shared.OrkesToolSchema[source]#
A universal schema for defining a tool that can be used by an LLM.
This schema is used to define a tool that can be used by an LLM. It contains all the necessary information for the LLM to understand what the tool does, what parameters it accepts, and how to call it.
- name#
The name of the tool.
- Type:
str
- description#
A description of what the tool does.
- Type:
str
- parameters#
The schema for the parameters that the tool accepts.
- Type:
- function#
The actual callable function for the tool. Defaults to None.
- Type:
Callable, optional
- Config:
arbitrary_types_allowed: bool = True
- Fields:
description (str)function (Callable | None)name (str)parameters (orkes.shared.schema.ToolParameter)
- field description: str [Required]#
- field function: Callable | None = None#
- field name: str [Required]#
- field parameters: ToolParameter [Required]#