New guide to create your first AI Java application

[lauracowen]

As there are no guides to creating AI Java applications with LangChain4j on the quarkus.io website, I've created this simple guide for consideration. I'm aware that there is doc on the quarkiverse (and I'm going to attempt to address some of the issues raised on that next) but the absence of AI guides on the main quarkus.io website seems like a gap.

The sample code is based on a modified version of the poem generator sample code used elsewhere. I've created a quickstart of the app in this PR: quarkusio/quarkus-quickstarts#1537

I've run the docs module build as instructed and run Vale with the following output:

 �[4msrc/main/asciidoc/getting-started-ai-java-apps.adoc�[0m
 30:152   �[33mwarning�[0m  Use correct American English    Quarkus.Spelling      
                   spelling. Did you really mean                         
                   'LLMs'?                                               
 30:284   �[33mwarning�[0m  Use correct American English    Quarkus.Spelling      
                   spelling. Did you really mean                         
                   'LLMs'?                                               
 30:340   �[33mwarning�[0m  Use correct American English    Quarkus.Spelling      
                   spelling. Did you really mean                         
                   'LLMs'?                                               
 36:73    �[33mwarning�[0m  Consider using 'to' rather      Quarkus.TermsWarnings 
                   than 'in order to' unless                             
                   updating existing content that                        
                   uses the term.                                        
 140:165  �[33mwarning�[0m  Use correct American English    Quarkus.Spelling      
                   spelling. Did you really mean                         
                   'LLM's'?                                              
 277:105  �[33mwarning�[0m  Consider using 'examine'        Quarkus.TermsWarnings 
                   rather than 'look at' unless                          
                   updating existing content that                        
                   uses the term.   

I think all these are fine in context as they are.

I also ran a local container build of the site to preview the guide and check the includes were pulled in correctly - they seem to be:

(re-created from #48128 to clean up commits)

[github-actions]

🎊 PR Preview fb5b21c has been successfully built and deployed to https://quarkus-pr-main-48136-preview.surge.sh/version/main/guides/

• Images of blog posts older than 3 months are not available.
• Newsletters older than 3 months are not available.

[edeandrea]

See my comment on the PR.

I'm not opposed to this (might not be a bad idea at all), but generally I'm not sure we've included guides in Quarkus core for things that were not part of Quarkus core (quarkus-langchain4j isn't part of Quarkus core).

@geoand / @gsmet thoughts?

An issue that may arise having it here though is that the lifecycle of quarkus-langchain4j is different than for quarkus core, so keeping it up to date may be challenging.

[geoand]

Maybe this has been communicated with @maxandersen or @cescoffier.

[gsmet]

I'm not opposed to this (might not be a bad idea at all), but generally I'm not sure we've included guides in Quarkus core for things that were not part of Quarkus core (quarkus-langchain4j isn't part of Quarkus core).

I think it's worth it given how important the AI use case is nowadays.

Now yes, the lifecycle is a bit problematic.

I wonder if it's a guide we should have in the LangChain4j doc and then make sure we have it included in the search engine. But not sure it's ideal either.

I think we really need to sort this out as this initiative has a a lot of value IMHO.

[maxandersen]

No. It's not something I'm specific aware of.

We have though discussed making sure Quarkus.io has more AI content - one is that when searching it now also includes quarkiverse

Other is to build up Quarkus.ai to have dedicated ai content.

@lauracowen given searching for ai or langchain4j gives the recent l4j content is this guide needed ? Is there a specific page you think it's missing or ?

[lauracowen]

My thinking was that if you go to Quarkus.io, as the online home of Quarkus, AI is barely mentioned. Yet, as mentioned above, it's an important use case for Java developers to at least explore and learn about right now. It's good that the search exposes quarkiverse content but, not being on the main site, it doesn't feel like Quarkus is confident about supporting/enabling AI apps, when I think it actually is.

I didn't appreciate the lifecycle differences, so I don't know the implications of that.

No, sorry, the guide wasn't discussed specifically with @maxandersen or @cescoffier - it came up in conversations with @myfear about the lack of introductory AI info to point developers to on Quarkus.io.

[quarkus-bot]

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 7def0f9.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

[cescoffier]

@myfear do you think we should include this on quarkus.ai?

[myfear]

@cescoffier based on our discussion this should potentially go on the L4j doc as a guide.
Have you had a chance to look at my first draft?

[cescoffier]

@myfear Unfortunately, I'm not able to build the jekyll web site - gem issues all the way. Any tip?

[cescoffier]

I was able to get it working.