UFO currently supports processing help documents in json format. More formats will be supported in the future.

An example of a help document in json format is as follows:

{
    "application": "chrome",
    "request": "How to change the username in chrome profiles?",
    "guidance": [
        "Click the profile icon in the upper-right corner of the Chrome window.",
        "Click the gear icon labeled 'Manage Chrome Profiles' in the profile menu.",
        "In the list of profiles, locate the profile whose name you want to change.",
        "Hover over the desired profile and click the three-dot menu icon on that profile card.",
        "Select 'Edit' from the dropdown menu.",
        "In the Edit Profile dialog, click inside the name field.",
        "Delete the current name and type your new desired username.",
        "Click 'Save' to confirm the changes.",
        "Verify that the profile name is updated in the profile list and in the top-right corner of Chrome."
    ]
}

Once you have all help documents and metadata ready, put all of them into a folder. There can be sub-folders for the help documents, but please ensure that each help document and its corresponding metadata are placed in the same directory.

Once you have all documents ready in a folder named path_of_the_docs, you can easily create an offline indexer to support RAG for UFO. Follow these steps:

# assume you are in the cloned UFO folder
python -m learner --app <app_name> --docs <path_of_the_docs>

Replace app_name with the name of the application, such as PowerPoint or WeChat.

Note: Ensure the app_name is accurately defined as it is used to match the offline indexer in online RAG.

Replace path_of_the_docs with the full path to the folder containing all your documents.

This command will create an offline indexer for all documents in the path_of_the_docs folder using Faiss and embedding with sentence transformer (more embeddings will be supported soon). The created index by default will be placed here.

To enable this in online inference, you can set the following configuration in the ufo/config/config.yaml file:

## RAG Configuration for the offline docs
RAG_OFFLINE_DOCS: True  # Whether to use the offline RAG.
RAG_OFFLINE_DOCS_RETRIEVED_TOPK: 1  # The topk for the offline retrieved documents

Adjust RAG_OFFLINE_DOCS_RETRIEVED_TOPK to optimize performance.