redhat-et / foundation-models-for-documentation

Improve ROSA customer experience (and customer retention) by leveraging foundation models to do “gpt-chat” style search of Red Hat customer documentation assets.
Other
24 stars 11 forks source link

add a RHODS FAQ #39

Closed goern closed 1 year ago

goern commented 1 year ago

Signed-off-by: Christoph Görn goern@redhat.com

codificat commented 1 year ago

Thanks for the contribution. A couple of comments/questions.

As this document is in a FAQ format, it looks like a great candidate for us to use it as a source for test / validation. We are trying a similar approach with the ROSA FAQ.

For this to work, though, we also need corresponding "training set" documents: documentation from where the answers can be deduced.

Another reason for having these additional sources is to be able to augment responses with provenance information, i.e. for the LM to be able to include a link to the source in the generated responses. My understanding is that the contributed FAQ does not have a corresponding public URL (is that right?), so it would be even more important to have other public documents to be able to point to.

Should we maybe also include RHODS documentation as sources?

We are already able to automatically ingest OpenShift documentation from the openshift-docs repo. I do not find RHODS documentation there, though. The only reference at first sight is within the ROSA documentation, rendered here. This would only address a very small part of this FAQ.

Alternatively, we can use this single doc as a one-off type of context/training data. But I thought I'd ask in case we can give it more context.

Shreyanand commented 1 year ago

@codificat Are your comments resolved? If so, we can go ahead and merge this.