Add support for artifact in llama-index-server (#580)

* support artifact

* migrate poetry to uv

* fix ci

* update ci

* Refactor artifact generation tools by introducing separate CodeGenerator and DocumentGenerator classes. Update app_writer to utilize FunctionAgent for code and document generation workflows. Remove deprecated ArtifactGenerator class. Enhance artifact transformation logic in callbacks. Improve system prompts for clarity and instruction adherence.

* enhance code

* remove previous content from tool input

* fix test

* bump chat ui

* revert changes

* remove dead code

* Add artifact workflows for code and document generation

- Introduced `code_workflow.py` for generating and updating code artifacts based on user requests.
- Introduced `document_workflow.py` for generating and updating document artifacts (Markdown/HTML).
- Created `main.py` to set up FastAPI server with artifact workflows.
- Added a README for setup instructions and usage.
- Implemented UI components for displaying artifact status and progress.
- Updated chat router to remove unused event callbacks.

* remove app_writer workflow

* Refactor artifact workflow classes and UI event handling

- Renamed `ArtifactUIEvents` to `UIEventData` for clarity.
- Introduced `last_artifact` attribute in `ArtifactWorkflow` to streamline artifact retrieval.
- Updated chat history handling to utilize the new `last_artifact` attribute.
- Modified event streaming to use `UIEventData` for consistent event structure.
- Added a new UI component for displaying artifact workflow status and progress.

* Use uv to release package

* Refactor artifact workflows and UI components

- Updated `code_workflow.py` and `document_workflow.py` to improve chat history handling and user message storage.
- Enhanced `ArtifactWorkflow` to utilize optional fields in the `Requirement` model.
- Revised prompt instructions for clarity and conciseness in generating requirements.
- Modified UI event components to reflect changes in workflow stages and improve user feedback.
- Improved error handling for JSON parsing in artifact annotations.

* move code

* Merge remote-tracking branch 'origin/main' into lee/add-artifact

* sort artifact

* fix mypy

* fix adding custom route does not work

* fix mypy

* revert create-llama change

* disable e2e test for python package change

* fix missing set memory

* remove include last artifact in the code

* Add ArtifactEvent model and update workflows to use it

Author: leehuwuj

.github/workflows/e2e.yml

@@ -4,10 +4,12 @@ on:
     branches: [main]
     paths-ignore:
       - "python/llama-index-server/**"
+      - ".github/workflows/*llama_index_server.yml"
   pull_request:
     branches: [main]
     paths-ignore:
       - "python/llama-index-server/**"
+      - ".github/workflows/*llama_index_server.yml"
 
 jobs:
   e2e-python:

.github/workflows/release_llama_index_server.yml

@@ -22,41 +22,46 @@ jobs:
         working-directory: ./python/llama-index-server
     if: |
       github.event_name == 'push' && 
-      !startsWith(github.ref, 'refs/heads/release/llama-index-server-v')
+      !startsWith(github.ref, 'refs/heads/release/llama-index-server-v') &&
+      !contains(github.event.head_commit.message, 'Release: llama-index-server v')
 
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
-      - name: Install Poetry
-        run: |
-          curl -sSL https://install.python-poetry.org | python3 -
-
       - name: Install dependencies
-        run: poetry install
+        shell: bash
+        run: uv sync --all-extras --dev
 
       - name: Setup Git
         run: |
           git config --global user.email "github-actions[bot]@users.noreply.github.com"
           git config --global user.name "github-actions[bot]"
 
       - name: Bump patch version
+        shell: bash
         run: |
-          poetry version patch
+          uvx --from=toml-cli toml set --toml-path=pyproject.toml project.version $(uvx --from=toml-cli toml get --toml-path=pyproject.toml project.version | awk -F. '{$NF = $NF + 1;}1' OFS=.)
           git add pyproject.toml
-          git commit -m "chore(release): bump version to $(poetry version -s)"
+          git commit -m "chore(release): bump llama-index-server version to $(uvx --from=toml-cli toml get --toml-path=pyproject.toml project.version)"
 
       - name: Get current version
         id: get_version
+        shell: bash
         run: |
-          version=$(poetry version -s)
+          version=$(uvx --from=toml-cli toml get --toml-path=pyproject.toml project.version)
           echo "current_version=${version}" >> "$GITHUB_OUTPUT"
 
       - name: Create Release PR
@@ -91,31 +96,34 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v4
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.11"
 
-      - name: Install Poetry
-        run: |
-          curl -sSL https://install.python-poetry.org | python3 -
-
       - name: Install dependencies
-        run: poetry install
+        shell: bash
+        run: uv sync --all-extras
 
       - name: Get current version
         id: get_version
+        shell: bash
         run: |
-          version=$(poetry version -s)
+          version=$(uvx --from=toml-cli toml get --toml-path=pyproject.toml project.version)
           echo "current_version=${version}" >> "$GITHUB_OUTPUT"
 
-      - name: Build and publish to PyPI
-        uses: JRubics/[email protected]
-        with:
-          python_version: "3.11"
-          pypi_token: ${{ secrets.PYPI_TOKEN }}
-          package_directory: "python/llama-index-server"
-          poetry_install_options: "--without dev"
+      - name: Build package
+        shell: bash
+        run: uv build --no-sources
+
+      - name: Publish to PyPI
+        shell: bash
+        run: uv publish --token ${{ secrets.PYPI_TOKEN }}
 
       - name: Create GitHub Release
         uses: softprops/action-gh-release@v2

.github/workflows/test_llama_index_server.yml

@@ -4,7 +4,6 @@ on:
   pull_request:
 
 env:
-  POETRY_VERSION: "1.8.3"
   PYTHON_VERSION: "3.9"
 
 jobs:
@@ -21,29 +20,23 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install Poetry
-        run: pipx install poetry==${{ env.POETRY_VERSION }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
 
-      - name: Set up python ${{ matrix.python-version }}
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-          cache: "poetry"
-
-      - name: Configure Poetry
-        run: |
-          poetry config virtualenvs.create true
-          poetry config virtualenvs.in-project true
-          poetry env use python
 
       - name: Install dependencies
         shell: bash
-        run: poetry install --with dev
+        run: uv sync --all-extras --dev
 
       - name: Run unit tests
         shell: bash
-        run: |
-          poetry run pytest tests
+        run: uv run pytest tests
 
   type-check:
     name: Type Check
@@ -54,28 +47,23 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Install Poetry
-        run: pipx install poetry==${{ env.POETRY_VERSION }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
 
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-          cache: "poetry"
-
-      - name: Configure Poetry
-        run: |
-          poetry config virtualenvs.create true
-          poetry config virtualenvs.in-project true
-          poetry env use python
 
       - name: Install dependencies
         shell: bash
-        run: poetry install --with dev
+        run: uv sync --all-extras --dev
 
       - name: Run mypy
         shell: bash
-        run: poetry run mypy llama_index
+        run: uv run mypy llama_index
 
   build:
     needs: [unit-test, type-check]
@@ -85,25 +73,25 @@ jobs:
         working-directory: python/llama-index-server
     steps:
       - uses: actions/checkout@v4
-      - name: Install Poetry
-        run: pipx install poetry==${{ env.POETRY_VERSION }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: ${{ env.PYTHON_VERSION }}
-      - name: Clear python cache
-        shell: bash
-        run: poetry cache clear --all pypi
-      - name: Build package
-        shell: bash
-        run: poetry build
-      - name: Test installing built package
+
+      - name: Install build package
         shell: bash
-        run: python -m pip install .
+        run: uv sync --all-extras
+
       - name: Test import
         shell: bash
-        working-directory: ${{ vars.RUNNER_TEMP }}
-        run: python -c "from llama_index.server import LlamaIndexServer"
+        run: uv run python -c "from llama_index.server import LlamaIndexServer"
+
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:

python/llama-index-server/.gitignore

@@ -0,0 +1,24 @@
+# Python files
+**/__pycache__
+**/build
+**/dist
+**/venv
+**/env
+**/llama-index-server.egg-info
+
+# Jupyter files
+**/*.ipynb
+
+# Pytest files
+**/pytest.ini
+**/pytest.ini
+
+# Pytest cache
+**/pytest_cache
+
+# Tools
+**/.ruff_cache
+**/.mypy_cache
+**/.pylint.d
+**/.pyrightconfig.json
+**/.ui

python/llama-index-server/examples/artifact/README.md

@@ -0,0 +1,52 @@
+# Artifacts App
+
+This guide explains how to set up and use the LlamaIndex server with the artifact workflow to write code or documents.
+
+## Prerequisites
+
+- [uv](https://github.com/astral-sh/uv) installed (a fast Python package manager and runner)
+- An OpenAI API key
+
+## Steps
+
+1. **Set the OpenAI API Key**
+
+   Export your OpenAI API key as an environment variable:
+
+   ```sh
+   export OPENAI_API_KEY=your_openai_api_key_here
+   ```
+
+2. **Run the Server Using uv**
+
+   Start the server with the following command:
+
+   ```sh
+   uv run main.py
+   ```
+
+   This will launch the FastAPI server using the workflow defined in `main.py`.
+
+3. **Access the Application**
+
+   Open your browser and go to:
+
+   ```
+   http://localhost:8000
+   ```
+
+   You will see the LlamaIndex Artifact app UI, where you can interact with the workflow.
+
+## Notes
+
+- By default, the server uses the code artifact workflow. If you want to use the document artifact workflow, edit `main.py` and uncomment the following line:
+
+  ```python
+  # from examples.artifact.document_workflow import ArtifactWorkflow
+  ```
+
+  and comment out the code workflow import.
+
+- The UI provides starter questions to help you get started, or you can enter your own requests.
+
+- The workflow will guide you through planning and generating code or documents based on your input.