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

docs: update rag.md example code to prevent errors (#1009)

Browse source
This commit is contained in:
Michael Clifford 2025-02-10 09:25:30 -05:00 • committed by GitHub
parent 8186c88021
commit 076213165c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 13 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/source/building_applications/rag.md
View file

@ -36,13 +36,12 @@ chunks = [
"content": "Your document text here", "content": "Your document text here",
"mime_type": "text/plain", "mime_type": "text/plain",
}, },
...,
] ]
client.vector_io.insert(vector_db_id, chunks) client.vector_io.insert(vector_db_id=vector_db_id, chunks=chunks)
# You can then query for these chunks # You can then query for these chunks
chunks_response = client.vector_io.query( chunks_response = client.vector_io.query(
vector_db_id, query="What do you know about..." vector_db_id=vector_db_id, query="What do you know about..."
) )
``` ```
@ -72,8 +71,8 @@ client.tool_runtime.rag_tool.insert(
# Query documents # Query documents
results = client.tool_runtime.rag_tool.query( results = client.tool_runtime.rag_tool.query(
vector_db_id=vector_db_id, vector_db_ids=[vector_db_id],
query="What do you know about...", content="What do you know about...",
) )
``` ```
@ -82,10 +81,14 @@ results = client.tool_runtime.rag_tool.query(
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:
```python ```python
from llama_stack_client.types.agent_create_params import AgentConfig
from llama_stack_client.lib.agents.agent import Agent
# Configure agent with memory # Configure agent with memory
agent_config = AgentConfig( agent_config = AgentConfig(
model="Llama3.2-3B-Instruct", model="meta-llama/Llama-3.2-3B-Instruct",
instructions="You are a helpful assistant", instructions="You are a helpful assistant",
enable_session_persistence=False,
toolgroups=[ toolgroups=[
{ {
"name": "builtin::rag", "name": "builtin::rag",
@ -105,10 +108,10 @@ response = agent.create_turn(
{"role": "user", "content": "I am providing some documents for reference."} {"role": "user", "content": "I am providing some documents for reference."}
], ],
documents=[ documents=[
dict( {
content="https://raw.githubusercontent.com/example/doc.rst", "content": "https://raw.githubusercontent.com/example/doc.rst",
mime_type="text/plain", "mime_type": "text/plain",
) }
], ],
session_id=session_id, session_id=session_id,
) )