Lee/update citation format #504
Conversation
🦋 Changeset detectedLatest commit: 40ae3a5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
WalkthroughThe changes introduce a new patch named "create-llama" that updates the chat UI component and refines the citation prompt functionality. The citation prompt string is modified in the environment variables file to clarify how citations should be formatted and separated by spaces. Additionally, the dependency for the chat UI in the Next.js streaming template is updated from version 0.0.14 to 0.0.16. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant C as Chat UI Component
participant E as Environment (Citation Formatter)
U->>C: Send message/request
C->>E: Retrieve updated citation prompt
E-->>C: Return refined prompt with node_id instructions
C-->>U: Display message with enhanced chat UI and citation formatting
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
helpers/env-variables.ts (1)
486-504: Enhance the citation prompt string handling and example.While the citation format instructions are clear, there are two improvements that could be made:
- Use template literals instead of single quotes to avoid potential issues with apostrophes.
- Enhance the example to show more citation use cases.
Apply this diff to improve the prompt:
- const citationPrompt = `'You have provided information from a knowledge base that separates the information into multiple nodes. + const citationPrompt = `You have provided information from a knowledge base that separates the information into multiple nodes. Always add a citation to each sentence or paragraph that you reference in the provided information using the node_id field in the header of each node. The citation format is: [citation:<node_id>] Where the <node_id> is the node_id field in the header of each node. Always separate the citation by a space. Example: We have two nodes: node_id: xyz file_name: llama.pdf node_id: abc file_name: animal.pdf Your answer with citations: A baby llama is called "Cria" [citation:xyz] -It often lives in desert [citation:abc] [citation:xyz] -'`; +It often lives in desert [citation:abc] [citation:xyz] + +Multiple facts can be combined: +Llamas are social animals that live in herds [citation:abc] and can carry up to 25-30% of their body weight [citation:xyz]`;
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.changeset/nasty-dingos-approve.md(1 hunks)helpers/env-variables.ts(2 hunks)templates/types/streaming/nextjs/package.json(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- .changeset/nasty-dingos-approve.md
- templates/types/streaming/nextjs/package.json
| @@ -483,11 +483,12 @@ const getSystemPromptEnv = ( | |||
| }); | |||
| } | |||
| if (tools?.length == 0 && (dataSources?.length ?? 0 > 0)) { | |||
There was a problem hiding this comment.
Fix the condition for adding citation prompt.
The current condition has operator precedence and logical issues. The expression dataSources?.length ?? 0 > 0 is not correctly checking if there are data sources.
Apply this diff to fix the condition:
- if (tools?.length == 0 && (dataSources?.length ?? 0 > 0)) {
+ if (tools?.length == 0 && ((dataSources?.length ?? 0) > 0)) {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| if (tools?.length == 0 && (dataSources?.length ?? 0 > 0)) { | |
| if (tools?.length == 0 && ((dataSources?.length ?? 0) > 0)) { |
🧰 Tools
🪛 Biome (1.9.4)
[error] 485-485: Comparing to itself is potentially pointless.
(lint/suspicious/noSelfCompare)
|
Closed as it has already been implemented in #502 |
Merge after: run-llama/chat-ui#45
Summary by CodeRabbit