Files
supabase/apps/studio/evals/assistant.eval.ts
Matt Rossman eb259f1364 feat(assistant): score and improve SQL identifier quoting (#42122)
* feat: SQL correctness scorer, override mock tables

* feat: replace "SQL Correctness" with "SQL Identifier Quoting" scorer

* fix(prompt): discourage simulating confirmation of execute_sql tool

this is already handled at the UI layer

* fix(prompt): encourage quotes on identifiers with caps

* feat: move extractIdentifiers to own file, add tests

* chore: shorten tests

* feat: extract ColumnDef column names in extractIdentifiers

* refactor: sqlIdentifierQuotingScorer with more thorough checks

* refactor: consolidate into `sql-identifier-quoting.ts`

* feat: support mocking schemas, eval test case with case sensitive schema

* fix: test cases that don't match default mock schema

* chore: format

* feat(prompt): mention special characters and reserved words

* feat: optional description in metadata, test with special characters

* feat: consolidated comprehensive test case

* fix(prompt): revert conflicting instruction
2026-01-27 09:28:56 -05:00

130 lines
3.2 KiB
TypeScript

import { openai } from '@ai-sdk/openai'
import { Eval } from 'braintrust'
import { generateAssistantResponse } from 'lib/ai/generate-assistant-response'
import { getMockTools } from 'lib/ai/tools/mock-tools'
import assert from 'node:assert'
import { dataset } from './dataset'
import {
completenessScorer,
concisenessScorer,
correctnessScorer,
docsFaithfulnessScorer,
goalCompletionScorer,
sqlIdentifierQuotingScorer,
sqlSyntaxScorer,
toolUsageScorer,
} from './scorer'
import { ToolSet, TypedToolCall, TypedToolResult } from 'ai'
assert(process.env.BRAINTRUST_PROJECT_ID, 'BRAINTRUST_PROJECT_ID is not set')
assert(process.env.OPENAI_API_KEY, 'OPENAI_API_KEY is not set')
Eval('Assistant', {
projectId: process.env.BRAINTRUST_PROJECT_ID,
data: () => dataset,
task: async (input) => {
const result = await generateAssistantResponse({
model: openai('gpt-5-mini'),
messages: [{ id: '1', role: 'user', parts: [{ type: 'text', text: input.prompt }] }],
tools: await getMockTools(input.mockTables ? { list_tables: input.mockTables } : undefined),
})
const finishReason = await result.finishReason
// `result.toolCalls` only shows the last step, instead aggregate tools across all steps
const steps = await result.steps
const simplifiedSteps = steps.map((step) => ({
text: step.text,
toolCalls: step.toolCalls.map((call) => ({
toolName: call.toolName,
input: call.input,
})),
}))
const toolNames: string[] = []
const sqlQueries: string[] = []
const docs: string[] = []
for (const step of steps) {
for (const [i, toolCall] of step.toolCalls.entries()) {
toolNames.push(toolCall.toolName)
const toolResult = step.toolResults.at(i)
if (!toolResult) {
continue
}
const parsed = parseToolCall(toolCall, toolResult)
if (parsed.sqlQuery) {
sqlQueries.push(parsed.sqlQuery)
}
if (parsed.docs) {
docs.push(...parsed.docs)
}
}
}
return {
finishReason,
steps: simplifiedSteps,
toolNames,
sqlQueries,
docs,
}
},
scores: [
toolUsageScorer,
sqlSyntaxScorer,
sqlIdentifierQuotingScorer,
goalCompletionScorer,
concisenessScorer,
completenessScorer,
docsFaithfulnessScorer,
correctnessScorer,
],
})
type ParsedToolCall = {
/** Query generated by `execute_sql` */
sqlQuery?: string
/** Docs text pulled in from `search_docs` */
docs?: string[]
}
/**
* Validate and extract relevant info from a tool call/result
*/
function parseToolCall(
toolCall: TypedToolCall<ToolSet>,
toolResult: TypedToolResult<ToolSet>
): ParsedToolCall {
switch (toolCall.toolName) {
case 'execute_sql': {
const sqlQuery = toolCall.input.sql
if (typeof sqlQuery !== 'string') {
return {}
}
return { sqlQuery }
}
case 'search_docs': {
const content = toolResult.output.content
if (!content || !Array.isArray(content)) {
return {}
}
const docs = content.map((item) => item?.text).filter((text) => typeof text === 'string')
if (docs.length === 0) {
return {}
}
return { docs }
}
}
return {}
}