Skip to main content

Application: govuk-chat

A web application that provides a LLM powered chat experience based on GOV.UK content.

GitHub
govuk-chat
Ownership
#ai-govuk owns the repo. #ai-govuk-chat-devs receives automated alerts for this repo.
Category
AI apps
Links

README

A web application that provides a LLM powered chat experience based on GOV.UK content. Initially launched as a beta with limited user access.

Nomenclature

  • Question - an individual query from an end user
  • Answer - a LLM generated response to a user’s question
  • Source - a reference to a chunk of GOV.UK content that was used as the supporting content for an Answer
  • Conversation - a collection of questions and answers that represent a user’s particular interaction with this application
  • Chunk - a portion of a GOV.UK Content Item, which tends to be of the granularity of a particular heading and related content
  • Signon user - a user, authenticated by signon, that is authenticated to use the application

Technical documentation

This is a Ruby on Rails app, and should follow our Rails app conventions.

You can use the GOV.UK Docker environment to run the application and its tests with all the necessary dependencies. Follow the usage instructions to get started.

Before running the app

Copy the .env.example file to .env and ask a team member for the values to use.

cp .env.example .env

Installing dependencies

GOV.UK Chat uses the govuk_chat_private gem to provide some configuration files. This gem is hosted on a private Github repo, so it needs authentication to install it.

Generate a personal access token (PAT) on Github here. Scope the token to only allow access to the govuk_chat_private repo. Under the “Repository permissions” section, select “read only” under the “Contents” section.

Configure Bundler to use the PAT:

bundle config --local github.com <token>

You can then install the dependencies like normal.

bundle

Running the test suite

bundle exec rake

Or can be run in govuk-docker with:

govuk-docker run govuk-chat-lite bundle exec rake

Starting the app

To start the app in govuk-docker from your local machine:

bin/setup --govuk-docker

If you’re not using govuk-docker you can run:

bin/setup

Frozen OpenSearch instance

To test against the frozen OpenSearch instance, see the govuk-chat-opensearch repository.

Further documentation

Licence

MIT License