Class RegexParser

constructor

• new RegexParser(fields): RegexParser

• Parameters

  • fields: RegexParserFields

  Returns RegexParser

• new RegexParser(regex, outputKeys, defaultOutputKey?): RegexParser

• Parameters

  • regex: string | RegExp

  • outputKeys: string[]

  • Optional defaultOutputKey: string

  Returns RegexParser

outputKeys

regex

Optional defaultOutputKey

getFormatInstructions

• getFormatInstructions(): string

• Returns a string with instructions on how the LLM output should be formatted to match the regex pattern.

  Returns string

  A string with formatting instructions.

parse

• parse(text): Promise<Record<string, string>>

• Parses the given text using the regex pattern and returns a dictionary with the parsed output. If the regex pattern does not match the text and no defaultOutputKey is provided, throws an OutputParserException.

  Parameters

  • text: string

    The text to be parsed.

  Returns Promise<Record<string, string>>

  A dictionary with the parsed output.