chore: bump chat UI version to 0.1.2 and rename generate_ui_for_workflow

[leehuwuj]

Summary by CodeRabbit

• Documentation

  • Updated comments and UI instructions to remove outdated note about cn() support.
  • Clarified docstring for the UI generation function regarding the workflow file argument.
  • Revised documentation to rename the UI generation function and update example usage with recommended LLM models.

• New Features

  • Introduced a public API for UI generation with explicit exports for event component creation and workflow event schema retrieval.

• Chores

  • Incremented the chat UI version from 0.1.1 to 0.1.2.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 6e2cc9a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

This update increments the CHAT_UI_VERSION constant from "0.1.1" to "0.1.2" in the chat UI module. In the UI generation module, it renames the function generate_ui_for_workflow to generate_event_component, updates its docstring for clarity, and removes references to unsupported cn() functionality from comments and UI notices. Additionally, a new __init__.py file was added to the gen_ui package to explicitly export generate_event_component and get_workflow_event_schemas. The documentation was updated to reflect the function rename, change the import path, add explicit LLM usage in examples, and recommend specific LLM models. No changes to logic or control flow are introduced.

Changes

File(s)	Change Summary
llama_index/server/chat_ui.py	Updated CHAT_UI_VERSION constant from "0.1.1" to "0.1.2".
llama_index/server/gen_ui/main.py	Renamed generate_ui_for_workflow to generate_event_component, updated docstring, and removed cn()-related notes from comments and UI notices.
llama_index/server/gen_ui/init.py	Added new __init__.py file exporting generate_event_component and get_workflow_event_schemas to establish public API for the package.
docs/custom_ui_component.md	Updated documentation to rename function to generate_event_component, changed import path, added explicit LLM argument in example, removed ANTHROPIC_API_KEY note, and recommended specific LLM models for better results.

Possibly related PRs

• chore(release): bump CHAT_UI_VERSION to 0.0.6 #533: Updates the CHAT_UI_VERSION constant in the same module, indicating a related version bump.
• Support overriding UI configuration for LlamaIndexServer #519: Also updates the CHAT_UI_VERSION constant, reflecting a similar version increment in the chat UI component.
• add GenUIWorkflow for generating UI components from workflow events #549: Introduces the original generate_ui_for_workflow function and related event classes; related to the renaming and export changes in this PR.

Suggested reviewers

• marcusschiesser

Poem

A hop and a skip, the version grows new,
From 1-1 to 1-2, a shiny fresh hue!
A function renamed, with comments made neat,
The code hops ahead on its nimble feet.
With each little patch, the UI feels spry—
🐇 Cheers to the team, and onward we fly!

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 472232d and 6e2cc9a.

📒 Files selected for processing (1)

• llama-index-server/llama_index/server/gen_ui/main.py (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• llama-index-server/llama_index/server/gen_ui/main.py

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Unit Tests (windows-latest, 3.9)

---

🪧 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.
• @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.

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.