|
|
|
|
|
<span data-heading-keywords="output parser"></span> |
|
|
|
:::note |
|
|
|
The information here refers to parsers that take a text output from a model try to parse it into a more structured representation. |
|
More and more models are supporting function (or tool) calling, which handles this automatically. |
|
It is recommended to use function/tool calling rather than output parsing. |
|
See documentation for that [here](/docs/concepts/tool_calling). |
|
|
|
::: |
|
|
|
`Output parser` is responsible for taking the output of a model and transforming it to a more suitable format for downstream tasks. |
|
Useful when you are using LLMs to generate structured data, or to normalize output from chat models and LLMs. |
|
|
|
LangChain has lots of different types of output parsers. This is a list of output parsers LangChain supports. The table below has various pieces of information: |
|
|
|
- **Name**: The name of the output parser |
|
- **Supports Streaming**: Whether the output parser supports streaming. |
|
- **Has Format Instructions**: Whether the output parser has format instructions. This is generally available except when (a) the desired schema is not specified in the prompt but rather in other parameters (like OpenAI function calling), or (b) when the OutputParser wraps another OutputParser. |
|
- **Calls LLM**: Whether this output parser itself calls an LLM. This is usually only done by output parsers that attempt to correct misformatted output. |
|
- **Input Type**: Expected input type. Most output parsers work on both strings and messages, but some (like OpenAI Functions) need a message with specific kwargs. |
|
- **Output Type**: The output type of the object returned by the parser. |
|
- **Description**: Our commentary on this output parser and when to use it. |
|
|
|
| Name | Supports Streaming | Has Format Instructions | Calls LLM | Input Type | Output Type | Description | |
|
| |
|
| [Str](https://python.langchain.com/api_reference/core/output_parsers/langchain_core.output_parsers.string.StrOutputParser.html) | β
| | | `str` \| `Message` | String | Parses texts from message objects. Useful for handling variable formats of message content (e.g., extracting text from content blocks). | |
|
| [JSON](https://python.langchain.com/api_reference/core/output_parsers/langchain_core.output_parsers.json.JsonOutputParser.html) | β
| β
| | `str` \| `Message` | JSON object | Returns a JSON object as specified. You can specify a Pydantic model and it will return JSON for that model. Probably the most reliable output parser for getting structured data that does NOT use function calling. | |
|
| [XML](https://python.langchain.com/api_reference/core/output_parsers/langchain_core.output_parsers.xml.XMLOutputParser.html |
|
| [CSV](https://python.langchain.com/api_reference/core/output_parsers/langchain_core.output_parsers.list.CommaSeparatedListOutputParser.html |
|
| [OutputFixing](https://python.langchain.com/api_reference/langchain/output_parsers/langchain.output_parsers.fix.OutputFixingParser.html |
|
| [RetryWithError](https://python.langchain.com/api_reference/langchain/output_parsers/langchain.output_parsers.retry.RetryWithErrorOutputParser.html |
|
| [Pydantic](https://python.langchain.com/api_reference/core/output_parsers/langchain_core.output_parsers.pydantic.PydanticOutputParser.html |
|
| [YAML](https://python.langchain.com/api_reference/langchain/output_parsers/langchain.output_parsers.yaml.YamlOutputParser.html |
|
| [PandasDataFrame](https://python.langchain.com/api_reference/langchain/output_parsers/langchain.output_parsers.pandas_dataframe.PandasDataFrameOutputParser.html |
|
| [Enum](https://python.langchain.com/api_reference/langchain/output_parsers/langchain.output_parsers.enum.EnumOutputParser.html |
|
| [Datetime](https://python.langchain.com/api_reference/langchain/output_parsers/langchain.output_parsers.datetime.DatetimeOutputParser.html |
|
| [Structured](https://python.langchain.com/api_reference/langchain/output_parsers/langchain.output_parsers.structured.StructuredOutputParser.html |
|
|
|
For specifics on how to use output parsers, see the [relevant how-to guides here](/docs/how_to/#output-parsers). |
|
|