ix icon indicating copy to clipboard operation
ix copied to clipboard

Feature Request - Better Documentation for using the Python API

Open forconforever opened this issue 8 months ago • 0 comments

I installed ix via its pip package.

I would like to implement my own chains/tools into ix to build own agents. I do not understand how I am supposed to load my code into ix. The documentation is very sparse on it:

Chains may be generated through the visual editor or a python code run as a management command or via shell_plus. JSON config import is not supported yet.

I tried to run the CLI command ix import path_to_pythonfile with the provided example code but this throws an error. But I do not think this is meant by management command or via shell_plus anyway?

x ~/P/ix-devs [1]> ix import ./chains/greeting.py
...
  File "x/.pyenv/versions/3.10.6/lib/python3.10/site-packages/agent_ix/cli.py", line 206, in import_chain
    f"{args.file_path}:/var/fixture.json",
AttributeError: 'Namespace' object has no attribute 'file_path'

Questions

  1. How do i load own code into ix?
  2. is it possible to write own tools with the ix python api? In the Web UI it is stated that one can transform a chain to a tool but it says not how
  3. Do I need to use ix as its dev version or using the package?
  4. Is the folder "workdir" only used for artifacts or should my codebase live in this folder?

Better Documentation

Make node Root/User Input findable in the component search: When i first tried to create a new agent i looked up the Node Graph of one of the existing agents. They all start with the Chat Input node. I tried to search for it in Add Node -> search components but i cloud not find it using the keywords input, chat, user. I could only find it searching for "root". This is very counterintuitive.

detailed example of how to use the python api:

  • How to load a custom chain using the cli ...other ways
  • how to write a custom tool/chain/skill and make it accessible for ix in the web ui

btw ix looks awesome and very polished, good work

forconforever avatar Jun 18 '24 08:06 forconforever