phoenix-oss/llama-stack
1
0
Fork 0
forked from phoenix-oss/llama-stack-mirror
Code Pull requests Releases Packages 2 Activity Actions

update index.md

Browse source
This commit is contained in:
Dinesh Yeduguru 2025-01-22 16:21:30 -08:00
parent cb27cbd4b5
commit 73243f1348
2 changed files with 40 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

55
docs/source/building_applications/index.md
View file

@ -262,37 +262,58 @@ response = agent.create_turn(
``` ```
### Adding Tools to Agents ### Adding Tools to Agents
```{toctree}
:hidden:
:maxdepth: 3
Agents can be enhanced with various tools: tools
```
1. **Search**: Web search capabilities through providers like Brave Agents can be enhanced with various tools. For detailed information about available tools, their configuration, and providers, see the [Tools](tools.md) documentation.
2. **Code Interpreter**: Execute code snippets
3. **RAG**: Memory and document retrieval
4. **Function Calling**: Custom function execution
5. **WolframAlpha**: Mathematical computations
6. **Photogen**: Image generation
Example of configuring an agent with tools: Tools are configured through the `toolgroups` parameter in the agent configuration. Each tool group can be specified either as a string or with additional arguments:
```python ```python
from llama_stack_client.lib.agents.agent import Agent
from llama_stack_client.types.agent_create_params import AgentConfig
agent_config = AgentConfig( agent_config = AgentConfig(
model="Llama3.2-3B-Instruct", model="Llama3.2-3B-Instruct",
tools=[ instructions="You are a helpful assistant",
# Configure tool groups
toolgroups=[
# Simple string format
"builtin::code_interpreter",
# With arguments format
{ {
"type": "brave_search", "name": "builtin::websearch",
"api_key": "YOUR_API_KEY", "args": {
"engine": "brave" "max_results": 5
}, }
{
"type": "code_interpreter",
"enable_inline_code_execution": True
} }
], ],
tool_choice="auto", tool_choice="auto",
tool_prompt_format="json" tool_prompt_format="json",
# Optional safety configuration
input_shields=["content_safety"],
output_shields=["content_safety"],
# Control the inference loop
max_infer_iters=10,
sampling_params={
"strategy": {
"type": "top_p",
"temperature": 0.7,
"top_p": 0.95
},
"max_tokens": 2048
}
) )
agent = Agent(client, agent_config)
``` ```
For details on available tool groups, providers, and their configuration options, refer to the [Tools](tools.md) documentation.
## Building RAG-Enhanced Agents ## Building RAG-Enhanced Agents
One of the most powerful patterns is combining agents with RAG capabilities. Here's a complete example: One of the most powerful patterns is combining agents with RAG capabilities. Here's a complete example:

4
docs/source/building_applications/tools.md
View file

@ -6,7 +6,7 @@ Tools are treated as any other resource in llama stack like models. you can regi
When instatiating an agent, you can provide it a list of tool groups that it has access to. Agent gets the corresponding tool definitions for the specified tool gropus and pass along to the model When instatiating an agent, you can provide it a list of tool groups that it has access to. Agent gets the corresponding tool definitions for the specified tool gropus and pass along to the model
Refer to the [Building AI Applications](../notebooks/Llama_Stack_Building_AI_Applications.ipynb) notebook for more examples on how to use tools. Refer to the [Building AI Applications](../../notebooks/Llama_Stack_Building_AI_Applications.ipynb) notebook for more examples on how to use tools.
## Types of Tool Group providers ## Types of Tool Group providers
@ -81,7 +81,7 @@ result = client.tools.invoke_tool(
) )
``` ```
### Memory Tool #### Memory
The Memory tool enables retrieval of context from various types of memory banks (vector, key-value, keyword, and graph). The Memory tool enables retrieval of context from various types of memory banks (vector, key-value, keyword, and graph).