docs: clarify scope and add 'Why Llumiverse' + tooling updates#233
docs: clarify scope and add 'Why Llumiverse' + tooling updates#233ebarroca wants to merge 2 commits into
Conversation
…resh tool-use guide
ChangesThis pull request updates the documentation for Llumiverse, focusing on clarifying tool use/function calling, structured output, and Azure AI Foundry support. It enhances the README and README-tools files to provide more detailed instructions and examples for developers using Llumiverse with various LLM providers. The changes aim to improve the developer experience by providing clearer guidance on leveraging Llumiverse's features, especially around tool integration and data validation. Here is a breakdown of the changes:
PurposeThe primary motivation behind this pull request is to clarify the scope and purpose of Llumiverse. The documentation aims to position Llumiverse as a thin, typed, provider-agnostic connector layer, emphasizing its strengths in multi-provider parity. By explicitly defining what Llumiverse is good for and when it should be used, the updates help users understand its role compared to alternative frameworks like LangChain or Vercel AI SDK. The context involves enhancing the documentation with several key improvements. These include a new 'Why Llumiverse' section in the README that outlines its scope, strengths, and limitations. The update also introduces an Architecture section to clarify key concepts such as prompts, streaming, structured output, and capabilities/options. Additional content covers Azure AI Foundry driver usage, model ID semantics, structured output examples, and updates to the embeddings section to reflect Azure Foundry support and provider coverage. Furthermore, the README-tools.md file is rewritten to reflect cross-provider tool support and correct type definitions. Related issues: N/A Code ReviewYou can start a code review by adding a comment: "Vertesia, please review". Note that the motivation and context are rated as very clear (5/5). The agent has a very good understanding of the purpose of the pull request. |
This PR improves the documentation to make it clear what Llumiverse is good for and when to use it.\n\nChanges\n- Add a new 'Why Llumiverse' section to README, outlining scope, strengths, and when not to use it (e.g., choose LangChain or Vercel AI SDK for other needs).\n- Add an Architecture section and clarify key concepts (prompts, streaming, structured output, capabilities/options).\n- Add Azure AI Foundry driver usage and model ID semantics (composite id: deploymentName::baseModel).\n- Add structured output (JSON Schema) example and behavior (Ajv validation with provider hints where supported).\n- Update embeddings section to note Azure Foundry support and clarify provider coverage.\n- Rewrite README-tools.md: reflect cross-provider tool support, correct types (ToolUse.tool_name/tool_input), conversation carry-over, and provider notes.\n\nRationale\n- Position Llumiverse as a thin, typed, provider-agnostic connector layer with strong multi-provider parity, rather than an all-in-one framework.\n\nPreview\n- README.md and README-tools.md updated accordingly.