alphanome-ai / sec-ai

A comprehensive open-source toolkit for AI-powered analysis and interpretation of SEC EDGAR filings, providing valuable insights for investors, fintech developers, and researchers.
https://sec.alphanome.app
MIT License
112 stars 24 forks source link

Feedback: Confusing & Not intuitive API #63

Closed aaronclong closed 6 months ago

aaronclong commented 6 months ago

I've been trying to follow your documentation (1, 2). However, I can't really make heads or tails of how to actually parse a document and its sections.

I can see the detail and care that when into designing the API, but I do think a simpler abstraction needs to be introduce. For instance, I've struggled for days to try and parse out a filing's sections and grab its text. While, I have gotten output it hasn't been usable, and I'm certain that text got truncated (all user error).

A big issue is just what method to call when since this works off inheritance. You have to do type checks all over the place. I think creating a higher level API or refactor might be needed to reduce the steep learning curve here.

I was kind of hoping this could just parse the tags automatically for me and put them into types.

Elijas commented 6 months ago

Hey @aaronclong, thanks for reaching out and trying out the package!

  1. Could you link us to a document(s) you're trying to parse? And/or could you post some particular issues (screenshots/examples) that you're coming across?
  2. As for this works off inheritance, could you provide a simple example of how the structure could be improved? I would love to hear your thoughts on it 🚀

I totally, understand the need for a simpler interface while also keeping it functional, if there's any way we could do it, it could help make the library more accessible for many