Documentation

JSON Agent

The JSON Agent is a specialized component designed to process, validate, and transform JSON data with advanced parsing capabilities and error handling.

JSON Agent Component

JSON Agent interface and configuration options

Configuration Parameters

Required Parameters

  • Input: JSON data or file path
  • Language Model: The language model to use
  • File Path: Path to JSON file (if applicable)

Optional Parameters

  • Handle Parse Errors: Error handling configuration
  • Verbose: Detailed logging option
  • Max Iterations: Maximum processing iterations
  • Agent Description: Custom agent description

Output Format

{
  "processId": string,
  "status": "success" | "error",
  "results": {
    "data": object | array,
    "validation": {
      "isValid": boolean,
      "errors": array
    },
    "metadata": {
      "schema": object,
      "size": number,
      "timestamp": string
    }
  },
  "processing": {
    "iterations": number,
    "duration": string,
    "operations": array
  }
}

Example Usage

const jsonAgent = new JSONAgent({
  languageModel: "gpt-4",
  input: {
    type: "file",
    path: "./data/config.json"
  },
  handleParseErrors: true,
  verbose: true,
  maxIterations: 15,
  agentDescription: "JSON configuration validator and transformer"
});

const result = await jsonAgent.process({
  operations: [
    {
      type: "validate",
      schema: "./schemas/config.schema.json"
    },
    {
      type: "transform",
      mapping: "./mappings/config.map.json"
    }
  ]
});

Best Practices

  • Always validate JSON against a schema
  • Handle large JSON files in streams
  • Implement proper error recovery
  • Use appropriate data transformations
  • Monitor processing performance