Skip to content

Conversation

D1m7asis
Copy link

@D1m7asis D1m7asis commented Jun 3, 2025

βœ… PR Title: examples: AI / ML API Usage example

πŸ“ Description

Added a minimal example demonstrating how to use AI/ML API as a model provider with quivr-core. Includes both basic and streaming usage via ChatOpenAI.

  • πŸ“ Files added: simple_question.py, simple_question_streaming.py
  • πŸ“„ Added minimal pyproject.toml and README.md for clarity and reproducibility
  • πŸ“¦ Includes quivr-core as a local/remote dependency (depending on use)

βœ… Checklist

  • Follows Quivr style and example structure
  • Self-reviewed and tested locally
  • Added usage docs and comments
  • Tests not applicable (example script)

πŸ“Έ Screenshots / Logs

Not applicable β€” CLI example

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jun 3, 2025
@D1m7asis D1m7asis changed the title examples: AI / ML API Usage example feat: AI / ML API Usage example Jun 25, 2025
@D1m7asis
Copy link
Author

⚠️ Heads up: The ReadTheDocs build is failing due to a global build config issue, not this PR.

This PR only adds usage examples in examples/, with no changes to docs/ or build scripts.

If needed, I can help debug .readthedocs.yaml, but for now this seems unrelated to the changes introduced here.

@D1m7asis
Copy link
Author

@StanGirard hi! Can i get a review here pls? Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant