mirror of
https://github.com/AutoMaker-Org/automaker.git
synced 2026-01-30 06:12:03 +00:00
- Introduced a new Simple Query Service to streamline basic AI queries, allowing for structured JSON outputs. - Updated existing routes to utilize the new service, replacing direct SDK calls with a unified interface for querying. - Enhanced provider handling in various routes, including generate-spec, generate-features-from-spec, and validate-issue, to support both Claude and Cursor models seamlessly. - Added structured output support for improved response handling and error management across the application.
241 lines
7.9 KiB
TypeScript
241 lines
7.9 KiB
TypeScript
/**
|
|
* Simple Query Service - Simplified interface for basic AI queries
|
|
*
|
|
* Use this for routes that need simple text responses without
|
|
* complex event handling. This service abstracts away the provider
|
|
* selection and streaming details, providing a clean interface
|
|
* for common query patterns.
|
|
*
|
|
* Benefits:
|
|
* - No direct SDK imports needed in route files
|
|
* - Consistent provider routing based on model
|
|
* - Automatic text extraction from streaming responses
|
|
* - Structured output support for JSON schema responses
|
|
* - Eliminates duplicate extractTextFromStream() functions
|
|
*/
|
|
|
|
import { ProviderFactory } from './provider-factory.js';
|
|
import type { ProviderMessage, ContentBlock, ThinkingLevel } from '@automaker/types';
|
|
|
|
/**
|
|
* Options for simple query execution
|
|
*/
|
|
export interface SimpleQueryOptions {
|
|
/** The prompt to send to the AI (can be text or multi-part content) */
|
|
prompt: string | Array<{ type: string; text?: string; source?: object }>;
|
|
/** Model to use (with or without provider prefix) */
|
|
model?: string;
|
|
/** Working directory for the query */
|
|
cwd: string;
|
|
/** System prompt (combined with user prompt for some providers) */
|
|
systemPrompt?: string;
|
|
/** Maximum turns for agentic operations (default: 1) */
|
|
maxTurns?: number;
|
|
/** Tools to allow (default: [] for simple queries) */
|
|
allowedTools?: string[];
|
|
/** Abort controller for cancellation */
|
|
abortController?: AbortController;
|
|
/** Structured output format for JSON responses */
|
|
outputFormat?: {
|
|
type: 'json_schema';
|
|
schema: Record<string, unknown>;
|
|
};
|
|
/** Thinking level for Claude models */
|
|
thinkingLevel?: ThinkingLevel;
|
|
/** If true, runs in read-only mode (no file writes) */
|
|
readOnly?: boolean;
|
|
/** Setting sources for CLAUDE.md loading */
|
|
settingSources?: Array<'user' | 'project' | 'local'>;
|
|
}
|
|
|
|
/**
|
|
* Result from a simple query
|
|
*/
|
|
export interface SimpleQueryResult {
|
|
/** The accumulated text response */
|
|
text: string;
|
|
/** Structured output if outputFormat was specified and provider supports it */
|
|
structured_output?: Record<string, unknown>;
|
|
}
|
|
|
|
/**
|
|
* Options for streaming query execution
|
|
*/
|
|
export interface StreamingQueryOptions extends SimpleQueryOptions {
|
|
/** Callback for each text chunk received */
|
|
onText?: (text: string) => void;
|
|
/** Callback for tool use events */
|
|
onToolUse?: (tool: string, input: unknown) => void;
|
|
/** Callback for thinking blocks (if available) */
|
|
onThinking?: (thinking: string) => void;
|
|
}
|
|
|
|
/**
|
|
* Default model to use when none specified
|
|
*/
|
|
const DEFAULT_MODEL = 'claude-sonnet-4-20250514';
|
|
|
|
/**
|
|
* Execute a simple query and return the text result
|
|
*
|
|
* Use this for simple, non-streaming queries where you just need
|
|
* the final text response. For more complex use cases with progress
|
|
* callbacks, use streamingQuery() instead.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* const result = await simpleQuery({
|
|
* prompt: 'Generate a title for: user authentication',
|
|
* cwd: process.cwd(),
|
|
* systemPrompt: 'You are a title generator...',
|
|
* maxTurns: 1,
|
|
* allowedTools: [],
|
|
* });
|
|
* console.log(result.text); // "Add user authentication"
|
|
* ```
|
|
*/
|
|
export async function simpleQuery(options: SimpleQueryOptions): Promise<SimpleQueryResult> {
|
|
const model = options.model || DEFAULT_MODEL;
|
|
const provider = ProviderFactory.getProviderForModel(model);
|
|
|
|
let responseText = '';
|
|
let structuredOutput: Record<string, unknown> | undefined;
|
|
|
|
// Build provider options
|
|
const providerOptions = {
|
|
prompt: options.prompt,
|
|
model: model,
|
|
cwd: options.cwd,
|
|
systemPrompt: options.systemPrompt,
|
|
maxTurns: options.maxTurns ?? 1,
|
|
allowedTools: options.allowedTools ?? [],
|
|
abortController: options.abortController,
|
|
outputFormat: options.outputFormat,
|
|
thinkingLevel: options.thinkingLevel,
|
|
readOnly: options.readOnly,
|
|
settingSources: options.settingSources,
|
|
};
|
|
|
|
for await (const msg of provider.executeQuery(providerOptions)) {
|
|
// Handle error messages
|
|
if (msg.type === 'error') {
|
|
const errorMessage = msg.error || 'Provider returned an error';
|
|
throw new Error(errorMessage);
|
|
}
|
|
|
|
// Extract text from assistant messages
|
|
if (msg.type === 'assistant' && msg.message?.content) {
|
|
for (const block of msg.message.content) {
|
|
if (block.type === 'text' && block.text) {
|
|
responseText += block.text;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Handle result messages
|
|
if (msg.type === 'result') {
|
|
if (msg.subtype === 'success') {
|
|
// Use result text if longer than accumulated text
|
|
if (msg.result && msg.result.length > responseText.length) {
|
|
responseText = msg.result;
|
|
}
|
|
// Capture structured output if present
|
|
if (msg.structured_output) {
|
|
structuredOutput = msg.structured_output;
|
|
}
|
|
} else if (msg.subtype === 'error_max_turns') {
|
|
// Max turns reached - return what we have
|
|
break;
|
|
} else if (msg.subtype === 'error_max_structured_output_retries') {
|
|
throw new Error('Could not produce valid structured output after retries');
|
|
}
|
|
}
|
|
}
|
|
|
|
return { text: responseText, structured_output: structuredOutput };
|
|
}
|
|
|
|
/**
|
|
* Execute a streaming query with event callbacks
|
|
*
|
|
* Use this for queries where you need real-time progress updates,
|
|
* such as when displaying streaming output to a user.
|
|
*
|
|
* @example
|
|
* ```typescript
|
|
* const result = await streamingQuery({
|
|
* prompt: 'Analyze this project and suggest improvements',
|
|
* cwd: '/path/to/project',
|
|
* maxTurns: 250,
|
|
* allowedTools: ['Read', 'Glob', 'Grep'],
|
|
* onText: (text) => emitProgress(text),
|
|
* onToolUse: (tool, input) => emitToolUse(tool, input),
|
|
* });
|
|
* ```
|
|
*/
|
|
export async function streamingQuery(options: StreamingQueryOptions): Promise<SimpleQueryResult> {
|
|
const model = options.model || DEFAULT_MODEL;
|
|
const provider = ProviderFactory.getProviderForModel(model);
|
|
|
|
let responseText = '';
|
|
let structuredOutput: Record<string, unknown> | undefined;
|
|
|
|
// Build provider options
|
|
const providerOptions = {
|
|
prompt: options.prompt,
|
|
model: model,
|
|
cwd: options.cwd,
|
|
systemPrompt: options.systemPrompt,
|
|
maxTurns: options.maxTurns ?? 250,
|
|
allowedTools: options.allowedTools ?? ['Read', 'Glob', 'Grep'],
|
|
abortController: options.abortController,
|
|
outputFormat: options.outputFormat,
|
|
thinkingLevel: options.thinkingLevel,
|
|
readOnly: options.readOnly,
|
|
settingSources: options.settingSources,
|
|
};
|
|
|
|
for await (const msg of provider.executeQuery(providerOptions)) {
|
|
// Handle error messages
|
|
if (msg.type === 'error') {
|
|
const errorMessage = msg.error || 'Provider returned an error';
|
|
throw new Error(errorMessage);
|
|
}
|
|
|
|
// Extract content from assistant messages
|
|
if (msg.type === 'assistant' && msg.message?.content) {
|
|
for (const block of msg.message.content) {
|
|
if (block.type === 'text' && block.text) {
|
|
responseText += block.text;
|
|
options.onText?.(block.text);
|
|
} else if (block.type === 'tool_use' && block.name) {
|
|
options.onToolUse?.(block.name, block.input);
|
|
} else if (block.type === 'thinking' && block.thinking) {
|
|
options.onThinking?.(block.thinking);
|
|
}
|
|
}
|
|
}
|
|
|
|
// Handle result messages
|
|
if (msg.type === 'result') {
|
|
if (msg.subtype === 'success') {
|
|
// Use result text if longer than accumulated text
|
|
if (msg.result && msg.result.length > responseText.length) {
|
|
responseText = msg.result;
|
|
}
|
|
// Capture structured output if present
|
|
if (msg.structured_output) {
|
|
structuredOutput = msg.structured_output;
|
|
}
|
|
} else if (msg.subtype === 'error_max_turns') {
|
|
// Max turns reached - return what we have
|
|
break;
|
|
} else if (msg.subtype === 'error_max_structured_output_retries') {
|
|
throw new Error('Could not produce valid structured output after retries');
|
|
}
|
|
}
|
|
}
|
|
|
|
return { text: responseText, structured_output: structuredOutput };
|
|
}
|