Document output - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

The following lines show an example for a query with the misspelled keyword "delivry". The response body returned one Unstructured Document as a result.

{
  "spellcheck": {
  "suggestedQuery": "delivery",
  "htmlSuggestedQuery": "<span class=\"kwicmatch\">delivery</span>"
  },
  "facets": [
    {
      "key": "Category",
      "label": "Category",
      "hierarchical": false,
      "multiSelectionable": true,
      "rootNodes": [
        {
          "value": "Brochures",
          "label": "Brochures",
          "selected": false,
          "totalResultsCount": 1,
          "childNodes": [],
          "descendantSelected": false
        },
        {
          "value": "Slides",
          "label": "Slides",
          "selected": true,
          "totalResultsCount": 1,
          "childNodes": [],
          "descendantSelected": false
        }
      ]
    }
  ],
  "results": [
    {
      "entries": [
        {
          "type": "DOCUMENT",
          "document": {
            "documentId": "3hyh_FZKSTpWSfNM0slpow",
            "title": "Introduction to Dynamic Content Delivery",
            "htmlTitle": "<span class=\"kwicstring\">Introduction to Dynamic Content </span><span class=\"kwicmatch\">Delivery</span>",
            "htmlExcerpt": "<span class=\"kwicstring\">Dynamic Content </span><span class=\"kwicmatch\">Delivery</span><span class=\"kwicstring\"> Augmented Customer Support 03.22.2022 Confidential - © Antidot 2023</span><span class=\"kwictruncate\">...</span><span class=\"kwicstring\">technical content Cloud-based Revolutionize its </span><span class=\"kwicmatch\">delivery</span><span class=\"kwicstring\"> Big Data Technologies LinkedDa ata Text-mining</span><span class=\"kwictruncate\">...</span><span class=\"kwicstring\">14 look &amp; feel Combine &amp; Publish A secure </span><span class=\"kwicmatch\">delivery</span><span class=\"kwicstring\"> layer ■\u202f Connects to your security back-end:</span><span class=\"kwictruncate\">...</span>",
            "filename": "FluidTopics-Pres-2017b-EN.pdf",
            "mimeType": "application/pdf",
            "metadata": [
              {
                "key": "Category",
                "label": "Categorie",
                "values": [
                  "Slides"
                ]
              },
              ...
            ],
            "openMode": "FLUIDTOPICS",
            "documentUrl": "https://api.my_site.fluidtopics.net/api/khub/documents/:docId",
            "contentUrl": "https://api.my_site.fluidtopics.net/api/khub/documents/:docId/content",
            "viewerUrl": "https://my_site.fluidtopics.net/v/u/my-content"
          }
        }
      ]
    }
  ],
  "paging": {
    "currentPage": 1,
    "totalResultsCount": 1,
    "totalClustersCount": 1,
    "isLastPage": true
  }
}

Where:

  • kwicstring is the part of the original query which was correctly spelled.
  • kwicmatch is the part of the query corrected by the spellchecker.

The response body provides the following fields:

Field Type Description
document Object Contains all information in relation with the unstructured document.
    documentId String The ID parameter of the unstructured document.
    title String The unstructured document title.
    htmlTitle String The unstructured document title written in HTML with kwicstring and kwicmatch CSS classes.
    htmlExcerpt String The unstructured document excerpt as displayed in the Search Results page, written in HTML with kwicstring and kwicmatch CSS classes.
    filename String The filename of the unstructured document.
    mimeType String The type/format of the unstructured document.
    metadata Array Contains all information in relation with the unstructured document metadata.
        key String The metadata facet ID.
        label String The metadata as displayed in Fluid Topics.
        values Array The unstructured document metadata values for a given metadata element.
    openMode String Defines where the publication is opened. It has two possible values:
  • fluidtopics if the publication is to be opened by Fluid Topics
  • external if the publication is to be opened externally
    originUrl String The origin URL of the publication.

The originUrl element is present only when the openMode object has the value external.
    documentUrl String The URL fragment to use to get the unstructured document metadata in the given context.
    contentUrl String The URL fragment to use to get the unstructured document content in the given context.
    viewerUrl String The URL fragment to use to open the unstructured document in a Fluid Topics interface. The pretty URL is used when available.