Skip to content

Commit 40bd71c

Browse files
authored
doc:Updating doc with consistent bullet format. (#31527)
Description: Added line-break for each of the step mentioned, also made bullet points consistent with other docs. Dependencies: N/A Twitter handle: [mrityu___](https://x.com/mrityu___) Before Changes: ![image](https://github.com/user-attachments/assets/867b0c05-7ebd-418b-bfe4-e1cb6134baf2) After Changes: ![image](https://github.com/user-attachments/assets/3ff5db49-a713-4bb0-b814-dc02b9dc6bb4) The styling(non-bold of bullet) is consistent with [chat_models.mdx](https://github.com/langchain-ai/langchain/edit/master/docs/docs/concepts/chat_models.mdx) (SS below from same, take note that how bullet numbers are not bold). ![image](https://github.com/user-attachments/assets/712b1a73-85ca-45d0-86d6-aa1c0fb3f164)
1 parent 1935e45 commit 40bd71c

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/docs/concepts/structured_outputs.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ This need motivates the concept of structured output, where models can be instru
1111

1212
## Key concepts
1313

14-
**(1) Schema definition:** The output structure is represented as a schema, which can be defined in several ways.
15-
**(2) Returning structured output:** The model is given this schema, and is instructed to return output that conforms to it.
14+
1. **Schema definition:** The output structure is represented as a schema, which can be defined in several ways.<br/>
15+
2. **Returning structured output:** The model is given this schema, and is instructed to return output that conforms to it.
1616

1717
## Recommended usage
1818

@@ -109,11 +109,11 @@ ai_msg
109109

110110
There are a few challenges when producing structured output with the above methods:
111111

112-
(1) When tool calling is used, tool call arguments needs to be parsed from a dictionary back to the original schema.
112+
1. When tool calling is used, tool call arguments needs to be parsed from a dictionary back to the original schema.<br/>
113113

114-
(2) In addition, the model needs to be instructed to *always* use the tool when we want to enforce structured output, which is a provider specific setting.
114+
2. In addition, the model needs to be instructed to *always* use the tool when we want to enforce structured output, which is a provider specific setting.<br/>
115115

116-
(3) When JSON mode is used, the output needs to be parsed into a JSON object.
116+
3. When JSON mode is used, the output needs to be parsed into a JSON object.
117117

118118
With these challenges in mind, LangChain provides a helper function (`with_structured_output()`) to streamline the process.
119119

0 commit comments

Comments
 (0)