Skip to content

docs(toolset): add YAML serialization examples #11167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MukundaKatta wants to merge 1 commit into from
+145 −0
Closed

docs(toolset): add YAML serialization examples #11167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
145 changes: 145 additions & 0 deletions docs-website/docs/tools/toolset.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,98 @@ subtract_tool = Tool(
math_toolset = Toolset([add_tool, subtract_tool])
```

### In YAML

This YAML example shows how to define a `Toolset` with multiple tools inside a pipeline definition and reuse that same `Toolset` when configuring a chat generator.

```yaml
components:
math_toolset:
type: haystack.tools.toolset.Toolset
data:
tools:
- type: haystack.tools.tool.Tool
data:
name: add
description: Add two numbers
parameters:
type: object
properties:
a:
type: integer
b:
type: integer
required:
- a
- b
function: your_module.add_numbers
outputs_to_string: null
inputs_from_state: null
outputs_to_state: null
- type: haystack.tools.tool.Tool
data:
name: subtract
description: Subtract b from a
parameters:
type: object
properties:
a:
type: integer
b:
type: integer
required:
- a
- b
function: your_module.subtract_numbers
outputs_to_string: null
inputs_from_state: null
outputs_to_state: null
llm:
type: haystack.components.generators.chat.openai.OpenAIChatGenerator
init_parameters:
model: gpt-4o-mini
tools:
type: haystack.tools.toolset.Toolset
data:
tools:
- type: haystack.tools.tool.Tool
data:
name: add
description: Add two numbers
parameters:
type: object
properties:
a:
type: integer
b:
type: integer
required:
- a
- b
function: your_module.add_numbers
outputs_to_string: null
inputs_from_state: null
outputs_to_state: null
- type: haystack.tools.tool.Tool
data:
name: subtract
description: Subtract b from a
parameters:
type: object
properties:
a:
type: integer
b:
type: integer
required:
- a
- b
function: your_module.subtract_numbers
outputs_to_string: null
inputs_from_state: null
outputs_to_state: null
```

### Adding New Tools to Toolset

```python
Expand Down Expand Up @@ -202,3 +294,56 @@ Output:
```
4 + 2 equals 6.
```

The same serialized `Toolset` can also be passed to an `Agent` in YAML through its `tools` init parameter:

```yaml
components:
agent:
type: haystack.components.agents.agent.Agent
init_parameters:
chat_generator:
type: haystack.components.generators.chat.openai.OpenAIChatGenerator
init_parameters:
model: gpt-4o-mini
tools:
type: haystack.tools.toolset.Toolset
data:
tools:
- type: haystack.tools.tool.Tool
data:
name: add
description: Add two numbers
parameters:
type: object
properties:
a:
type: integer
b:
type: integer
required:
- a
- b
function: your_module.add_numbers
outputs_to_string: null
inputs_from_state: null
outputs_to_state: null
- type: haystack.tools.tool.Tool
data:
name: subtract
description: Subtract b from a
parameters:
type: object
properties:
a:
type: integer
b:
type: integer
required:
- a
- b
function: your_module.subtract_numbers
outputs_to_string: null
inputs_from_state: null
outputs_to_state: null
```