mirror of
https://github.com/simstudioai/sim.git
synced 2026-10-16 14:50:06 +08:00
Theodore LiandTheodore Li
158d5236bc
* feat(hosted keys): Implement serper hosted key * Handle required fields correctly for hosted keys * Add rate limiting (3 tries, exponential backoff) * Add custom pricing, switch to exa as first hosted key * Add telemetry * Consolidate byok type definitions * Add warning comment if default calculation is used * Record usage to user stats table * Fix unit tests, use cost property * Include more metadata in cost output * Fix disabled tests * Fix spacing * Fix lint * Move knowledge cost restructuring away from generic block handler * Migrate knowledge unit tests * Lint * Fix broken tests * Add user based hosted key throttling * Refactor hosted key handling. Add optimistic handling of throttling for custom throttle rules. * Remove research as hosted key. Recommend BYOK if throtttling occurs * Make adding api keys adjustable via env vars * Remove vestigial fields from research * Make billing actor id required for throttling * Switch to round robin for api key distribution * Add helper method for adding hosted key cost * Strip leading double underscores to avoid breaking change * Lint fix * Remove falsy check in favor for explicit null check * Add more detailed metrics for different throttling types * Fix _costDollars field * Handle hosted agent tool calls * Fail loudly if cost field isn't found * Remove any type * Fix type error * Fix lint * Fix usage log double logging data * Fix test --------- Co-authored-by: Theodore Li <teddy@zenobiapay.com>
107 lines
2.8 KiB
TypeScript
107 lines
2.8 KiB
TypeScript
import type { ExaAnswerParams, ExaAnswerResponse } from '@/tools/exa/types'
|
|
import type { ToolConfig } from '@/tools/types'
|
|
|
|
export const answerTool: ToolConfig<ExaAnswerParams, ExaAnswerResponse> = {
|
|
id: 'exa_answer',
|
|
name: 'Exa Answer',
|
|
description: 'Get an AI-generated answer to a question with citations from the web using Exa AI.',
|
|
version: '1.0.0',
|
|
|
|
params: {
|
|
query: {
|
|
type: 'string',
|
|
required: true,
|
|
visibility: 'user-or-llm',
|
|
description: 'The question to answer',
|
|
},
|
|
text: {
|
|
type: 'boolean',
|
|
required: false,
|
|
visibility: 'user-only',
|
|
description: 'Whether to include the full text of the answer',
|
|
},
|
|
apiKey: {
|
|
type: 'string',
|
|
required: true,
|
|
visibility: 'user-only',
|
|
description: 'Exa AI API Key',
|
|
},
|
|
},
|
|
hosting: {
|
|
envKeyPrefix: 'EXA_API_KEY',
|
|
apiKeyParam: 'apiKey',
|
|
byokProviderId: 'exa',
|
|
pricing: {
|
|
type: 'custom',
|
|
getCost: (_params, output) => {
|
|
const costDollars = output.__costDollars as { total?: number } | undefined
|
|
if (costDollars?.total == null) {
|
|
throw new Error('Exa answer response missing costDollars field')
|
|
}
|
|
return { cost: costDollars.total, metadata: { costDollars } }
|
|
},
|
|
},
|
|
rateLimit: {
|
|
mode: 'per_request',
|
|
requestsPerMinute: 5,
|
|
},
|
|
},
|
|
|
|
request: {
|
|
url: 'https://api.exa.ai/answer',
|
|
method: 'POST',
|
|
headers: (params) => ({
|
|
'Content-Type': 'application/json',
|
|
'x-api-key': params.apiKey,
|
|
}),
|
|
body: (params) => {
|
|
const body: Record<string, any> = {
|
|
query: params.query,
|
|
}
|
|
|
|
// Add optional parameters if provided
|
|
if (params.text) body.text = params.text
|
|
|
|
return body
|
|
},
|
|
},
|
|
|
|
transformResponse: async (response: Response) => {
|
|
const data = await response.json()
|
|
|
|
return {
|
|
success: true,
|
|
output: {
|
|
query: data.query || '',
|
|
answer: data.answer || '',
|
|
citations:
|
|
data.citations?.map((citation: any) => ({
|
|
title: citation.title || '',
|
|
url: citation.url,
|
|
text: citation.text || '',
|
|
})) || [],
|
|
__costDollars: data.costDollars,
|
|
},
|
|
}
|
|
},
|
|
|
|
outputs: {
|
|
answer: {
|
|
type: 'string',
|
|
description: 'AI-generated answer to the question',
|
|
},
|
|
citations: {
|
|
type: 'array',
|
|
description: 'Sources and citations for the answer',
|
|
items: {
|
|
type: 'object',
|
|
properties: {
|
|
title: { type: 'string', description: 'The title of the cited source' },
|
|
url: { type: 'string', description: 'The URL of the cited source' },
|
|
text: { type: 'string', description: 'Relevant text from the cited source' },
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|