diff --git a/docs.json b/docs.json index c031202f7..461450f68 100644 --- a/docs.json +++ b/docs.json @@ -1813,6 +1813,20 @@ ] } ] + }, + { + "group": "Tzafon", + "pages": [ + "models/providers/gateways/tzafon/overview", + { + "group": "Usage", + "pages": [ + "models/providers/gateways/tzafon/usage/basic", + "models/providers/gateways/tzafon/usage/basic-stream", + "models/providers/gateways/tzafon/usage/tool-use" + ] + } + ] } ] }, @@ -4161,8 +4175,7 @@ "group": "Agno v2 Migration", "pages": [ "other/v2-migration", - "other/v2-changelog" - ] + "other/v2-changelog"] }, "other/database-migrations", "other/workflows-migration" @@ -4209,10 +4222,7 @@ }, { "group": "MCP", - "pages": [ - "agent-os/mcp/mcp", - "agent-os/mcp/tools" - ] + "pages": ["agent-os/mcp/mcp", "agent-os/mcp/tools"] }, { "group": "Middleware", @@ -4524,21 +4534,15 @@ }, { "group": "Dash", - "pages": [ - "deploy/templates/dash/overview" - ] + "pages": ["deploy/templates/dash/overview"] }, { "group": "Scout", - "pages": [ - "deploy/templates/scout/overview" - ] + "pages": ["deploy/templates/scout/overview"] }, { "group": "Gcode", - "pages": [ - "deploy/templates/gcode/overview" - ] + "pages": ["deploy/templates/gcode/overview"] } ] }, @@ -4562,9 +4566,7 @@ }, { "group": "Teams", - "pages": [ - "deploy/apps/teams/content-team" - ] + "pages": ["deploy/apps/teams/content-team"] }, { "group": "Workflows", @@ -4582,39 +4584,27 @@ "pages": [ { "group": "Slack", - "pages": [ - "deploy/interfaces/slack/overview" - ] + "pages": ["deploy/interfaces/slack/overview"] }, { "group": "Discord", - "pages": [ - "deploy/interfaces/discord/overview" - ] + "pages": ["deploy/interfaces/discord/overview"] }, { "group": "WhatsApp", - "pages": [ - "deploy/interfaces/whatsapp/overview" - ] + "pages": ["deploy/interfaces/whatsapp/overview"] }, { "group": "MCP", - "pages": [ - "deploy/interfaces/mcp/overview" - ] + "pages": ["deploy/interfaces/mcp/overview"] }, { "group": "AG-UI", - "pages": [ - "deploy/interfaces/ag-ui/overview" - ] + "pages": ["deploy/interfaces/ag-ui/overview"] }, { "group": "Telegram", - "pages": [ - "deploy/interfaces/telegram/overview" - ] + "pages": ["deploy/interfaces/telegram/overview"] } ] } @@ -7172,10 +7162,7 @@ }, { "group": "Team", - "pages": [ - "reference/teams/team", - "reference/teams/remote-team" - ] + "pages": ["reference/teams/team", "reference/teams/remote-team"] }, { "group": "Workflows", @@ -7228,15 +7215,11 @@ }, { "group": "Memory", - "pages": [ - "reference/memory/memory" - ] + "pages": ["reference/memory/memory"] }, { "group": "Context Compression", - "pages": [ - "reference/compression/compression-manager" - ] + "pages": ["reference/compression/compression-manager"] }, { "group": "Database", @@ -7258,10 +7241,7 @@ }, { "group": "Tracing", - "pages": [ - "reference/tracing/trace", - "reference/tracing/span" - ] + "pages": ["reference/tracing/trace", "reference/tracing/span"] }, { "group": "Hooks", @@ -7302,6 +7282,7 @@ "reference/models/perplexity", "reference/models/requesty", "reference/models/together", + "reference/models/tzafon", "reference/models/xai", "reference/models/vercel", "reference/models/bedrock", @@ -7371,9 +7352,7 @@ }, { "group": "Rerankers", - "pages": [ - "reference/knowledge/reranker/cohere" - ] + "pages": ["reference/knowledge/reranker/cohere"] }, { "group": "Chunking", @@ -7405,15 +7384,11 @@ "reference-api/overview", { "group": "Home", - "pages": [ - "reference-api/schema/home/api-information" - ] + "pages": ["reference-api/schema/home/api-information"] }, { "group": "Health", - "pages": [ - "reference-api/schema/health/health-check" - ] + "pages": ["reference-api/schema/health/health-check"] }, { "group": "Core", @@ -7457,9 +7432,7 @@ }, { "group": "Slack", - "pages": [ - "reference-api/schema/slack/slack-events" - ] + "pages": ["reference-api/schema/slack/slack-events"] }, { "group": "Whatsapp", @@ -7590,9 +7563,7 @@ }, { "group": "Registry", - "pages": [ - "reference-api/schema/registry/list-registry" - ] + "pages": ["reference-api/schema/registry/list-registry"] }, { "group": "Schedules", diff --git a/models/providers/gateways/tzafon/overview.mdx b/models/providers/gateways/tzafon/overview.mdx new file mode 100644 index 000000000..fb55a1b8c --- /dev/null +++ b/models/providers/gateways/tzafon/overview.mdx @@ -0,0 +1,61 @@ +--- +title: Tzafon +sidebarTitle: Overview +description: Use Tzafon models with Agno agents. +--- + +Tzafon provides OpenAI-compatible API endpoints for its language models. +See their documentation [here](https://docs.tzafon.ai/core-concepts/chat-completions). + +Available models include `tzafon.sm-1` and `tzafon.northstar-cua-fast`. + +## Authentication + +Set your `TZAFON_API_KEY` environment variable. Get your key from the [Tzafon developer dashboard](https://tzafon.ai/developer). + + + +```bash Mac +export TZAFON_API_KEY=*** +``` + +```bash Windows +setx TZAFON_API_KEY *** +``` + + + +## Example + +Use `Tzafon` with your `Agent`: + + + +```python agent.py +from agno.agent import Agent +from agno.models.tzafon import Tzafon + +agent = Agent( + model=Tzafon(id="tzafon.sm-1"), + markdown=True +) + +# Print the response in the terminal +agent.print_response("Share a 2 sentence horror story.") +``` + + + + View more examples [here](/models/providers/gateways/tzafon/usage/basic-stream). + +## Params + +| Parameter | Type | Default | Description | +| ------------ | ------------------ | --------------------------------------------- | --------------------------------------------------------------------- | +| `id` | `str` | `"tzafon.sm-1"` | The id of the Tzafon model to use | +| `name` | `str` | `"Tzafon"` | The name of the model | +| `provider` | `str` | `"Tzafon"` | The provider of the model | +| `api_key` | `Optional[str]` | `None` | The API key for Tzafon (defaults to TZAFON_API_KEY env var) | +| `base_url` | `str` | `"https://api.tzafon.ai/v1"` | The base URL for the Tzafon API | + +`Tzafon` also supports the params of [OpenAI](/reference/models/openai). diff --git a/models/providers/gateways/tzafon/usage/basic-stream.mdx b/models/providers/gateways/tzafon/usage/basic-stream.mdx new file mode 100644 index 000000000..8459d0589 --- /dev/null +++ b/models/providers/gateways/tzafon/usage/basic-stream.mdx @@ -0,0 +1,23 @@ +--- +title: Basic Streaming Agent +sidebarTitle: Basic Stream +description: Create a basic streaming Agno agent using Tzafon. +--- + +```python cookbook/90_models/tzafon/basic_stream.py +from typing import Iterator +from agno.agent import Agent, RunOutputEvent +from agno.models.tzafon import Tzafon + +agent = Agent( + model=Tzafon(id="tzafon.sm-1"), markdown=True +) + +# Get the response in a variable +# run_response: Iterator[RunOutputEvent] = agent.run("Share a 2 sentence horror story", stream=True) +# for chunk in run_response: +# print(chunk.content) + +# Print the response in the terminal +agent.print_response("Share a 2 sentence horror story", stream=True) +``` diff --git a/models/providers/gateways/tzafon/usage/basic.mdx b/models/providers/gateways/tzafon/usage/basic.mdx new file mode 100644 index 000000000..dd6f39ac4 --- /dev/null +++ b/models/providers/gateways/tzafon/usage/basic.mdx @@ -0,0 +1,21 @@ +--- +title: Basic Agent +sidebarTitle: Basic +description: Create a basic Agno agent using Tzafon. +--- + +```python cookbook/90_models/tzafon/basic.py +from agno.agent import Agent, RunOutput +from agno.models.tzafon import Tzafon + +agent = Agent( + model=Tzafon(id="tzafon.sm-1"), markdown=True +) + +# Get the response in a variable +# run: RunOutput = agent.run("Share a 2 sentence horror story") +# print(run.content) + +# Print the response in the terminal +agent.print_response("Share a 2 sentence horror story") +``` diff --git a/models/providers/gateways/tzafon/usage/tool-use.mdx b/models/providers/gateways/tzafon/usage/tool-use.mdx new file mode 100644 index 000000000..0c755ead5 --- /dev/null +++ b/models/providers/gateways/tzafon/usage/tool-use.mdx @@ -0,0 +1,20 @@ +--- +title: Agent with Tools +sidebarTitle: Tool Use +description: Use Tzafon with tool-equipped Agno agents. +--- + +```python cookbook/90_models/tzafon/tool_use.py +"""Run `uv pip install ddgs` to install dependencies.""" + +from agno.agent import Agent +from agno.models.tzafon import Tzafon +from agno.tools.websearch import WebSearchTools + +agent = Agent( + model=Tzafon(id="tzafon.sm-1"), + tools=[WebSearchTools()], + markdown=True, +) +agent.print_response("Whats happening in France?") +``` diff --git a/models/providers/model-index.mdx b/models/providers/model-index.mdx index aea2858b0..20f32e581 100644 --- a/models/providers/model-index.mdx +++ b/models/providers/model-index.mdx @@ -361,6 +361,14 @@ Agno supports the following model providers organized by category: > SiliconFlow model provider. + + Tzafon AI models integration. +