Class RegexParser

Class to parse the output of an LLM call into a dictionary.

Hierarchy

BaseOutputParser<Record<string, string>>
- RegexParser

Index

Constructors

Properties

outputKeys regex defaultOutputKey?

Methods

getFormatInstructions parse

Constructors

constructor

new RegexParser(fields): RegexParser
Parameters
- fields: RegexParserFields
Returns RegexParser
Overrides BaseOutputParser<Record<string, string>>.constructor
- Defined in docs/api_refs/langchain/src/output_parsers/regex.ts:50
new RegexParser(regex, outputKeys, defaultOutputKey?): RegexParser
Parameters
- regex: string | RegExp
- outputKeys: string[]
- Optional defaultOutputKey: string
Returns RegexParser
Overrides BaseOutputParser<Record<string, string>>.constructor
- Defined in docs/api_refs/langchain/src/output_parsers/regex.ts:52

Properties

outputKeys

outputKeys: string[]

regex

regex: string | RegExp

`Optional` defaultOutputKey

defaultOutputKey?: string

Methods

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.
Overrides BaseOutputParser.getFormatInstructions
- Defined in docs/api_refs/langchain/src/output_parsers/regex.ts:124

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.
Overrides BaseOutputParser.parse
- Defined in docs/api_refs/langchain/src/output_parsers/regex.ts:100

Generated using TypeDoc