feat: added new trace types for Response step (PL3-54) #446
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zhihil
force-pushed
the
brennan/response-trace-types/PL3-54
branch
from
be23e96
to
ed332f4
Compare
trs
approved these changes
Jul 14, 2023
Comment on lines
+35
to
+42
| style?: { | ||
| delay?: number; | ||
| }; |
There was a problem hiding this comment.
Is the idea to move this out of the text trace's payload?
There was a problem hiding this comment.
That's correct. The new JSON variant seems to also have a sort of delay property, based on the Figma mocks.
zhihil
force-pushed
the
brennan/response-trace-types/PL3-54
branch
from
591a9f6
to
6c50516
Compare
zhihil
force-pushed
the
brennan/response-trace-types/PL3-54
branch
2 times, most recently
from
8bf6576
to
c772d1f
Compare
zhihil
force-pushed
the
brennan/response-trace-types/PL3-54
branch
from
c772d1f
to
0baae44
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
zhihil
commented
Aug 8, 2023
| import { BaseTraceFrame, TraceType } from '../../node/utils'; | ||
|
|
||
| interface StepData { | ||
| content: Markup; |
There was a problem hiding this comment.
The data payload is subject to change due to a proposal by Tyler H to simply return Markdown rather than Markup. See slack thread here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes or implements PL3-54
Brief description. What is this change?
Added a new family of V3 traces to support the Response handler.
Implementation details. How do you make this change?
Adding new trace types to support new kinds of content in V3:
JSONTrace- Stores JSON contentVideoTrace- Stores Video contentAdded new versions of existing traces to simplify the trace
ImageTrace- Stores an image url without the additional properties from aVisualTrace. The v3 Response handler does not have sufficient data to fill out aVisualTrace. ThisImageTraceis a simpler trace that avoids a situation where the Response handler returns aVisualTracewith extraneous, useless properties with dummy values.TextTrace- Stores text asMarkupoutput. This replaces the V2 text trace, as the original text trace does not returnMarkupbut instead, astringmessage along with Slate.js data. We should instead return aMarkupdata structure and leave it up to the user to translate Markup formatting (e.g. bolding) into a client-specific format (e.g.**in markdown).DebugTrace- Refactors the debug trace to be more flexible. Highlights include a log-level property,DebugInfoLevel, to support a future feature where users can filter out for certain debug traces fromgeneral-runtimesimilar to different log levels in JS console logging and a newdetailspayload that could store any data. In particular, I've used this in the Prompt variants to output debug traces containing the documents used by the knowledge base to generate its answer.The new trace types are nested under
traces/v3notnode. Ideally, in the future, traces are not coupled 1-to-1 withnode. Thetraces should be a related, but essentially independent data type from thenodes and thegeneral-runtimecan be thought of as an "adapter" that adapts input nodes into output traces.NOTE: This PR was originally submitted for review but has been resubmitted because it has undergone refactors as a result of the response handler changes.
Setup information
N/A
Deployment Notes
N/A
Related PRs
Checklist