Class: RegexParser

output_parsers.RegexParser

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

Hierarchy

• BaseOutputParser

  ↳ RegexParser

Constructors

constructor

• new RegexParser(regex, outputKeys, defaultOutputKey?)

Parameters

Name	Type
regex	string | RegExp
outputKeys	string[]
defaultOutputKey?	string

Overrides

BaseOutputParser.constructor

Defined in

langchain/src/output_parsers/regex.ts:14

Properties

defaultOutputKey

• Optional defaultOutputKey: string

Defined in

langchain/src/output_parsers/regex.ts:12

---

outputKeys

• outputKeys: string[]

Defined in

langchain/src/output_parsers/regex.ts:10

---

regex

• regex: string | RegExp

Defined in

langchain/src/output_parsers/regex.ts:8

Methods

_type

▸ _type(): string

Return the string type key uniquely identifying this class of parser

Returns

string

Overrides

BaseOutputParser._type

Defined in

langchain/src/output_parsers/regex.ts:25

---

getFormatInstructions

▸ getFormatInstructions(): string

Return a string describing the format of the output.

Example

{
 "foo": "bar"
}

Returns

string

Format instructions.

Overrides

BaseOutputParser.getFormatInstructions

Defined in

langchain/src/output_parsers/regex.ts:48

---

parse

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

Parse the output of an LLM call.

Parameters

Name	Type	Description
text	string	LLM output to parse.

Returns

Promise<Record<string, string>>

Parsed output.

Overrides

BaseOutputParser.parse

Defined in

langchain/src/output_parsers/regex.ts:29

---

parseWithPrompt

▸ parseWithPrompt(text, _prompt): Promise<unknown>

Parameters

Name	Type
text	string
_prompt	BasePromptValue

Returns

Promise<unknown>

Inherited from

BaseOutputParser.parseWithPrompt

Defined in

langchain/src/schema/index.ts:147