Publish llama-index plugin

.changeset/shiny-emus-change.md

@@ -0,0 +1,5 @@
+---
+"livekit-plugins-llama-index": patch
+---
+
+Publish llama-index plugin

.github/workflows/build-package.yml

@@ -12,13 +12,13 @@ on:
   workflow_dispatch:
     inputs:
       package:
-        description: 'Name of the package to build'
+        description: "Name of the package to build"
         required: true
-        default: 'livekit-plugins-browser'
+        default: "livekit-plugins-browser"
       artifact_name:
-        description: 'Artifact name for the distribution package'
+        description: "Artifact name for the distribution package"
         required: true
-        default: 'build-artifact'
+        default: "build-artifact"
 
 jobs:
   build_plugins:
@@ -35,7 +35,8 @@ jobs:
       inputs.package == 'livekit-plugins-openai' ||
       inputs.package == 'livekit-plugins-rag' ||
       inputs.package == 'livekit-plugins-silero' ||
-      inputs.package == 'livekit-plugins-anthropic'
+      inputs.package == 'livekit-plugins-anthropic' ||
+      inputs.package == 'livekit-plugins-llama-index'
 
     defaults:
       run:
@@ -98,4 +99,4 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: ${{ inputs.artifact_name }}
-          path: livekit-plugins/livekit-plugins-browser/dist/
+          path: livekit-plugins/livekit-plugins-browser/dist/

.github/workflows/check-types.yml

@@ -20,7 +20,6 @@ jobs:
         with:
           submodules: recursive
 
-
       - uses: actions/setup-python@v5
         with:
           python-version: "3.9"
@@ -41,7 +40,8 @@ jobs:
                       ./livekit-plugins/livekit-plugins-cartesia \
                       ./livekit-plugins/livekit-plugins-rag \
                       ./livekit-plugins/livekit-plugins-azure \
-                      ./livekit-plugins/livekit-plugins-anthropic
+                      ./livekit-plugins/livekit-plugins-anthropic \
+                      ./livekit-plugins/livekit-plugins-llama-index
 
       - name: Install stub packages
         run: |

.github/workflows/publish-docs.yml

@@ -3,7 +3,7 @@ name: Publish docs
 on:
   workflow_dispatch:
   workflow_call:
-    secrets: 
+    secrets:
       DOCS_DEPLOY_AWS_ACCESS_KEY: {}
       DOCS_DEPLOY_AWS_API_SECRET: {}
 
@@ -19,7 +19,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.12'  # Specify the Python version you want to use
+          python-version: "3.12" # Specify the Python version you want to use
 
       - name: Create and activate virtual environment
         run: |
@@ -42,7 +42,10 @@ jobs:
                                 ./livekit-plugins/livekit-plugins-elevenlabs \
                                 ./livekit-plugins/livekit-plugins-google \
                                 ./livekit-plugins/livekit-plugins-nltk \
-                                ./livekit-plugins/livekit-plugins-openai
+                                ./livekit-plugins/livekit-plugins-openai \
+                                ./livekit-plugins/livekit-plugins-rag \
+                                ./livekit-plugins/livekit-plugins-silero \
+                                ./livekit-plugins/livekit-plugins-llama-index
 
       - name: Build Docs
         run: |
@@ -56,4 +59,4 @@ jobs:
         env:
           AWS_ACCESS_KEY_ID: ${{ secrets.DOCS_DEPLOY_AWS_ACCESS_KEY }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.DOCS_DEPLOY_AWS_API_SECRET }}
-          AWS_DEFAULT_REGION: "us-east-1"
+          AWS_DEFAULT_REGION: "us-east-1"

livekit-plugins/livekit-plugins-llama-index/README.md

@@ -1,14 +1,36 @@
-# LiveKit Plugins Minimal
+# LiveKit Plugins Llama Index
 
-This is a minimal example of a LiveKit plugin for Agents.
+Agent Framework plugin for using Llama Index. Currently supports [Query Engine](https://docs.llamaindex.ai/en/stable/module_guides/deploying/query_engine/) and [Chat Engine](https://docs.llamaindex.ai/en/stable/module_guides/deploying/chat_engines/).
 
-### Developer note
+## Install
 
-When copying this directory over to create a new `livekit-plugins` package, make sure it's nested within the `livekit-plugins` folder and that the `"name"` field in `package.json` follows the proper naming convention for CI:
+```bash
+pip install livekit-plugins-llama-index
+```
+
+## Query Engine
+
+Query Engine is primarily used for RAG. See [example voice agent](https://github.com/livekit/agents/blob/main/examples/voice-pipeline-agent/llamaindex-rag/query_engine.py)
+
+## Chat Engine
 
-```json
-{
-  "name": "livekit-plugins-<name>",
-  "private": true
-}
+Chat Engine can be used as an LLM within the frame work.
+
+```python
+# load the existing index
+storage_context = StorageContext.from_defaults(persist_dir=<mydir>)
+index = load_index_from_storage(storage_context)
+chat_engine = index.as_chat_engine(chat_mode=ChatMode.CONTEXT)
+
+async def entrypoint(ctx: JobContext):
+    ...
+    assistant = VoicePipelineAgent(
+        vad=silero.VAD.load(),
+        stt=deepgram.STT(),
+        llm=llama_index.LLM(chat_engine=chat_engine),
+        tts=openai.TTS(),
+        chat_ctx=initial_ctx,
+    )
 ```
+
+full example [here](https://github.com/livekit/agents/blob/main/examples/voice-pipeline-agent/llamaindex-rag/chat_engine.py)