search

cheshire-cat-ai / docs

Documentation for the Cheshire Cat AI
https://cheshire-cat-ai.github.io/docs/
33 stars 28 forks source link

Documenting Custom Agent #188

Open valentimarco opened 5 days ago

valentimarco commented 5 days ago

At the moment, the docs doesn't provide a guide to build custom Agent with the new structure introduced on 1.7.X.

I was thinking about this:

  1. Show how you can create your custom flow with this new tool (Even better to introduce a diagram that explain what are you doing step by step)
  2. How can you integrate custom logic or libraries like HayStack, LLamaIndex, GraphRag, GuardRails, NVIDIA NeMo Guardrails (Yes, can be a blog post but adding simple ref to this popolar libraries can help. Particularly for guardrails libraries!)
  3. Explain difference between OpenAi AssistanceAPI (even if...)

All of this should be written in a markdown file under mkdocs/framework/cat-components/cheshire_cat/agent/custom_agent.md

pieroit commented 4 days ago

I'd like to refine more the API of those python classes, are you already using it?

Point 2 really cool