Organising your content

Viko uses a familiar folder structure to help you organise your content. Organising your content into folders simplifies maintenance and allows you to apply basic query filters.

Folders, documents and fragments

A Document represents a web page, text file or PDF document. Documents (and FAQs) are the information sources that Viko will use to answer questions. For example, if you index a “shipping” page, Viko will likely use the content in this page to answer shipping related questions.

Folders represent a logical collection of documents and FAQs.

A fragment represents a section of a document, for example a paragraph of text. Fragments are generated automatically during the indexing process and are transparent to you.

Folders properties

A folder has no properties other than it’s name

Document properties

• id - Document id (required)
• content - The document contents (required)
• link - URL, for example pointing to the public document (optional)
• title - A developer specific document title (optional)

FAQs

FAQs represent predefined question/answer pairs. When answering questions Viko will first check the FAQs. We enourage you to submit as many FAQs as possible. FAQs are likely to be more accurate than generated answers.

Like documents, FAQs sit within folders.

FAQ properties

• id - FAQ id (required)
• question - Predefined question (required)
• answer - Predefined answer (required)
• context - Additional information relating to the FAQ (optional)
• link - URL, for example pointing to a public document (optional)

AQs

Viko can query existing, predefned FAQs (see above), and we encourage you to ingest as many question answer pairs as possible.

What happens when a user asks a question that is not covered by the FAQs? Viko falls back to it’s extractive or generative question answering - reading through your documents to find an answer. If the user accepts Viko’s answer we have a question/answer pair.

We can’t really describe this as an FAQ because it’s a one-off question, but it is a candidate for an FAQ.

We call these one-off question/answer pairs Answered Questions (AQa)