You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Overview
Added instructions for configuring custom output rendering at the
tracing project level in `custom-output-rendering.mdx`. This update
includes steps for enabling custom rendering within tracing project
settings and updates the precedence rules to include tracing projects.
## Type of change
**Type:** Update existing documentation
## Related issues/PRs
<!-- Link to related issues, feature PRs, or discussions (if applicable)
-->
- GitHub issue:
- Feature PR: langchain-ai/langchainplus#14495
## Checklist
<!-- Put an 'x' in all boxes that apply -->
- [x] I have read the [contributing guidelines](README.md)
- [x] I have tested my changes locally using `docs dev`
- [x] All code examples have been tested and work correctly
- [x] I have used **root relative** paths for internal links
- [x] I have updated navigation in `src/docs.json` if needed
## Additional notes
The precedence for custom rendering settings is now: annotation queue >
dataset > tracing project.
Co-authored-by: Mason Daugherty <mason@langchain.dev>
Custom output rendering allows you to visualize run outputs and dataset reference outputs using your own custom HTML pages. This is particularly useful for:
7
7
8
-
-**Domain-specific formatting**: Display medical records, legal documents, or other specialized data types in their native format.
9
-
-**Custom visualizations**: Create charts, graphs, or diagrams from numeric or structured output data.
8
+
-**Domain-specific formatting**: Display medical records, legal documents, or other specialized data types in their native format.
9
+
-**Custom visualizations**: Create charts, graphs, or diagrams from numeric or structured output data.
10
10
11
11
In this page you'll learn how to:
12
12
13
-
-**[Configure custom rendering](#configure-custom-output-rendering)** in the LangSmith UI.
14
-
-**[Build a custom renderer](#build-a-custom-renderer)** to display output data.
15
-
-**[Understand where custom rendering appears](#where-custom-rendering-appears)** in LangSmith.
13
+
-**[Configure custom rendering](#configure-custom-output-rendering)** in the LangSmith UI.
14
+
-**[Build a custom renderer](#build-a-custom-renderer)** to display output data.
15
+
-**[Understand where custom rendering appears](#where-custom-rendering-appears)** in LangSmith.
16
16
17
17
## Configure custom output rendering
18
18
19
19
Configure custom rendering at two levels:
20
20
21
-
-**For datasets**: Apply custom rendering to all runs associated with that dataset, wherever they appear—in experiments, run detail panes, or annotation queues.
22
-
-**For annotation queues**: Apply custom rendering to all runs within a specific annotation queue, regardless of which dataset they come from. This takes precedence over dataset-level configuration.
21
+
-**For datasets**: Apply custom rendering to all runs associated with that dataset, wherever they appear—in experiments, run detail panes, or annotation queues.
22
+
-**For annotation queues**: Apply custom rendering to all runs within a specific annotation queue, regardless of which dataset they come from. This takes precedence over dataset-level configuration.
23
+
24
+
### For tracing projects
25
+
26
+
To configure custom output rendering for a tracing project:
2. Click on an existing tracing project or create a new one.
32
+
3. In the edit tracing project pane, scroll to the **Custom Output Rendering** section.
33
+
4. Toggle **Enable custom output rendering**.
34
+
5. Enter the webpage URL in the **URL** field.
35
+
6. Click **Save**.
23
36
24
37
### For datasets
25
38
@@ -49,9 +62,7 @@ To configure custom output rendering for an annotation queue:
49
62
5. Enter the webpage URL in the **URL** field.
50
63
6. Click **Save** or **Create**.
51
64
52
-
<Info>
53
-
When custom rendering is configured at both levels, annotation queue configuration takes precedence over dataset configuration for runs viewed within that queue.
54
-
</Info>
65
+
<Info>When custom rendering settings are applied at multiple levels, the precedence is as follows: annotation queue > dataset > tracing project.</Info>
55
66
56
67
## Build a custom renderer
57
68
@@ -75,13 +86,11 @@ Your HTML page will receive output data via the [postMessage API](https://develo
75
86
}
76
87
```
77
88
78
-
-`type`: Indicates whether this is an actual output (`"output"`) or a reference output (`"reference"`).
79
-
-`data`: The output data itself.
80
-
-`metadata.inputs`: The input data that generated this output, provided for context.
89
+
-`type`: Indicates whether this is an actual output (`"output"`) or a reference output (`"reference"`).
90
+
-`data`: The output data itself.
91
+
-`metadata.inputs`: The input data that generated this output, provided for context.
81
92
82
-
<Note>
83
-
**Message delivery timing**: LangSmith uses an exponential backoff retry mechanism to ensure your page receives the data even if it loads slowly. Messages are sent up to 6 times with increasing delays (100ms, 200ms, 400ms, 800ms, 1600ms, 3200ms).
84
-
</Note>
93
+
<Note>**Message delivery timing**: LangSmith uses an exponential backoff retry mechanism to ensure your page receives the data even if it loads slowly. Messages are sent up to 6 times with increasing delays (100ms, 200ms, 400ms, 800ms, 1600ms, 3200ms).</Note>
85
94
86
95
### Example implementation
87
96
@@ -90,46 +99,44 @@ This example listens for incoming postMessage events and displays them on the pa
0 commit comments