Backfill skills/synthetic-search block
This commit is contained in:
parent
451da22659
commit
43be571463
56
skills/synthetic-search.md
Normal file
56
skills/synthetic-search.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
|
||||
# Synthetic Search Skill
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
Use this skill when:
|
||||
- You need to search the web for information
|
||||
- You need privacy-focused search (Synthetic API has zero data retention)
|
||||
- You need web search results formatted as JSON
|
||||
|
||||
## How to Use
|
||||
|
||||
The skill provides a Python function `search_synthetic` that makes API calls to Synthetic search:
|
||||
|
||||
```python
|
||||
# Import and call the function
|
||||
from tools.search_synthetic import search_synthetic
|
||||
|
||||
results = search_synthetic(query="your search query", num_results=10)
|
||||
# Returns JSON string of search results
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
- `query` (str, required): The search query to look up on the web
|
||||
- `num_results` (int, optional): Maximum number of results to return (default: 10)
|
||||
|
||||
## Returns
|
||||
|
||||
JSON string containing search results array or error message.
|
||||
|
||||
## Example Usage
|
||||
|
||||
```python
|
||||
results = search_synthetic("Letta AI agent memory architecture", num_results=5)
|
||||
# Parse JSON and extract results
|
||||
import json
|
||||
data = json.loads(results)
|
||||
for result in data:
|
||||
print(result['title'], result['url'])
|
||||
```
|
||||
|
||||
## API Key
|
||||
|
||||
The function reads `SYNTHETIC_API_KEY` from environment variables.
|
||||
If not set, uses default key (for development).
|
||||
|
||||
## Notes
|
||||
|
||||
- Zero data retention (privacy-focused)
|
||||
- 30 second timeout
|
||||
- Returns raw JSON, not formatted text
|
||||
- Handle errors by checking for "error" key in response
|
||||
Reference in New Issue
Block a user