You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "davsclaus (via GitHub)" <gi...@apache.org> on 2026/08/03 15:55:48 UTC
[PR] CAMEL-24330: Improve AI component documentation based on user feedback [camel]
davsclaus opened a new pull request, #25314:
URL: https://github.com/apache/camel/pull/25314
## Summary
Improves the AI component documentation based on real-world user feedback from a [blog post](https://my-tech-profile.dev/insights/llm-integration-with-apache-camel) by a developer building LLM-powered pipelines with Camel. The author documented several documentation gaps they hit in practice.
Changes:
- **AI summary page**: Added a "Choosing the Right AI Component" decision guide with a comparison table between `camel-openai` and `camel-langchain4j-chat`, helping users pick the right component for their needs
- **OpenAI component**: Added a "Tips for Production Use" section covering:
- Temperature and model parameters (low temperature for structured output)
- Dynamic prompt construction with Simple expressions
- Structured output (`outputClass`/`jsonSchema`) as the recommended approach for JSON extraction
- Handling model output errors (200 responses with unusable content)
- Prompt management at scale (resource files, property placeholders)
- Streaming considerations (pipeline vs user-facing scenarios)
- **LangChain4j Chat component**: Added cross-reference to the OpenAI component and AI summary decision guide
## Test plan
- [ ] Verify AsciiDoc renders correctly on the Camel website
- [ ] Verify all `xref:` links resolve to valid targets
- [ ] Review decision table for accuracy
_Claude Code on behalf of davsclaus_
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude Opus 4.6 <no...@anthropic.com>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-24330: Improve AI component documentation based on user feedback [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus closed pull request #25314: CAMEL-24330: Improve AI component documentation based on user feedback
URL: https://github.com/apache/camel/pull/25314
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-24330: Improve AI component documentation based on user feedback [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #25314:
URL: https://github.com/apache/camel/pull/25314#issuecomment-5170351234
:star2: Thank you for your contribution to the Apache Camel project! :star2:
:robot: CI automation will test this PR automatically.
:camel: Apache Camel Committers, please review the following items:
* First-time contributors **require MANUAL approval** for the GitHub Actions to run
* You can use the command `/component-test (camel-)component-name1 (camel-)component-name2..` to request a test from the test bot although they are normally detected and executed by CI.
* You can label PRs using `skip-tests` and `test-dependents` to fine-tune the checks executed by this PR.
* Build and test logs are available in the summary page. **Only** [Apache Camel committers](https://camel.apache.org/community/team/#committers) have access to the summary.
:warning: Be careful when sharing logs. Review their contents before sharing them publicly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-24330: Improve AI component documentation based on user feedback [camel]
Posted by "atiaomar1978-hub (via GitHub)" <gi...@apache.org>.
atiaomar1978-hub commented on PR #25314:
URL: https://github.com/apache/camel/pull/25314#issuecomment-5170802621
_AI-generated comment on behalf of [atiaomar1978-hub](https://github.com/atiaomar1978-hub)_
@davsclaus — per your suggestion on #25313, the useful content from this PR (OpenAI production tips, ai-summary comparison table, langchain4j cross-links) has been incorporated into #25313 in commit `28c001d79af`, alongside the dedicated LLM Integration Guide.
Happy to close this PR in favour of #25313 if that works for you.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] CAMEL-24330: Improve AI component documentation based on user feedback [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus commented on PR #25314:
URL: https://github.com/apache/camel/pull/25314#issuecomment-5170803293
duplicate closing
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org