5e89b8c6d1
* feat: add all the new component docs to the site * fix(docs): relative links and markdown warnings * feat(docs): How to contribute to the docs as a docs section * fix(docs): missed docs page for developer setup * fix(docs): re-add configurations options * fix(docs): bad link to components fixed * fix(docs): bad link to components fixed * ref(docs): reorder some items to make more sense * fix(docs): bad indentation and duplicate block * fix(docs): warning about out of date markdown extension * fix(docs): broken links fixed * fix(docs): markdown formatter complaints
3.2 KiB
🛠️ Commands
Commands are a way for the agent to do anything; e.g. interact with the user or APIs and use tools. They are provided by components that implement the CommandProvider ⚙️ Protocol. Commands are functions that can be called by the agent, they can have parameters and return values that will be seen by the agent.
class CommandProvider(Protocol):
def get_commands(self) -> Iterator[Command]:
...
command decorator
The easiest and recommended way to provide a command is to use command decorator on a component method and then just yield it in get_commands as part of your provider. Each command needs a name, description and a parameter schema - JSONSchema. By default method name is used as a command name, and first part of docstring for the description (before first double newline) and schema can be provided in the decorator.
Example usage of command decorator
# Assuming this is inside some component class
@command(
parameters={
"a": JSONSchema(
type=JSONSchema.Type.INTEGER,
description="The first number",
required=True,
),
"b": JSONSchema(
type=JSONSchema.Type.INTEGER,
description="The second number",
required=True,
)})
def multiply(self, a: int, b: int) -> str:
"""
Multiplies two numbers.
Args:
a: First number
b: Second number
Returns:
Result of multiplication
"""
return str(a * b)
The agent will be able to call this command, named multiply with two arguments and will receive the result. The command description will be: Multiplies two numbers.
We can provide names and description in the decorator, the above command is equivalent to:
@command(
names=["multiply"],
description="Multiplies two numbers.",
parameters={
"a": JSONSchema(
type=JSONSchema.Type.INTEGER,
description="The first number",
required=True,
),
"b": JSONSchema(
type=JSONSchema.Type.INTEGER,
description="The second number",
required=True,
)})
def multiply_command(self, a: int, b: int) -> str:
return str(a * b)
To provide the multiply command to the agent, we need to yield it in get_commands:
def get_commands(self) -> Iterator[Command]:
yield self.multiply
Creating Command directly
If you don't want to use the decorator, you can create a Command object directly.
def multiply(self, a: int, b: int) -> str:
return str(a * b)
def get_commands(self) -> Iterator[Command]:
yield Command(
names=["multiply"],
description="Multiplies two numbers.",
method=self.multiply,
parameters=[
CommandParameter(name="a", spec=JSONSchema(
type=JSONSchema.Type.INTEGER,
description="The first number",
required=True,
)),
CommandParameter(name="b", spec=JSONSchema(
type=JSONSchema.Type.INTEGER,
description="The second number",
required=True,
)),
],
)