LlamaIndexTS/examples/README.md

LlamaIndexTS Examples

This package contains several examples of how to use LlamaIndexTS.

Most examples will use OpenAI by default, so be sure to set your API key.

Running Examples

# export your API key
export OPENAI_API_KEY="sk-..."

npx tsx ./rag/chatEngine.ts

Recommended Starter Examples

Agents:

• Basic OpenAI Agent with Tools
• Agent with MCP Tools
• Customizing Memory

Workflows:

• Workflow basics
• Find more workflow examples in the workflows-ts repo!

Indexing, Retrieval, and Querying:

• Basic Vector Indexing + Query Engine
• Agent + Query Engine Tool

Multimodal:

• Multimodal RAG
• Multimodal Chat

Some more general folders that might be useful to explore:

• storage: Examples with various vector stores
• readers: Examples of how to use the various readers
• models: Examples of how to use the various LLMs and embedding models from many providers