Skip to content

Open source file-system and knowledge based agent template. Build AI agents that stay up to date with your knowledge base

feat: add user ID and adapter tags to AI Gateway requests (#44)

Ben Sabicfa7414d68817
diff --git a/apps/app/app/pages/admin/users.vue b/apps/app/app/pages/admin/users.vue
index eb54320..965b6da 100644
--- a/apps/app/app/pages/admin/users.vue
+++ b/apps/app/app/pages/admin/users.vue
@@ -33,7 +33,9 @@ const pagination = ref({ pageIndex: 0, pageSize: 10 })
const deleteModalOpen = computed({
get: () => userToDelete.value !== null,
- set: (v: boolean) => { if (!v) userToDelete.value = null },
+ set: (v: boolean) => {
+ if (!v) userToDelete.value = null
+ },
})
const columns: TableColumn<AdminUserRow>[] = [
@@ -103,12 +105,18 @@ function isCurrentUser(userId: string): boolean {
function getRowActions(row: AdminUserRow) {
if (isCurrentUser(row.id)) return []
- return [[{
- label: 'Delete user',
- icon: 'i-lucide-trash-2',
- color: 'error' as const,
- onSelect: () => { userToDelete.value = row },
- }]]
+ return [
+ [
+ {
+ label: 'Delete user',
+ icon: 'i-lucide-trash-2',
+ color: 'error' as const,
+ onSelect: () => {
+ userToDelete.value = row
+ },
+ },
+ ],
+ ]
}
async function deleteUser() {
@@ -236,14 +244,14 @@ async function changeRole(row: AdminUserRow, newRole: UserRole) {
<UTable
ref="table"
+ v-model:global-filter="globalFilter"
+ v-model:sorting="sorting"
+ v-model:pagination="pagination"
:data="users ?? []"
- :columns="columns"
+ :columns
:loading="status === 'pending' && !users"
- v-model:global-filter="globalFilter"
:global-filter-options="{ filterFn: 'custom' }"
- v-model:sorting="sorting"
:sorting-options="{ getSortedRowModel: getSortedRowModel() }"
- v-model:pagination="pagination"
:pagination-options="{ getPaginationRowModel: getPaginationRowModel() }"
>
<template #name-cell="{ row }">
diff --git a/apps/app/server/api/chats.post.ts b/apps/app/server/api/chats.post.ts
index e42996a..233df56 100644
--- a/apps/app/server/api/chats.post.ts
+++ b/apps/app/server/api/chats.post.ts
@@ -1,8 +1,8 @@
import type { UIMessage } from 'ai'
import { db, schema } from '@nuxthub/db'
import { z } from 'zod'
-import type { CreateChatBody, CreateChatResponse } from '#shared/types/chat'
import { checkRateLimit, incrementRateLimit } from '../utils/rate-limit'
+import type { CreateChatBody, CreateChatResponse } from '#shared/types/chat'
const bodySchema = z.object({
id: z.string(),
diff --git a/apps/app/server/api/chats/[id].post.ts b/apps/app/server/api/chats/[id].post.ts
index cf0f451..69138a3 100644
--- a/apps/app/server/api/chats/[id].post.ts
+++ b/apps/app/server/api/chats/[id].post.ts
@@ -5,7 +5,7 @@ import { kv } from '@nuxthub/kv'
import { and, eq } from 'drizzle-orm'
import { createSavoir } from '@savoir/sdk'
import { useLogger } from 'evlog'
-import { createSourceAgent, createAdminAgent } from '@savoir/agent'
+import { createSourceAgent, createAdminAgent, setAIGatewayMetadata } from '@savoir/agent'
import { generateTitle } from '../../utils/chat/generate-title'
import { getAgentConfig } from '../../utils/agent-config'
import { KV_KEYS } from '../../utils/sandbox/types'
@@ -32,6 +32,7 @@ export default defineEventHandler(async (event) => {
try {
const { user } = await requireUserSession(event)
requestLog.set({ userId: user.id })
+ setAIGatewayMetadata({ userId: user.id, tags: ['web-chat'] })
const { id } = await getValidatedRouterParams(event, z.object({
id: z.string(),
diff --git a/apps/app/server/api/sources/ocr.post.ts b/apps/app/server/api/sources/ocr.post.ts
index 3e7ad18..2318ba5 100644
--- a/apps/app/server/api/sources/ocr.post.ts
+++ b/apps/app/server/api/sources/ocr.post.ts
@@ -1,5 +1,6 @@
import { generateText, Output } from 'ai'
import { z } from 'zod'
+import { setAIGatewayMetadata } from '@savoir/agent'
import type { SourceOcrItem } from '#shared/utils/source-ocr'
import { IMAGE_OPTIMIZATION_CONFIG } from '#shared/utils/file'
import { optimizeImage } from '~~/server/utils/image/optimize'
@@ -160,7 +161,8 @@ async function extractFromConfig(config: { filename: string, content: string })
}
export default defineEventHandler(async (event) => {
- await requireUserSession(event)
+ const { user } = await requireUserSession(event)
+ setAIGatewayMetadata({ userId: user.id, tags: ['web-chat'] })
const { images, configs } = await readValidatedBody(event, bodySchema.parse)
diff --git a/apps/app/server/utils/bot/ai.ts b/apps/app/server/utils/bot/ai.ts
index 3097bad..46e9956 100644
--- a/apps/app/server/utils/bot/ai.ts
+++ b/apps/app/server/utils/bot/ai.ts
@@ -6,7 +6,9 @@ import {
createAgent,
DEFAULT_MODEL,
getDefaultConfig,
- getModelFallbackOptions,
+ buildProviderOptions,
+ resolveGatewayMetadata,
+ setAIGatewayMetadata,
ROUTER_MODEL,
ROUTER_SYSTEM_PROMPT,
buildBotSystemPrompt,
@@ -47,7 +49,7 @@ async function routeQuestion(question: string, context?: ThreadContext): Promise
{ role: 'system', content: ROUTER_SYSTEM_PROMPT },
{ role: 'user', content: buildRouterInput(question, context) },
],
- providerOptions: getModelFallbackOptions(ROUTER_MODEL),
+ providerOptions: buildProviderOptions(ROUTER_MODEL, resolveGatewayMetadata()),
})
if (!output) {
@@ -67,8 +69,11 @@ async function routeQuestion(question: string, context?: ThreadContext): Promise
export async function generateAIResponse(
question: string,
context?: ThreadContext,
+ userId?: string,
): Promise<string> {
const startTime = Date.now()
+ const adapterTag = context?.platform ? `${context.platform}-adapter` : 'bot'
+ setAIGatewayMetadata({ userId, tags: [adapterTag] })
try {
const savoir = createInternalSavoir({
@@ -104,7 +109,7 @@ export async function generateAIResponse(
{ role: 'user', content: buildBotUserMessage(question, context) },
...result.response.messages,
],
- providerOptions: getModelFallbackOptions(DEFAULT_MODEL),
+ providerOptions: buildProviderOptions(DEFAULT_MODEL, resolveGatewayMetadata()),
})
if (fallback.text?.trim()) {
return fallback.text
diff --git a/apps/app/server/utils/bot/index.ts b/apps/app/server/utils/bot/index.ts
index 8fa3670..e4e7ffd 100644
--- a/apps/app/server/utils/bot/index.ts
+++ b/apps/app/server/utils/bot/index.ts
@@ -37,7 +37,7 @@ async function handleBotResponse(thread: Thread, message: Message) {
})
: { platform: adapter.name, title: '', body: '', labels: [], state: '', source: adapter.name }
- const response = await generateAIResponse(message.text, context)
+ const response = await generateAIResponse(message.text, context, message.author.userName)
await thread.post(response)
diff --git a/apps/app/server/utils/chat/generate-title.ts b/apps/app/server/utils/chat/generate-title.ts
index de40f6b..cc78077 100644
--- a/apps/app/server/utils/chat/generate-title.ts
+++ b/apps/app/server/utils/chat/generate-title.ts
@@ -3,7 +3,7 @@ import { generateText } from 'ai'
import { db, schema } from '@nuxthub/db'
import { eq } from 'drizzle-orm'
import { log } from 'evlog'
-import { ROUTER_MODEL, getModelFallbackOptions } from '@savoir/agent'
+import { ROUTER_MODEL, buildProviderOptions, resolveGatewayMetadata } from '@savoir/agent'
interface GenerateTitleOptions {
firstMessage: UIMessage
@@ -20,7 +20,7 @@ export async function generateTitle({ firstMessage, chatId, requestId }: Generat
Rules: no quotes, no colons, no punctuation, plain text only.
If the message is a simple greeting (hi, hey, hello, etc.), respond with a generic title like "New conversation" or "Quick chat".`,
prompt: JSON.stringify(firstMessage),
- providerOptions: getModelFallbackOptions(ROUTER_MODEL),
+ providerOptions: buildProviderOptions(ROUTER_MODEL, resolveGatewayMetadata()),
})
await db.update(schema.chats).set({ title }).where(eq(schema.chats.id, chatId))
diff --git a/packages/agent/src/agents/admin.ts b/packages/agent/src/agents/admin.ts
index f6adb1a..537612a 100644
--- a/packages/agent/src/agents/admin.ts
+++ b/packages/agent/src/agents/admin.ts
@@ -1,10 +1,10 @@
import { stepCountIs, ToolLoopAgent, type StepResult, type ToolSet } from 'ai'
-import { DEFAULT_MODEL, getModelFallbackOptions } from '../router/schema'
+import { DEFAULT_MODEL, buildProviderOptions } from '../router/schema'
import { ADMIN_SYSTEM_PROMPT } from '../prompts/chat'
import { compactContext } from '../core/context'
import { callOptionsSchema } from '../core/schemas'
import { sanitizeToolCallInputs } from '../core/sanitize'
-import { resolveModelWrapper } from '../core/observe'
+import { resolveModelWrapper, resolveGatewayMetadata } from '../core/observe'
import type { AgentCallOptions, AgentExecutionContext } from '../types'
export interface AdminAgentOptions {
@@ -48,7 +48,7 @@ export function createAdminAgent({
instructions: systemPrompt,
tools,
stopWhen: stepCountIs(maxSteps),
- providerOptions: getModelFallbackOptions(effectiveModel),
+ providerOptions: buildProviderOptions(effectiveModel, resolveGatewayMetadata()),
experimental_context: executionContext,
}
},
diff --git a/packages/agent/src/agents/base.ts b/packages/agent/src/agents/base.ts
index 943de73..c4fb1c9 100644
--- a/packages/agent/src/agents/base.ts
+++ b/packages/agent/src/agents/base.ts
@@ -1,12 +1,12 @@
import { stepCountIs, ToolLoopAgent, type StepResult, type ToolSet } from 'ai'
import { log } from 'evlog'
-import { DEFAULT_MODEL, getModelFallbackOptions } from '../router/schema'
+import { DEFAULT_MODEL, buildProviderOptions } from '../router/schema'
import { compactContext } from '../core/context'
import { callOptionsSchema } from '../core/schemas'
import { sanitizeToolCallInputs } from '../core/sanitize'
import { countConsecutiveToolSteps, shouldForceTextOnlyStep } from '../core/policy'
import { webSearchTool } from '../tools/web-search'
-import { resolveModelWrapper } from '../core/observe'
+import { resolveModelWrapper, resolveGatewayMetadata } from '../core/observe'
import type { AgentCallOptions, AgentExecutionContext, CreateAgentOptions } from '../types'
export function createAgent({
@@ -58,7 +58,7 @@ export function createAgent({
instructions: buildPrompt(routerConfig, agentConfig),
tools: { ...tools, web_search: webSearchTool },
stopWhen: stepCountIs(effectiveMaxSteps),
- providerOptions: getModelFallbackOptions(effectiveModel),
+ providerOptions: buildProviderOptions(effectiveModel, resolveGatewayMetadata()),
experimental_context: executionContext,
}
},
diff --git a/packages/agent/src/agents/source.ts b/packages/agent/src/agents/source.ts
index c57eab1..24d28e9 100644
--- a/packages/agent/src/agents/source.ts
+++ b/packages/agent/src/agents/source.ts
@@ -1,6 +1,6 @@
import { stepCountIs, ToolLoopAgent, type StepResult, type ToolSet, type UIMessage } from 'ai'
import { log } from 'evlog'
-import { DEFAULT_MODEL, getModelFallbackOptions } from '../router/schema'
+import { DEFAULT_MODEL, buildProviderOptions } from '../router/schema'
import { routeQuestion } from '../router/route-question'
import { buildChatSystemPrompt } from '../prompts/chat'
import { applyComplexity } from '../prompts/shared'
@@ -9,7 +9,7 @@ import { callOptionsSchema } from '../core/schemas'
import { sanitizeToolCallInputs } from '../core/sanitize'
import { countConsecutiveToolSteps, shouldForceTextOnlyStep } from '../core/policy'
import { webSearchTool } from '../tools/web-search'
-import { resolveModelWrapper } from '../core/observe'
+import { resolveModelWrapper, resolveGatewayMetadata } from '../core/observe'
import type { AgentConfigData, AgentCallOptions, AgentExecutionContext, RoutingResult } from '../types'
export interface SourceAgentOptions {
@@ -76,7 +76,7 @@ export function createSourceAgent({
instructions: applyComplexity(buildChatSystemPrompt(agentConfig), routerConfig),
tools: { ...tools, web_search: webSearchTool },
stopWhen: stepCountIs(effectiveMaxSteps),
- providerOptions: getModelFallbackOptions(effectiveModel),
+ providerOptions: buildProviderOptions(effectiveModel, resolveGatewayMetadata()),
experimental_context: executionContext,
}
},
diff --git a/packages/agent/src/core/observe.ts b/packages/agent/src/core/observe.ts
index 5dc867f..8c2ee9b 100644
--- a/packages/agent/src/core/observe.ts
+++ b/packages/agent/src/core/observe.ts
@@ -2,12 +2,36 @@ import { AsyncLocalStorage } from 'node:async_hooks'
type WrapFn = (model: string) => any
-const aiContext = new AsyncLocalStorage<WrapFn>()
+export interface GatewayMetadata {
+ userId?: string
+ tags?: string[]
+}
+
+interface AIContextStore {
+ wrap: WrapFn
+ userId?: string
+ tags?: string[]
+}
+
+const aiContext = new AsyncLocalStorage<AIContextStore>()
-export function enterAIContext(wrapFn: WrapFn): void {
- aiContext.enterWith(wrapFn)
+export function enterAIContext(wrapFn: WrapFn, metadata?: GatewayMetadata): void {
+ aiContext.enterWith({ wrap: wrapFn, userId: metadata?.userId, tags: metadata?.tags })
+}
+
+export function setAIGatewayMetadata(metadata: GatewayMetadata): void {
+ const ctx = aiContext.getStore()
+ if (ctx) {
+ if (metadata.userId !== undefined) ctx.userId = metadata.userId
+ if (metadata.tags !== undefined) ctx.tags = metadata.tags
+ }
}
export function resolveModelWrapper(): WrapFn {
- return aiContext.getStore() ?? ((model: string) => model)
+ return aiContext.getStore()?.wrap ?? ((model: string) => model)
+}
+
+export function resolveGatewayMetadata(): GatewayMetadata {
+ const ctx = aiContext.getStore()
+ return { userId: ctx?.userId, tags: ctx?.tags }
}
diff --git a/packages/agent/src/index.ts b/packages/agent/src/index.ts
index b343189..ce5a20d 100644
--- a/packages/agent/src/index.ts
+++ b/packages/agent/src/index.ts
@@ -1,5 +1,6 @@
// Observability
-export { enterAIContext } from './core/observe'
+export { enterAIContext, setAIGatewayMetadata, resolveGatewayMetadata } from './core/observe'
+export type { GatewayMetadata } from './core/observe'
// Tools
export { webSearchTool } from './tools/web-search'
@@ -17,6 +18,8 @@ export {
agentConfigSchema,
getDefaultConfig,
getModelFallbackOptions,
+ buildProviderOptions,
+ buildGatewayProviderOptions,
DEFAULT_MODEL,
ROUTER_MODEL,
} from './router/schema'
diff --git a/packages/agent/src/router/route-question.ts b/packages/agent/src/router/route-question.ts
index c4c938a..d465cb1 100644
--- a/packages/agent/src/router/route-question.ts
+++ b/packages/agent/src/router/route-question.ts
@@ -2,8 +2,8 @@ import { generateText, Output } from 'ai'
import type { UIMessage } from 'ai'
import { log } from 'evlog'
import { ROUTER_SYSTEM_PROMPT } from '../prompts/router'
-import { resolveModelWrapper } from '../core/observe'
-import { type AgentConfig, agentConfigSchema, getDefaultConfig, getModelFallbackOptions, ROUTER_MODEL } from './schema'
+import { resolveModelWrapper, resolveGatewayMetadata } from '../core/observe'
+import { type AgentConfig, agentConfigSchema, getDefaultConfig, buildProviderOptions, ROUTER_MODEL } from './schema'
function extractQuestionFromMessages(messages: UIMessage[]): string {
const lastUserMessage = [...messages].reverse().find(m => m.role === 'user')
@@ -39,7 +39,7 @@ export async function routeQuestion(
{ role: 'system', content: ROUTER_SYSTEM_PROMPT },
{ role: 'user', content: `Question: ${question}` },
],
- providerOptions: getModelFallbackOptions(ROUTER_MODEL),
+ providerOptions: buildProviderOptions(ROUTER_MODEL, resolveGatewayMetadata()),
})
if (!output) {
diff --git a/packages/agent/src/router/schema.ts b/packages/agent/src/router/schema.ts
index d5f559f..6d5d61a 100644
--- a/packages/agent/src/router/schema.ts
+++ b/packages/agent/src/router/schema.ts
@@ -44,3 +44,28 @@ export function getModelFallbackOptions(model: string): SharedV3ProviderOptions
if (!fallbacks?.length) return undefined
return { gateway: { models: fallbacks } }
}
+
+export function buildProviderOptions(
+ model: string,
+ metadata?: { userId?: string, tags?: string[] },
+): SharedV3ProviderOptions | undefined {
+ const fallbacks = MODEL_FALLBACKS[model]
+ const gateway: Record<string, unknown> = {}
+
+ if (fallbacks?.length) gateway.models = fallbacks
+ if (metadata?.userId) gateway.user = metadata.userId
+ if (metadata?.tags?.length) gateway.tags = metadata.tags
+
+ return Object.keys(gateway).length > 0 ? { gateway } : undefined
+}
+
+export function buildGatewayProviderOptions(
+ metadata?: { userId?: string, tags?: string[] },
+): SharedV3ProviderOptions | undefined {
+ const gateway: Record<string, unknown> = {}
+
+ if (metadata?.userId) gateway.user = metadata.userId
+ if (metadata?.tags?.length) gateway.tags = metadata.tags
+
+ return Object.keys(gateway).length > 0 ? { gateway } : undefined
+}
diff --git a/packages/agent/src/tools/web-search.perplexity.ts b/packages/agent/src/tools/web-search.perplexity.ts
index 8be5b17..5af2bf7 100644
--- a/packages/agent/src/tools/web-search.perplexity.ts
+++ b/packages/agent/src/tools/web-search.perplexity.ts
@@ -1,6 +1,8 @@
import { generateText, tool } from 'ai'
import { createGateway } from '@ai-sdk/gateway'
import { z } from 'zod'
+import { resolveGatewayMetadata } from '../core/observe'
+import { buildGatewayProviderOptions } from '../router/schema'
const gateway = createGateway()
@@ -18,6 +20,7 @@ export const webSearchTool = tool({
model: gateway('perplexity/sonar'),
prompt: query,
abortSignal,
+ providerOptions: buildGatewayProviderOptions(resolveGatewayMetadata()),
})
const urlSources = sources
diff --git a/packages/agent/src/tools/web-search.ts b/packages/agent/src/tools/web-search.ts
index 0a198dd..ca83325 100644
--- a/packages/agent/src/tools/web-search.ts
+++ b/packages/agent/src/tools/web-search.ts
@@ -2,6 +2,8 @@ import { generateText, tool } from 'ai'
import { createGateway } from '@ai-sdk/gateway'
import { openai } from '@ai-sdk/openai'
import { z } from 'zod'
+import { resolveGatewayMetadata } from '../core/observe'
+import { buildGatewayProviderOptions } from '../router/schema'
const gateway = createGateway()
@@ -21,6 +23,7 @@ export const webSearchTool = tool({
toolChoice: { type: 'tool', toolName: 'web_search' },
prompt: query,
abortSignal,
+ providerOptions: buildGatewayProviderOptions(resolveGatewayMetadata()),
})
const urlSources = sources