.. _json_apps_topics:

Topics Results Schema for JSON
******************************

.. include:: ../../apps/topics_id.inc

Description
===========

The ``TopicsResults`` schema describes the structure of the JSON data returned from the :ref:`Topics application <apps_topics>` by the :ref:`SDK <sdk>` or the :ref:`Portal <portal>`.

Definition
==========

The ``TopicsResults`` schema is defined as:

* ``array[Topic]`` -- The identified topic

with the ``Topic`` schema defined as:

* ``array`` - The topic

  * ``name`` (``string``) -- The literal from the document
  * ``relevancy`` (``number``) -- The relevancy of the topic within the document in percentage

Example
=======

The following is an example of the JSON results for this application:

.. include:: ../../apps/topics_results.inc