Skip to content

feat(docs): add LlamaIndex integration documentation#1064

Merged
areibman merged 4 commits intomainfrom
devin/1749692860-add-llamaindex-docs
Jun 15, 2025
Merged

feat(docs): add LlamaIndex integration documentation#1064
areibman merged 4 commits intomainfrom
devin/1749692860-add-llamaindex-docs

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Add LlamaIndex Integration Documentation

This PR adds comprehensive LlamaIndex integration documentation to the AgentOps docs, following the request to add LlamaIndex as a framework based on the information from https://docs.llamaindex.ai/en/stable/module_guides/observability/#agentops.

Changes Made

  • Added v1 integration documentation (docs/v1/integrations/llamaindex.mdx)

    • Follows the established pattern from other framework integrations like CrewAI
    • Includes step-by-step installation and setup instructions
    • Shows the set_global_handler("agentops") usage pattern
    • References the external LlamaIndex documentation
  • Added v2 integration documentation (docs/v2/integrations/llamaindex.mdx)

    • Modern v2 documentation style with enhanced formatting
    • Comprehensive usage examples and code snippets
    • Details about what operations get tracked automatically
    • Better structured content following v2 patterns
  • Updated navigation structure (docs/mint.json)

    • Added llamaindex to both v1 and v2 integrations lists
    • Maintained alphabetical ordering in the navigation
    • Properly positioned between langchain and llama_stack/litellm

Content Details

The documentation includes:

  • Installation instructions for llama-index-instrumentation-agentops
  • Environment variable setup for AGENTOPS_API_KEY
  • Code examples showing the global handler pattern
  • Information about automatic tracking capabilities
  • Links to external LlamaIndex documentation
  • Consistent formatting with MDX components and styling

Testing

  • ✅ All pre-commit hooks pass (ruff linting and formatting)
  • ✅ Documentation follows existing patterns and structure
  • ✅ Navigation entries are properly formatted and ordered
  • ✅ External links verified to work correctly
  • ✅ Code examples are syntactically correct

References

Requested by: adam@agentops.ai

- Add comprehensive LlamaIndex integration docs for v1 and v2
- Include installation instructions for llama-index-instrumentation-agentops
- Add code examples showing set_global_handler usage pattern
- Update mint.json navigation to include llamaindex in both versions
- Follow existing documentation patterns from other integrations
- Reference external LlamaIndex documentation URL

Co-Authored-By: adam@agentops.ai <itsadamsilverman@gmail.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

devin-ai-integration bot and others added 2 commits June 12, 2025 02:21
- Add working Python script example with local HuggingFace models
- Add Jupyter notebook example following existing patterns
- Add README with setup instructions
- Verified integration works with AgentOps session tracking
- Session link: https://app.agentops.ai/drilldown?session_id=4136e33b-e6b4-4216-8748-e65aa5b7a9e6

Co-Authored-By: adam@agentops.ai <itsadamsilverman@gmail.com>
- Move all imports to top of file to fix E402 lint errors
- Apply ruff formatting fixes
- Maintain functionality while following code style guidelines

Co-Authored-By: adam@agentops.ai <itsadamsilverman@gmail.com>
Copy link
Copy Markdown
Contributor

@bboynton97 bboynton97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well written :)

@areibman areibman merged commit d48ef44 into main Jun 15, 2025
3 checks passed
@areibman areibman deleted the devin/1749692860-add-llamaindex-docs branch June 15, 2025 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants