POST api/Annotation (https://sherlock.gnoss.ai/v1/api/Annotation)

Allows you to annotate a text or an url to obtain entities, topics and the text with augmented reading.

Request Information

URI Parameters

None.

Body Parameters

Query data with the content to be annotated and its configuration parameters.

Name	Description	Type	Additional information
title	Title of the text to be annotated (You can send 'title + description' or 'uri').	string	None.
description	Description of the text to be annotated (You can send 'title + description' or 'uri').	string	None.
uri	Uri of the text to be annotated (You can send 'title + description' or 'uri').	string	None.
cutOffMark	Cut-off mark to disambiguate.	decimal number	Range: inclusive between 0 and 1
showAlternatives	Show alternatives if they exist.	boolean	None.
topics	Get topics.	boolean	None.
augmentedText	Augmented text.	boolean	None.
disambiguationEnhancer	Disambiguation enhancers.	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "title": "Garbiñe Muguruza reina en la hierba de Wimbledon",
  "description": "La española rubricó un torneo sin fisuras con un juego consistente y efectivo. Venus Williams no fue capaz de aguantar el ritmo de la embajadora de BBVA y entregó el segundo set del partido a Muguruza. Con un tanteo final de (7-5)(6-0), Garbiñe inscribió su nombre en el libro de leyendas de la hierba de Wimbledon.",
  "uri": "http://exampleuri.com/",
  "cutOffMark": 0.7,
  "showAlternatives": false,
  "topics": false,
  "augmentedText": true,
  "disambiguationEnhancer": [
    "https://es.wikipedia.org/wiki/España",
    "https://en.wikipedia.org/wiki/United_States"
  ]
}

application/xml, text/xml

Sample:

<AnnotationQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models">
  <augmentedText>true</augmentedText>
  <cutOffMark>0.7</cutOffMark>
  <description>La española rubricó un torneo sin fisuras con un juego consistente y efectivo. Venus Williams no fue capaz de aguantar el ritmo de la embajadora de BBVA y entregó el segundo set del partido a Muguruza. Con un tanteo final de (7-5)(6-0), Garbiñe inscribió su nombre en el libro de leyendas de la hierba de Wimbledon.</description>
  <disambiguationEnhancer xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>https://es.wikipedia.org/wiki/España</d2p1:string>
    <d2p1:string>https://en.wikipedia.org/wiki/United_States</d2p1:string>
  </disambiguationEnhancer>
  <showAlternatives>false</showAlternatives>
  <title>Garbiñe Muguruza reina en la hierba de Wimbledon</title>
  <topics>false</topics>
  <uri>http://exampleuri.com/</uri>
</AnnotationQuery>

Response Information

Resource Description

AnnotationResult

Name	Description	Type	Additional information
lang	Text language.	string	None.
entityNumber	Entities amount.	integer	None.
topicNumber	Topics amount.	integer	None.
augmentedTextTitle	Augmented title.	string	None.
augmentedTextDescription	Augmented description.	string	None.
entityList	Obtained entities list.	Collection of Result	None.
topicList	Obtained topics list.	Collection of Result	None.
credit	Annotation cost (credits).	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "lang": "es",
  "entityNumber": 3,
  "topicNumber": 1,
  "augmentedTextTitle": "<span class=\"entity\" uri=\"http://wikidata.dbpedia.org/resource/Q34276\">Garbiñe Muguruza</span> reina en la <span class=\"topic\" uri=\"http://wikidata.dbpedia.org/resource/Q190903\">hierba</span> de <span class=\"entity\" uri=\"http://wikidata.dbpedia.org/resource/Q41520\">Wimbledon</span>",
  "augmentedTextDescription": "La española rubricó un torneo sin fisuras con un juego consistente y efectivo. <span class=\"entity\" uri=\"http://wikidata.dbpedia.org/resource/Q11578\">Venus Williams</span> no fue capaz de aguantar el ritmo de la embajadora de BBVA y entregó el segundo set del partido a <span class=\"entity\" uri=\"http://wikidata.dbpedia.org/resource/Q34276\">Muguruza</span>. Con un tanteo final de (7-5)(6-0), <span class=\"entity\" uri=\"http://wikidata.dbpedia.org/resource/Q34276\">Garbiñe</span> inscribió su nombre en el libro de leyendas de la <span class=\"topic\" uri=\"http://wikidata.dbpedia.org/resource/Q190903\">hierba</span> de <span class=\"entity\" uri=\"http://wikidata.dbpedia.org/resource/Q41520\">Wimbledon</span>.",
  "entityList": [
    {
      "textList": [
        "Garbiñe Muguruza",
        "Garbiñe",
        "Muguruza"
      ],
      "relevance": 1.0,
      "count": 3,
      "entityList": [
        {
          "uri": "http://wikidata.dbpedia.org/resource/Q34276",
          "types": [
            "http://dbpedia.org/ontology/TennisPlayer",
            "http://dbpedia.org/ontology/Agent",
            "http://dbpedia.org/ontology/Athlete",
            "http://dbpedia.org/ontology/Person"
          ],
          "type": "Person",
          "langType": [
            {
              "language": "es",
              "label": "Person"
            },
            {
              "language": "en",
              "label": "Persona"
            }
          ],
          "subType": "TennisPlayer",
          "langSubType": [
            {
              "language": "es",
              "label": "Tenista"
            },
            {
              "language": "en",
              "label": "Tennis player"
            }
          ],
          "labels": [
            {
              "language": "es",
              "label": "Garbiñe Muguruza"
            },
            {
              "language": "en",
              "label": "Garbiñe Muguruza"
            }
          ],
          "sameAs": [
            "http://rdf.freebase.com/ns/m.0bbwvqy",
            "http://es.dbpedia.org/resource/Garbiñe_Muguruza",
            "http://dbpedia.org/resource/Garbiñe_Muguruza"
          ],
          "wikipediaUri": [
            {
              "language": "en",
              "uri": "https://en.wikipedia.org/wiki/Garbiñe_Muguruza"
            },
            {
              "language": "es",
              "uri": "https://es.wikipedia.org/wiki/Garbiñe_Muguruza"
            }
          ]
        }
      ]
    },
    {
      "textList": [
        "Wimbledon"
      ],
      "relevance": 0.9505275,
      "count": 2,
      "entityList": [
        {
          "uri": "http://wikidata.dbpedia.org/resource/Q41520",
          "types": [],
          "type": "Thing",
          "langType": [
            {
              "language": "es",
              "label": "Cosa"
            },
            {
              "language": "en",
              "label": "Thing"
            }
          ],
          "subType": null,
          "langSubType": null,
          "labels": [
            {
              "language": "es",
              "label": "Campeonato de Wimbledon"
            },
            {
              "language": "en",
              "label": "The Championships, Wimbledon"
            }
          ],
          "sameAs": [
            "http://rdf.freebase.com/ns/m.0mmmt",
            "http://es.dbpedia.org/resource/Campeonato_de_Wimbledon",
            "http://dbpedia.org/resource/The_Championships,_Wimbledon"
          ],
          "wikipediaUri": [
            {
              "language": "en",
              "uri": "https://en.wikipedia.org/wiki/The_Championships,_Wimbledon"
            },
            {
              "language": "es",
              "uri": "https://es.wikipedia.org/wiki/Campeonato_de_Wimbledon"
            }
          ]
        }
      ]
    },
    {
      "textList": [
        "Venus Williams"
      ],
      "relevance": 0.0731883347,
      "count": 1,
      "entityList": [
        {
          "uri": "http://wikidata.dbpedia.org/resource/Q11578",
          "types": [
            "http://dbpedia.org/ontology/TennisPlayer",
            "http://dbpedia.org/ontology/Agent",
            "http://dbpedia.org/ontology/Athlete",
            "http://dbpedia.org/ontology/Person"
          ],
          "type": "Person",
          "langType": [
            {
              "language": "es",
              "label": "Person"
            },
            {
              "language": "en",
              "label": "Persona"
            }
          ],
          "subType": "TennisPlayer",
          "langSubType": [
            {
              "language": "es",
              "label": "Tenista"
            },
            {
              "language": "en",
              "label": "Tennis player"
            }
          ],
          "labels": [
            {
              "language": "es",
              "label": "Venus Williams"
            },
            {
              "language": "en",
              "label": "Venus Williams"
            }
          ],
          "sameAs": [
            "http://rdf.freebase.com/ns/m.016cff",
            "http://es.dbpedia.org/resource/Venus_Williams",
            "http://dbpedia.org/resource/Venus_Williams"
          ],
          "wikipediaUri": [
            {
              "language": "en",
              "uri": "https://en.wikipedia.org/wiki/Venus_William"
            },
            {
              "language": "es",
              "uri": "https://es.wikipedia.org/wiki/Venus_William"
            }
          ]
        }
      ]
    }
  ],
  "topicList": [
    {
      "textList": [
        "hierba"
      ],
      "relevance": 0.4935812,
      "count": 2,
      "entityList": [
        {
          "uri": "http://wikidata.dbpedia.org/resource/Q190903",
          "types": [],
          "type": "Thing",
          "langType": [
            {
              "language": "es",
              "label": "Cosa"
            },
            {
              "language": "en",
              "label": "Thing"
            }
          ],
          "subType": null,
          "langSubType": null,
          "labels": [
            {
              "language": "es",
              "label": "Hierba"
            },
            {
              "language": "en",
              "label": "Herbaceous plant"
            }
          ],
          "sameAs": [
            "http://rdf.freebase.com/ns/m.01j03x",
            "http://es.dbpedia.org/resource/Hierba",
            "http://dbpedia.org/resource/Herbaceous_plant"
          ],
          "wikipediaUri": [
            {
              "language": "en",
              "uri": "https://en.wikipedia.org/wiki/Herbaceous_plant"
            },
            {
              "language": "es",
              "uri": "https://es.wikipedia.org/wiki/Hierba"
            }
          ]
        }
      ]
    }
  ],
  "credit": 3
}

application/xml, text/xml

Sample:

<AnnotationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models">
  <augmentedTextDescription>La española rubricó un torneo sin fisuras con un juego consistente y efectivo. &lt;span class="entity" uri="http://wikidata.dbpedia.org/resource/Q11578"&gt;Venus Williams&lt;/span&gt; no fue capaz de aguantar el ritmo de la embajadora de BBVA y entregó el segundo set del partido a &lt;span class="entity" uri="http://wikidata.dbpedia.org/resource/Q34276"&gt;Muguruza&lt;/span&gt;. Con un tanteo final de (7-5)(6-0), &lt;span class="entity" uri="http://wikidata.dbpedia.org/resource/Q34276"&gt;Garbiñe&lt;/span&gt; inscribió su nombre en el libro de leyendas de la &lt;span class="topic" uri="http://wikidata.dbpedia.org/resource/Q190903"&gt;hierba&lt;/span&gt; de &lt;span class="entity" uri="http://wikidata.dbpedia.org/resource/Q41520"&gt;Wimbledon&lt;/span&gt;.</augmentedTextDescription>
  <augmentedTextTitle>&lt;span class="entity" uri="http://wikidata.dbpedia.org/resource/Q34276"&gt;Garbiñe Muguruza&lt;/span&gt; reina en la &lt;span class="topic" uri="http://wikidata.dbpedia.org/resource/Q190903"&gt;hierba&lt;/span&gt; de &lt;span class="entity" uri="http://wikidata.dbpedia.org/resource/Q41520"&gt;Wimbledon&lt;/span&gt;</augmentedTextTitle>
  <entityList>
    <AnnotationResult.Result>
      <count>3</count>
      <entityList>
        <AnnotationResult.Result.Entity>
          <labels>
            <AnnotationResult.Result.Entity.Label>
              <label>Garbiñe Muguruza</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Garbiñe Muguruza</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </labels>
          <langSubType>
            <AnnotationResult.Result.Entity.Label>
              <label>Tenista</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Tennis player</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </langSubType>
          <langType>
            <AnnotationResult.Result.Entity.Label>
              <label>Person</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Persona</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </langType>
          <sameAs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>http://rdf.freebase.com/ns/m.0bbwvqy</d6p1:string>
            <d6p1:string>http://es.dbpedia.org/resource/Garbiñe_Muguruza</d6p1:string>
            <d6p1:string>http://dbpedia.org/resource/Garbiñe_Muguruza</d6p1:string>
          </sameAs>
          <subType>TennisPlayer</subType>
          <type>Person</type>
          <types xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>http://dbpedia.org/ontology/TennisPlayer</d6p1:string>
            <d6p1:string>http://dbpedia.org/ontology/Agent</d6p1:string>
            <d6p1:string>http://dbpedia.org/ontology/Athlete</d6p1:string>
            <d6p1:string>http://dbpedia.org/ontology/Person</d6p1:string>
          </types>
          <uri>http://wikidata.dbpedia.org/resource/Q34276</uri>
          <wikipediaUri>
            <AnnotationResult.Result.Entity.WikipediaUri>
              <language>en</language>
              <uri>https://en.wikipedia.org/wiki/Garbiñe_Muguruza</uri>
            </AnnotationResult.Result.Entity.WikipediaUri>
            <AnnotationResult.Result.Entity.WikipediaUri>
              <language>es</language>
              <uri>https://es.wikipedia.org/wiki/Garbiñe_Muguruza</uri>
            </AnnotationResult.Result.Entity.WikipediaUri>
          </wikipediaUri>
        </AnnotationResult.Result.Entity>
      </entityList>
      <relevance>1</relevance>
      <textList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>Garbiñe Muguruza</d4p1:string>
        <d4p1:string>Garbiñe</d4p1:string>
        <d4p1:string>Muguruza</d4p1:string>
      </textList>
    </AnnotationResult.Result>
    <AnnotationResult.Result>
      <count>2</count>
      <entityList>
        <AnnotationResult.Result.Entity>
          <labels>
            <AnnotationResult.Result.Entity.Label>
              <label>Campeonato de Wimbledon</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>The Championships, Wimbledon</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </labels>
          <langSubType i:nil="true" />
          <langType>
            <AnnotationResult.Result.Entity.Label>
              <label>Cosa</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Thing</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </langType>
          <sameAs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>http://rdf.freebase.com/ns/m.0mmmt</d6p1:string>
            <d6p1:string>http://es.dbpedia.org/resource/Campeonato_de_Wimbledon</d6p1:string>
            <d6p1:string>http://dbpedia.org/resource/The_Championships,_Wimbledon</d6p1:string>
          </sameAs>
          <subType i:nil="true" />
          <type>Thing</type>
          <types xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
          <uri>http://wikidata.dbpedia.org/resource/Q41520</uri>
          <wikipediaUri>
            <AnnotationResult.Result.Entity.WikipediaUri>
              <language>en</language>
              <uri>https://en.wikipedia.org/wiki/The_Championships,_Wimbledon</uri>
            </AnnotationResult.Result.Entity.WikipediaUri>
            <AnnotationResult.Result.Entity.WikipediaUri>
              <language>es</language>
              <uri>https://es.wikipedia.org/wiki/Campeonato_de_Wimbledon</uri>
            </AnnotationResult.Result.Entity.WikipediaUri>
          </wikipediaUri>
        </AnnotationResult.Result.Entity>
      </entityList>
      <relevance>0.9505275</relevance>
      <textList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>Wimbledon</d4p1:string>
      </textList>
    </AnnotationResult.Result>
    <AnnotationResult.Result>
      <count>1</count>
      <entityList>
        <AnnotationResult.Result.Entity>
          <labels>
            <AnnotationResult.Result.Entity.Label>
              <label>Venus Williams</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Venus Williams</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </labels>
          <langSubType>
            <AnnotationResult.Result.Entity.Label>
              <label>Tenista</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Tennis player</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </langSubType>
          <langType>
            <AnnotationResult.Result.Entity.Label>
              <label>Person</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Persona</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </langType>
          <sameAs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>http://rdf.freebase.com/ns/m.016cff</d6p1:string>
            <d6p1:string>http://es.dbpedia.org/resource/Venus_Williams</d6p1:string>
            <d6p1:string>http://dbpedia.org/resource/Venus_Williams</d6p1:string>
          </sameAs>
          <subType>TennisPlayer</subType>
          <type>Person</type>
          <types xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>http://dbpedia.org/ontology/TennisPlayer</d6p1:string>
            <d6p1:string>http://dbpedia.org/ontology/Agent</d6p1:string>
            <d6p1:string>http://dbpedia.org/ontology/Athlete</d6p1:string>
            <d6p1:string>http://dbpedia.org/ontology/Person</d6p1:string>
          </types>
          <uri>http://wikidata.dbpedia.org/resource/Q11578</uri>
          <wikipediaUri>
            <AnnotationResult.Result.Entity.WikipediaUri>
              <language>en</language>
              <uri>https://en.wikipedia.org/wiki/Venus_William</uri>
            </AnnotationResult.Result.Entity.WikipediaUri>
            <AnnotationResult.Result.Entity.WikipediaUri>
              <language>es</language>
              <uri>https://es.wikipedia.org/wiki/Venus_William</uri>
            </AnnotationResult.Result.Entity.WikipediaUri>
          </wikipediaUri>
        </AnnotationResult.Result.Entity>
      </entityList>
      <relevance>0.0731883347</relevance>
      <textList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>Venus Williams</d4p1:string>
      </textList>
    </AnnotationResult.Result>
  </entityList>
  <entityNumber>3</entityNumber>
  <lang>es</lang>
  <topicList>
    <AnnotationResult.Result>
      <count>2</count>
      <entityList>
        <AnnotationResult.Result.Entity>
          <labels>
            <AnnotationResult.Result.Entity.Label>
              <label>Hierba</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Herbaceous plant</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </labels>
          <langSubType i:nil="true" />
          <langType>
            <AnnotationResult.Result.Entity.Label>
              <label>Cosa</label>
              <language>es</language>
            </AnnotationResult.Result.Entity.Label>
            <AnnotationResult.Result.Entity.Label>
              <label>Thing</label>
              <language>en</language>
            </AnnotationResult.Result.Entity.Label>
          </langType>
          <sameAs xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>http://rdf.freebase.com/ns/m.01j03x</d6p1:string>
            <d6p1:string>http://es.dbpedia.org/resource/Hierba</d6p1:string>
            <d6p1:string>http://dbpedia.org/resource/Herbaceous_plant</d6p1:string>
          </sameAs>
          <subType i:nil="true" />
          <type>Thing</type>
          <types xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
          <uri>http://wikidata.dbpedia.org/resource/Q190903</uri>
          <wikipediaUri>
            <AnnotationResult.Result.Entity.WikipediaUri>
              <language>en</language>
              <uri>https://en.wikipedia.org/wiki/Herbaceous_plant</uri>
            </AnnotationResult.Result.Entity.WikipediaUri>
            <AnnotationResult.Result.Entity.WikipediaUri>
              <language>es</language>
              <uri>https://es.wikipedia.org/wiki/Hierba</uri>
            </AnnotationResult.Result.Entity.WikipediaUri>
          </wikipediaUri>
        </AnnotationResult.Result.Entity>
      </entityList>
      <relevance>0.4935812</relevance>
      <textList xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>hierba</d4p1:string>
      </textList>
    </AnnotationResult.Result>
  </topicList>
  <topicNumber>1</topicNumber>
</AnnotationResult>