Skip to main content

Reminix adapter for LlamaIndex - serve agents as REST APIs

Project description

reminix-llamaindex

Reminix Runtime adapter for LlamaIndex. Serve LlamaIndex chat engines as a REST API.

Ready to go live? Deploy to Reminix Cloud for zero-config hosting, or self-host on your own infrastructure.

Installation

pip install reminix-llamaindex

This will also install reminix-runtime as a dependency.

Quick Start

from llama_index.core.chat_engine import SimpleChatEngine
from llama_index.llms.openai import OpenAI
from reminix_llamaindex import serve_agent

llm = OpenAI(model="gpt-4o")
engine = SimpleChatEngine.from_defaults(llm=llm)
serve_agent(engine, name="my-chatbot", port=8080)

For more flexibility (e.g., serving multiple agents), use wrap_agent and serve separately:

from llama_index.core.chat_engine import SimpleChatEngine
from llama_index.llms.openai import OpenAI
from reminix_llamaindex import wrap_agent
from reminix_runtime import serve

llm = OpenAI(model="gpt-4o")
engine = SimpleChatEngine.from_defaults(llm=llm)
agent = wrap_agent(engine, name="my-chatbot")
serve(agents=[agent], port=8080)

Your agent is now available at:

  • POST /agents/my-chatbot/invoke - Stateless invocation
  • POST /agents/my-chatbot/chat - Conversational chat

API Reference

serve_agent(engine, name, port, host)

Wrap a LlamaIndex chat engine and serve it immediately. Combines wrap_agent and serve for single-agent setups.

Parameter Type Default Description
engine BaseChatEngine required A LlamaIndex chat engine
name str "llamaindex-agent" Name for the agent (used in URL path)
port int 8080 Port to serve on
host str "0.0.0.0" Host to bind to

wrap_agent(engine, name)

Wrap a LlamaIndex chat engine for use with Reminix Runtime. Use this with serve from reminix_runtime for multi-agent setups.

Parameter Type Default Description
engine BaseChatEngine required A LlamaIndex chat engine
name str "llamaindex-agent" Name for the agent (used in URL path)

Returns: LlamaIndexAgentAdapter - A Reminix adapter instance

Example with RAG

from llama_index.core import VectorStoreIndex, SimpleDirectoryReader
from llama_index.llms.openai import OpenAI
from reminix_llamaindex import wrap_agent
from reminix_runtime import serve

# Load documents and create index
documents = SimpleDirectoryReader("./data").load_data()
index = VectorStoreIndex.from_documents(documents)

# Create a chat engine with the index
engine = index.as_chat_engine(llm=OpenAI(model="gpt-4o"))

# Wrap and serve
agent = wrap_agent(engine, name="rag-chatbot")
serve(agents=[agent], port=8080)

Endpoint Input/Output Formats

POST /agents/{name}/invoke

Stateless invocation for task-oriented operations.

Request:

{
  "input": {
    "query": "What is the capital of France?"
  }
}

Or with prompt:

{
  "input": {
    "prompt": "Summarize this text: ..."
  }
}

Response:

{
  "output": "The capital of France is Paris."
}

POST /agents/{name}/chat

Conversational chat. The adapter extracts the last user message.

Request:

{
  "messages": [
    {"role": "user", "content": "What is the capital of France?"}
  ]
}

Response:

{
  "output": "The capital of France is Paris.",
  "messages": [
    {"role": "user", "content": "What is the capital of France?"},
    {"role": "assistant", "content": "The capital of France is Paris."}
  ]
}

Runtime Documentation

For information about the server, endpoints, request/response formats, and more, see the reminix-runtime package.

Deployment

Ready to go live?

Links

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reminix_llamaindex-0.0.7.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reminix_llamaindex-0.0.7-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file reminix_llamaindex-0.0.7.tar.gz.

File metadata

  • Download URL: reminix_llamaindex-0.0.7.tar.gz
  • Upload date:
  • Size: 10.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for reminix_llamaindex-0.0.7.tar.gz
Algorithm Hash digest
SHA256 4bfb16899394d292a96418e44cf70e8945f41fc7eab9b0bc3f841d4ba2f35a1d
MD5 569facafa4bdebfa1fbdec4f504f468e
BLAKE2b-256 6b3775781c8b7e465e8bc72003092c4e4e967c1644577cecfd904e74d8667d6a

See more details on using hashes here.

File details

Details for the file reminix_llamaindex-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: reminix_llamaindex-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.26 {"installer":{"name":"uv","version":"0.9.26","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for reminix_llamaindex-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 754eda8b3e6e4895a9e30fd522b27b32575240dc19ac998fc4efbfb8af784654
MD5 64e22e025687e76bde9f50d1cc97cebf
BLAKE2b-256 2a2b41ac8fad17e99c0d1015f9da9ee2af68355f7f9283f50787a6d1926c9555

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page