solana-agent 23.0.0__tar.gz → 23.0.2__tar.gz

{solana_agent-23.0.0 → solana_agent-23.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: solana-agent
-Version: 23.0.0
+Version: 23.0.2
 Summary: Agentic IQ
 License: MIT
 Keywords: ai,openai,ai agents,agi
@@ -81,6 +81,51 @@ You can install Solana Agent using pip:
 
 `pip install solana-agent`
 
+## Flows
+
+In both flows of single and multiple agents - it is one user query to one agent using one tool (if needed).
+
+An agent can have multiple tools and will choose the best one to answer the user query.
+
+Routing is determined by optimal domain expertise of the agent for the user query.
+
+When the agent uses a tool it feeds the tool output back into the agent to generate the final response.
+
+This is important as tools generally output unstructured and unformatted data that the agent needs to prepare for the user.
+
+Keep this in mind while designing your agentic systems using Solana Agent.
+
+```ascii
+                       Single Agent                                     
+                                                                        
+     ┌────────┐        ┌─────────┐        ┌────────┐                    
+     │        │        │         │        │        │                    
+     │        │        │         │        │        │                    
+     │  User  │◄──────►│  Agent  │◄──────►│  Tool  │                    
+     │        │        │         │        │        │                    
+     │        │        │         │        │        │                    
+     └────────┘        └─────────┘        └────────┘                    
+                                                                        
+                                                                        
+                                                                        
+                                                                        
+                                                                        
+                      Multiple Agents                                   
+                                                                        
+     ┌────────┐        ┌──────────┐        ┌─────────┐        ┌────────┐
+     │        │        │          │        │         │        │        │
+     │        │        │          │        │         │        │        │
+┌───►│  User  ├───────►│  Router  ├───────►│  Agent  │◄──────►│  Tool  │
+│    │        │        │          │        │         │        │        │
+│    │        │        │          │        │         │        │        │
+│    └────────┘        └──────────┘        └────┬────┘        └────────┘
+│                                               │                       
+│                                               │                       
+│                                               │                       
+│                                               │                       
+└───────────────────────────────────────────────┘                       
+```
+
 ## Usage
 
 ### Text/Text Streaming
@@ -112,6 +157,10 @@ async for response in solana_agent.process("user123", "What are the latest AI de
     print(response, end="")
 ```
 
+OpenAI API calls with no tool call = 1 (text)
+
+OpenAI API calls with tool call = 2 (text, text)
+
 ### Audio/Audio Streaming
 
 ```python
@@ -143,6 +192,10 @@ async for response in solana_agent.process("user123", audio_content, output_form
     print(response, end="")
 ```
 
+OpenAI API calls with no tool call = 3 (audio transcribe, text, TTS)
+
+OpenAI API calls with tool call = 4 (audio transcribe, text, text, TTS)
+
 ### Text/Audio Streaming
 
 ```python
@@ -172,6 +225,10 @@ async for response in solana_agent.process("user123", "What is the latest news o
     print(response, end="")
 ```
 
+OpenAI API calls with no tool call = 2 (text, TTS)
+
+OpenAI API calls with tool call = 3 (text, text, TTS)
+
 ### Audio/Text Streaming
 
 ```python
@@ -203,6 +260,10 @@ async for response in solana_agent.process("user123", audio_content, audio_input
     print(response, end="")
 ```
 
+OpenAI API calls with no tool call = 2 (audio transcribe, text)
+
+OpenAI API calls with tool call = 3 (audio transcribe, text, text)
+
 ## Optional Feature Configs
 
 ### Business Alignment
@@ -248,14 +309,14 @@ config = {
 
 This mode is great for text output where the default response from OpenAI is enough.
 
-However, it is also found to sometimes not not call tools when the tool should be called.
+However, it is also found to sometimes to not call tools when the tool should be called.
 
-It is faster than calling `search_internet` from `sakit` and saves at least 2 API calls.
+It is faster than calling `search_internet` from `sakit` by saving 2 API calls.
 
-The default mode is disabled due to the issue of not calling tools properly.
+The default mode is disabled due to the issue of not calling tools properly and is not suitable for audio output.
 
 ```python
-async for response in solana_agent.process("user123", "Write me a poem.", internet_search=True):
+async for response in solana_agent.process("user123", "What is the latest news on Canada?", internet_search=True):
     print(response, end="")
 ```
 
@@ -498,7 +559,19 @@ The official example app written in FastAPI and Next.js
 
 ## Agent Framework Comparisons
 
-[Compare Python Agent Frameworks](https://github.com/truemagic-coder/solana-agent/blob/main/compare.md)
+[Compare Python Agent Frameworks](https://github.com/truemagic-coder/solana-agent/wiki/Agent-Framework-Comparisons)
+
+## Contributing
+
+If you have a question, feedback, or feature request - please open a GitHub discussion.
+
+If you find a bug - please open a GitHub issue.
+
+We are currently accepting PRs if approved in discussions. Make sure all tests pass and the README & docs are updated.
+
+To run the documentation site locally run `make livehtml` in the root directory.
+
+To run the test suite locally run `poetry run pytest --cov=solana_agent --cov-report=html` in the root directory.
 
 ## License
 

{solana_agent-23.0.0 → solana_agent-23.0.2}/README.md

@@ -57,6 +57,51 @@ You can install Solana Agent using pip:
 
 `pip install solana-agent`
 
+## Flows
+
+In both flows of single and multiple agents - it is one user query to one agent using one tool (if needed).
+
+An agent can have multiple tools and will choose the best one to answer the user query.
+
+Routing is determined by optimal domain expertise of the agent for the user query.
+
+When the agent uses a tool it feeds the tool output back into the agent to generate the final response.
+
+This is important as tools generally output unstructured and unformatted data that the agent needs to prepare for the user.
+
+Keep this in mind while designing your agentic systems using Solana Agent.
+
+```ascii
+                       Single Agent                                     
+                                                                        
+     ┌────────┐        ┌─────────┐        ┌────────┐                    
+     │        │        │         │        │        │                    
+     │        │        │         │        │        │                    
+     │  User  │◄──────►│  Agent  │◄──────►│  Tool  │                    
+     │        │        │         │        │        │                    
+     │        │        │         │        │        │                    
+     └────────┘        └─────────┘        └────────┘                    
+                                                                        
+                                                                        
+                                                                        
+                                                                        
+                                                                        
+                      Multiple Agents                                   
+                                                                        
+     ┌────────┐        ┌──────────┐        ┌─────────┐        ┌────────┐
+     │        │        │          │        │         │        │        │
+     │        │        │          │        │         │        │        │
+┌───►│  User  ├───────►│  Router  ├───────►│  Agent  │◄──────►│  Tool  │
+│    │        │        │          │        │         │        │        │
+│    │        │        │          │        │         │        │        │
+│    └────────┘        └──────────┘        └────┬────┘        └────────┘
+│                                               │                       
+│                                               │                       
+│                                               │                       
+│                                               │                       
+└───────────────────────────────────────────────┘                       
+```
+
 ## Usage
 
 ### Text/Text Streaming
@@ -88,6 +133,10 @@ async for response in solana_agent.process("user123", "What are the latest AI de
     print(response, end="")
 ```
 
+OpenAI API calls with no tool call = 1 (text)
+
+OpenAI API calls with tool call = 2 (text, text)
+
 ### Audio/Audio Streaming
 
 ```python
@@ -119,6 +168,10 @@ async for response in solana_agent.process("user123", audio_content, output_form
     print(response, end="")
 ```
 
+OpenAI API calls with no tool call = 3 (audio transcribe, text, TTS)
+
+OpenAI API calls with tool call = 4 (audio transcribe, text, text, TTS)
+
 ### Text/Audio Streaming
 
 ```python
@@ -148,6 +201,10 @@ async for response in solana_agent.process("user123", "What is the latest news o
     print(response, end="")
 ```
 
+OpenAI API calls with no tool call = 2 (text, TTS)
+
+OpenAI API calls with tool call = 3 (text, text, TTS)
+
 ### Audio/Text Streaming
 
 ```python
@@ -179,6 +236,10 @@ async for response in solana_agent.process("user123", audio_content, audio_input
     print(response, end="")
 ```
 
+OpenAI API calls with no tool call = 2 (audio transcribe, text)
+
+OpenAI API calls with tool call = 3 (audio transcribe, text, text)
+
 ## Optional Feature Configs
 
 ### Business Alignment
@@ -224,14 +285,14 @@ config = {
 
 This mode is great for text output where the default response from OpenAI is enough.
 
-However, it is also found to sometimes not not call tools when the tool should be called.
+However, it is also found to sometimes to not call tools when the tool should be called.
 
-It is faster than calling `search_internet` from `sakit` and saves at least 2 API calls.
+It is faster than calling `search_internet` from `sakit` by saving 2 API calls.
 
-The default mode is disabled due to the issue of not calling tools properly.
+The default mode is disabled due to the issue of not calling tools properly and is not suitable for audio output.
 
 ```python
-async for response in solana_agent.process("user123", "Write me a poem.", internet_search=True):
+async for response in solana_agent.process("user123", "What is the latest news on Canada?", internet_search=True):
     print(response, end="")
 ```
 
@@ -474,7 +535,19 @@ The official example app written in FastAPI and Next.js
 
 ## Agent Framework Comparisons
 
-[Compare Python Agent Frameworks](https://github.com/truemagic-coder/solana-agent/blob/main/compare.md)
+[Compare Python Agent Frameworks](https://github.com/truemagic-coder/solana-agent/wiki/Agent-Framework-Comparisons)
+
+## Contributing
+
+If you have a question, feedback, or feature request - please open a GitHub discussion.
+
+If you find a bug - please open a GitHub issue.
+
+We are currently accepting PRs if approved in discussions. Make sure all tests pass and the README & docs are updated.
+
+To run the documentation site locally run `make livehtml` in the root directory.
+
+To run the test suite locally run `poetry run pytest --cov=solana_agent --cov-report=html` in the root directory.
 
 ## License
 

{solana_agent-23.0.0 → solana_agent-23.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "solana-agent"
-version = "23.0.0"
+version = "23.0.2"
 description = "Agentic IQ"
 authors = ["Bevan Hunt <bevan@bevanhunt.com>"]
 license = "MIT"