Metadata-Version: 2.4
Name: llama-index-tools-seltz
Version: 0.2.0
Summary: llama-index tools seltz integration
Author-email: Your Name <you@example.com>
Maintainer: WilliamEspegren
License-Expression: MIT
License-File: LICENSE
Requires-Python: <4.0,>=3.9
Requires-Dist: llama-index-core<0.15,>=0.13.0
Requires-Dist: seltz>=0.2.0
Description-Content-Type: text/markdown

# Seltz Web Knowledge Tool

[Seltz](https://www.seltz.ai/) provides fast, up-to-date web data with context-engineered web content and sources for real-time AI reasoning. Web content is processed and shaped to maximize usefulness for LLMs, AI agents, and RAG pipelines.

To begin, you need to obtain an API key from [Seltz](https://www.seltz.ai/).

## Installation

```bash
pip install llama-index-tools-seltz
```

## Usage

```python
from llama_index.tools.seltz import SeltzToolSpec
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI

seltz_tool = SeltzToolSpec(api_key="your-seltz-api-key")

agent = FunctionAgent(
    tools=seltz_tool.to_tool_list(),
    llm=OpenAI(model="gpt-4o"),
)

await agent.run("What are the latest developments in AI reasoning?")
```

## Available Functions

`search`: Search the web using Seltz and return relevant documents with sources. Returns a list of Document objects containing web content and source URLs.

### Parameters

- `query` (str): The search query text.
- `max_documents` (int, optional): Maximum number of documents to return (default: 10).
- `context` (str, optional): Additional context to refine search results.
- `profile` (str, optional): Profile to customize search behavior.

### Example

```python
from llama_index.tools.seltz import SeltzToolSpec

seltz_tool = SeltzToolSpec(api_key="your-seltz-api-key")

documents = seltz_tool.search("web knowledge for AI agents", max_documents=5)

for doc in documents:
    print(f"URL: {doc.metadata['url']}")
    print(f"Content: {doc.text[:200]}...")
```

This tool is designed to be used as a way to load data as a Tool in an Agent.
