@veroq/ai 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +107 -0
- package/dist/index.d.ts +961 -0
- package/dist/index.js +911 -0
- package/dist/index.js.map +1 -0
- package/package.json +54 -0
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# @veroq/ai
|
|
2
|
+
|
|
3
|
+
VEROQ tools for the [Vercel AI SDK](https://sdk.vercel.ai). Drop verified financial intelligence into any AI SDK agent with one line.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @veroq/ai polaris-news-api ai zod
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { generateText } from "ai";
|
|
15
|
+
import { openai } from "@ai-sdk/openai";
|
|
16
|
+
import { veroqSearch, veroqFeed } from "@veroq/ai";
|
|
17
|
+
|
|
18
|
+
const result = await generateText({
|
|
19
|
+
model: openai("gpt-4o"),
|
|
20
|
+
tools: {
|
|
21
|
+
searchNews: veroqSearch({ apiKey: "your-api-key" }),
|
|
22
|
+
getLatest: veroqFeed({ apiKey: "your-api-key" }),
|
|
23
|
+
},
|
|
24
|
+
prompt: "What's happening in AI today?",
|
|
25
|
+
});
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
If you've set the `POLARIS_API_KEY` environment variable, you can omit the `apiKey` option:
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
const result = await generateText({
|
|
32
|
+
model: openai("gpt-4o"),
|
|
33
|
+
tools: {
|
|
34
|
+
searchNews: veroqSearch(),
|
|
35
|
+
getLatest: veroqFeed(),
|
|
36
|
+
},
|
|
37
|
+
prompt: "What's happening in AI today?",
|
|
38
|
+
});
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Tools
|
|
42
|
+
|
|
43
|
+
| Export | Description |
|
|
44
|
+
|--------|------------|
|
|
45
|
+
| `veroqSearch()` | Search verified news briefs with confidence scores |
|
|
46
|
+
| `veroqFeed()` | Get latest intelligence feed |
|
|
47
|
+
| `veroqBrief()` | Get a specific brief by ID |
|
|
48
|
+
| `veroqExtract()` | Extract article content from URLs |
|
|
49
|
+
| `veroqEntities()` | Look up entity coverage |
|
|
50
|
+
| `veroqTrending()` | Get trending entities |
|
|
51
|
+
| `veroqCompare()` | Compare outlet coverage of a story |
|
|
52
|
+
| `veroqResearch()` | Deep multi-source research (5 credits) |
|
|
53
|
+
| `veroqVerify()` | Fact-check a claim against briefs (3 credits) |
|
|
54
|
+
| `veroqTimeline()` | Story evolution timeline for living briefs |
|
|
55
|
+
| `veroqForecast()` | Forward-looking topic forecasts |
|
|
56
|
+
| `veroqContradictions()` | Find contradictions across intelligence |
|
|
57
|
+
| `veroqEvents()` | Notable events from intelligence briefs |
|
|
58
|
+
| `veroqWebSearch()` | Web search with trust scoring |
|
|
59
|
+
| `veroqCrawl()` | Extract structured content from URLs |
|
|
60
|
+
| `veroqTickerResolve()` | Resolve ticker symbols |
|
|
61
|
+
| `veroqTicker()` | Get ticker price data |
|
|
62
|
+
| `veroqTickerHistory()` | Historical ticker data |
|
|
63
|
+
| `veroqTickerScore()` | Composite trading signal score |
|
|
64
|
+
| `veroqSectors()` | Sector overview with sentiment |
|
|
65
|
+
| `veroqPortfolioFeed()` | Portfolio-aware news feed |
|
|
66
|
+
| `veroqEventsCalendar()` | Events calendar |
|
|
67
|
+
| `veroqCandles()` | OHLCV candlestick data |
|
|
68
|
+
| `veroqTechnicals()` | Technical indicators and signals |
|
|
69
|
+
| `veroqMarketMovers()` | Top gainers, losers, most active |
|
|
70
|
+
| `veroqEconomy()` | Macroeconomic indicators |
|
|
71
|
+
| `veroqForex()` | Foreign exchange rates |
|
|
72
|
+
| `veroqCommodities()` | Commodity prices |
|
|
73
|
+
| `veroqCrypto()` | Cryptocurrency data |
|
|
74
|
+
| `veroqCryptoDefi()` | DeFi TVL and protocol data |
|
|
75
|
+
| `veroqBacktest()` | Backtesting with equity curves |
|
|
76
|
+
| `veroqCorrelation()` | Correlation matrix analysis |
|
|
77
|
+
| `veroqScreener()` | Multi-criteria stock/crypto screener |
|
|
78
|
+
| `veroqNewsImpact()` | News impact scoring |
|
|
79
|
+
| `veroqCompetitors()` | Competitor intelligence |
|
|
80
|
+
| `veroqSocialSentiment()` | Social media sentiment |
|
|
81
|
+
| `veroqSocialTrending()` | Social media trending topics |
|
|
82
|
+
| `veroqIpoCalendar()` | IPO calendar from SEC filings |
|
|
83
|
+
| `veroqTickerNews()` | Ticker-specific news |
|
|
84
|
+
| `veroqTickerAnalysis()` | Comprehensive ticker analysis |
|
|
85
|
+
| `veroqSearchSuggest()` | Search autocomplete |
|
|
86
|
+
| `veroqDefiProtocol()` | Detailed DeFi protocol data |
|
|
87
|
+
| `veroqEconomyIndicator()` | Specific economic indicators |
|
|
88
|
+
| `veroqGenerateReport()` | AI-powered research reports |
|
|
89
|
+
| `veroqGetReport()` | Retrieve generated reports |
|
|
90
|
+
| `veroqAsk()` | Natural language financial queries |
|
|
91
|
+
| `veroqFull()` | Full ticker profile |
|
|
92
|
+
| `veroqInsider()` | Insider trading activity |
|
|
93
|
+
| `veroqFilings()` | SEC filings |
|
|
94
|
+
| `veroqAnalysts()` | Analyst ratings and targets |
|
|
95
|
+
| `veroqCongress()` | Congressional trading activity |
|
|
96
|
+
| `veroqInstitutions()` | Institutional ownership |
|
|
97
|
+
| `veroqRunAgent()` | Run pre-built AI agents |
|
|
98
|
+
|
|
99
|
+
Each function accepts an optional `{ apiKey }` config and returns an AI SDK `tool()`.
|
|
100
|
+
|
|
101
|
+
## Get an API Key
|
|
102
|
+
|
|
103
|
+
Sign up at [veroq.ai/settings](https://veroq.ai/settings).
|
|
104
|
+
|
|
105
|
+
## License
|
|
106
|
+
|
|
107
|
+
MIT
|