Documentation

SQL Agent

The SQL Agent is a specialized component that processes natural language queries and converts them into optimized SQL statements with advanced error handling and web search capabilities.

SQL Agent Component

SQL Agent interface and configuration options

Configuration Parameters

Required Parameters

  • Tool: SQL processing capabilities
  • Handle Parse Errors: Error handling
  • Web Search: Web search capability
  • Agent Description: Agent behavior
  • Language Model: The AI model
  • System Prompt: Base prompt

Output Format

{
  "response": {
    "query": string,
    "explanation": string,
    "optimization_notes": string,
    "metadata": {
      "executionTime": string,
      "rowsAffected": number
    }
  }
}

Example Usage

const sqlAgent = new SQLAgent({
  tool: "sql-processor",
  handleParseErrors: true,
  webSearch: {
    enabled: true,
    maxResults: 5
  },
  agentDescription: "SQL query generator and optimizer",
  languageModel: "gpt-4",
  systemPrompt: "Generate optimized SQL queries for the following requests..."
});

const result = await sqlAgent.process({
  input: "Find total sales by product category for last month"
});

Best Practices

  • Validate generated queries
  • Implement query optimization
  • Use appropriate indexes
  • Monitor query performance
  • Handle errors gracefully