Class JsonOutputFunctionsParser<Output>

Class for parsing the output of an LLM into a JSON object. Uses an instance of OutputFunctionsParser to parse the output.

Type Parameters

Output extends object = object

Hierarchy (view full)

Toolkit<Output>
- JsonOutputFunctionsParser

Index

Constructors

Properties

argsOnly outputParser

Methods

getFormatInstructions parse parsePartialResult parseResult

Constructors

constructor

new JsonOutputFunctionsParser<Output>(config?): JsonOutputFunctionsParser<Output>
Type Parameters
- Output extends object = object
Parameters
- Optional config: any
Returns JsonOutputFunctionsParser<Output>
Overrides BaseCumulativeTransformOutputParser<Output>.constructor
- Defined in langchain/src/output_parsers/openai_functions.ts:97

Properties

argsOnly

argsOnly: boolean = true

outputParser

outputParser: OutputFunctionsParser

Methods

getFormatInstructions

getFormatInstructions(): string
Returns string
- Defined in langchain/src/output_parsers/openai_functions.ts:165

parse

parse(text): Promise<Output>
Parameters
- text: string
Returns Promise<Output>
- Defined in langchain/src/output_parsers/openai_functions.ts:156

parsePartialResult

parsePartialResult(generations): Promise<undefined | Output>
Parameters
- generations: ChatGeneration[]
Returns Promise<undefined | Output>
- Defined in langchain/src/output_parsers/openai_functions.ts:116

parseResult

parseResult(generations): Promise<Output>
Parses the output and returns a JSON object. If argsOnly is true, only the arguments of the function call are returned.
Parameters
- generations: Generation[] | ChatGeneration[]
  The output of the LLM to parse.
Returns Promise<Output>
A JSON object representation of the function call or its arguments.
- Defined in langchain/src/output_parsers/openai_functions.ts:144

Generated using TypeDoc