Organising your content

Folders, documents and fragments

Last updated: 13 June 2022

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. When you index a document you provide Viko with context that will be used when attempting to answer questions on the fly. For example if you index a “shipping” page, Viko will likely use the content in this page when answering shipping related questions.

Viko also supports predefined FAQs (see below)

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 - Viko generated id (primary key)
  • canonical_url - A developer specified identifier (Optional, Non-unique)
  • title - A developer specific document title (Optional, Non-unique)

Tips

A canonical_url can be shared by more than one document. Judicious use of canonical_urls and folders allows you to perform targeted queries. Let’s look at an example:

Assume you are using Viko for a consumer facing e-commerce site. You might choose to create two folders (to keep the example simple) - products and general. Your flagship product has several landing pages and data sheets associated with it. You would place these documents in the products folder with a common canonical_url.

If a consumer asks a question when on the product page, it probably makes sense to restrict the query context to those product specific documents. You would therefore filter by canonical_url. Whilst viewing a specific product the consumer might also have general questions (shipping etc). You would also include documents in the general folder:

{
  "text": "how much is next day shipping?",
  "filter": {
      "canonical_urls": [
          "https://acme.com/products/flagship.html"
      ],
      "folders": [
          "general"
      ]
  }
}

See the section about asking questions for more information


FAQs and AQs

FAQs are a powerful tool, not only from a usability perspective but also for SEO. Viko can query existing, predefned FAQs and we encourage you to ingest as many question answer pairs as possible.

Viko is essentially a question answering platform. Any generated answer that is accepted by the user is a candidate FAQ. Of course we can’t really describe every question as a Frequently Asked Question so we describe it simply as an Answered Question (AQ).

AQs will be stored and future, semantically similar questions will be tested against prior AQs and FAQs. Over time Viko is able to highlight FAQs which could be candidates for prominent display on your website.

FAQ properties

  • id - Viko generated id (primary key)
  • question - Predefined question (required)
  • answer - Predefined answer (required)

Try Viko

Want to see Viko in action? Try our interactive demo