fix: use role instead of type in initial messages

[BuckyMcYolo]

Changed the AgentSchema.context messages array to contain 'role' instead of 'type' for 'user' or 'assistant' messages. Was receiving an error and I had no idea how to fix for a while bc this information is not present in the documentation. See issue here

Summary by CodeRabbit

• Refactor
  • Improved the consistency of message definitions for clearer differentiation between user and assistant roles.

[coderabbitai]

Walkthrough

The pull request updates the AgentLiveSchema interface in src/lib/types/AgentLiveSchema.ts. Specifically, it changes the property key within the messages array from type to role while keeping the same allowed values ("user" or "assistant") and retaining the content property. This is a semantic update that improves clarity in naming without altering the underlying structure or functionality.

Changes

File	Change Summary
src/lib/types/AgentLiveSchema.ts	Updated the messages array in the AgentLiveSchema interface: the object key changed from type to role while preserving the allowed values ("user" or "assistant") and the content property.

Possibly related PRs

• fix: type definition issues on agent schema #358: Alters the messages property in the AgentLiveSchema interface but retains the type nomenclature, indicating a closely related focus on the same property modification.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 490a2eb and 084cf70.

📒 Files selected for processing (1)

• src/lib/types/AgentLiveSchema.ts (1 hunks)

🔇 Additional comments (2)

src/lib/types/AgentLiveSchema.ts (2)

189-189: LGTM! The change improves API clarity.

The change from type to role is semantically more accurate and aligns better with common LLM message formats. This will make the API more intuitive for developers familiar with other LLM APIs.

---

189-189:

❓ Verification inconclusive

Note: This is a breaking change.

Changing the property name from type to role in the interface is a breaking change that will require updates to existing code. Please ensure this is released with an appropriate version bump following semver.

Let's verify the impact:

---

🏁 Script executed:

#!/bin/bash
# Search for existing usages of the 'type' property in message contexts
rg -A 2 -B 2 'messages.*type.*user.*assistant' 

Length of output: 48

---

Action Required: Confirm Breaking Change Impact for 'messages' Property Update

The property renaming from type to role in the messages array is indeed a breaking change and must be released with a corresponding semver version bump. Although our initial automated search did not report any hits for the old property name, the absence of output makes the inference uncertain. Please perform a manual review to ensure no parts of the codebase (or external integrations) still depend on the type property.

• Verify that all modules or files consuming AgentLiveSchema have updated to use role instead of type.
• Ensure that there are no lingering references to type in contexts related to messages.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.