/* eslint-disable n8n-nodes-base/node-dirname-against-convention */ import { jsonParse, type IExecuteFunctions, type INodeType, type INodeTypeDescription, type SupplyData, NodeOperationError, NodeConnectionType, } from 'n8n-workflow'; import { z } from 'zod'; import type { JSONSchema7 } from 'json-schema'; import { StructuredOutputParser } from 'langchain/output_parsers'; import { OutputParserException } from '@langchain/core/output_parsers'; import get from 'lodash/get'; import type { JavaScriptSandbox } from 'n8n-nodes-base/dist/nodes/Code/JavaScriptSandbox'; import { getConnectionHintNoticeField } from '../../../utils/sharedFields'; import { logWrapper } from '../../../utils/logWrapper'; import { generateSchema, getSandboxWithZod } from '../../../utils/schemaParsing'; import { inputSchemaField, jsonSchemaExampleField, schemaTypeField, } from '../../../utils/descriptions'; const STRUCTURED_OUTPUT_KEY = '__structured__output'; const STRUCTURED_OUTPUT_OBJECT_KEY = '__structured__output__object'; const STRUCTURED_OUTPUT_ARRAY_KEY = '__structured__output__array'; export class N8nStructuredOutputParser extends StructuredOutputParser { async parse(text: string): Promise> { try { const parsed = (await super.parse(text)) as object; return ( get(parsed, [STRUCTURED_OUTPUT_KEY, STRUCTURED_OUTPUT_OBJECT_KEY]) ?? get(parsed, [STRUCTURED_OUTPUT_KEY, STRUCTURED_OUTPUT_ARRAY_KEY]) ?? get(parsed, STRUCTURED_OUTPUT_KEY) ?? parsed ); } catch (e) { // eslint-disable-next-line n8n-nodes-base/node-execute-block-wrong-error-thrown throw new OutputParserException(`Failed to parse. Text: "${text}". Error: ${e}`, text); } } static async fromZedJsonSchema( sandboxedSchema: JavaScriptSandbox, nodeVersion: number, ): Promise>> { const zodSchema = (await sandboxedSchema.runCode()) as z.ZodSchema; let returnSchema: z.ZodSchema; if (nodeVersion === 1) { returnSchema = z.object({ [STRUCTURED_OUTPUT_KEY]: z .object({ [STRUCTURED_OUTPUT_OBJECT_KEY]: zodSchema.optional(), [STRUCTURED_OUTPUT_ARRAY_KEY]: z.array(zodSchema).optional(), }) .describe( `Wrapper around the output data. It can only contain ${STRUCTURED_OUTPUT_OBJECT_KEY} or ${STRUCTURED_OUTPUT_ARRAY_KEY} but never both.`, ) .refine( (data) => { // Validate that one and only one of the properties exists return ( Boolean(data[STRUCTURED_OUTPUT_OBJECT_KEY]) !== Boolean(data[STRUCTURED_OUTPUT_ARRAY_KEY]) ); }, { message: 'One and only one of __structured__output__object and __structured__output__array should be present.', path: [STRUCTURED_OUTPUT_KEY], }, ), }); } else { returnSchema = z.object({ output: zodSchema.optional(), }); } return N8nStructuredOutputParser.fromZodSchema(returnSchema); } } export class OutputParserStructured implements INodeType { description: INodeTypeDescription = { displayName: 'Structured Output Parser', name: 'outputParserStructured', icon: 'fa:code', group: ['transform'], version: [1, 1.1, 1.2], defaultVersion: 1.2, description: 'Return data in a defined JSON format', defaults: { name: 'Structured Output Parser', }, codex: { alias: ['json', 'zod'], categories: ['AI'], subcategories: { AI: ['Output Parsers'], }, resources: { primaryDocumentation: [ { url: 'https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.outputparserstructured/', }, ], }, }, // eslint-disable-next-line n8n-nodes-base/node-class-description-inputs-wrong-regular-node inputs: [], // eslint-disable-next-line n8n-nodes-base/node-class-description-outputs-wrong outputs: [NodeConnectionType.AiOutputParser], outputNames: ['Output Parser'], properties: [ getConnectionHintNoticeField([NodeConnectionType.AiChain, NodeConnectionType.AiAgent]), { ...schemaTypeField, displayOptions: { show: { '@version': [{ _cnd: { gte: 1.2 } }] } } }, { ...jsonSchemaExampleField, default: `{ "state": "California", "cities": ["Los Angeles", "San Francisco", "San Diego"] }`, }, { ...inputSchemaField, default: `{ "type": "object", "properties": { "state": { "type": "string" }, "cities": { "type": "array", "items": { "type": "string" } } } }`, }, { displayName: 'JSON Schema', name: 'jsonSchema', type: 'json', description: 'JSON Schema to structure and validate the output against', default: `{ "type": "object", "properties": { "state": { "type": "string" }, "cities": { "type": "array", "items": { "type": "string" } } } }`, typeOptions: { rows: 10, }, required: true, displayOptions: { show: { '@version': [{ _cnd: { lte: 1.1 } }], }, }, }, { displayName: 'The schema has to be defined in the JSON Schema format. Look at this page for examples.', name: 'notice', type: 'notice', default: '', displayOptions: { hide: { schemaType: ['fromJson'], }, }, }, ], }; async supplyData(this: IExecuteFunctions, itemIndex: number): Promise { const schemaType = this.getNodeParameter('schemaType', itemIndex, '') as 'fromJson' | 'manual'; // We initialize these even though one of them will always be empty // it makes it easer to navigate the ternary operator const jsonExample = this.getNodeParameter('jsonSchemaExample', itemIndex, '') as string; let inputSchema: string; if (this.getNode().typeVersion <= 1.1) { inputSchema = this.getNodeParameter('jsonSchema', itemIndex, '') as string; } else { inputSchema = this.getNodeParameter('inputSchema', itemIndex, '') as string; } const jsonSchema = schemaType === 'fromJson' ? generateSchema(jsonExample) : jsonParse(inputSchema); const zodSchemaSandbox = getSandboxWithZod(this, jsonSchema, 0); const nodeVersion = this.getNode().typeVersion; try { const parser = await N8nStructuredOutputParser.fromZedJsonSchema( zodSchemaSandbox, nodeVersion, ); return { response: logWrapper(parser, this), }; } catch (error) { throw new NodeOperationError(this.getNode(), 'Error during parsing of JSON Schema.'); } } }