Skip to content

README.adoc

Latest commit

 

History

History
78 lines (57 loc) · 2.99 KB

README.adoc

File metadata and controls

78 lines (57 loc) · 2.99 KB
Raw

Wrapper component for IBM Watson Natural Language Understanding API

Table of Contents

Behavior

As a Qanary component, it reads the question and the annotations produced by upstream components from the Qanary triplestore (the shared process memory), performs its task — disambiguate recognised entity mentions and link them to a knowledge base — and writes the result back as standard Qanary (Web Annotation / qa:) annotations. See Input specification / Output specification below for the exact annotation contract.

Characteristics

  • Task type: Named Entity Disambiguation / Entity Linking (NED).

  • Note: This component retrieves named entities for a given question from the IBM Watson Natural Language Understanding Web Service.

  • Offline build: builds and (where present) tests run offline.

Implementation

  • Language: Java (JDK 21).

  • Major frameworks: Spring Boot 3.5 (spring-boot-starter-parent); the Qanary component framework eu.wdaqua.qanary:qa.component 4.0.0 (transitively Spring Boot Admin client + Apache Jena 5); Gson.

  • Main component class: src/main/java/eu/wdaqua/qanary/component/watson/ned/WatsonNED.java (extends eu.wdaqua.qanary.component.QanaryComponent).

  • Tests: 3 test class(es) under src/test/java/ (LiveConnectionToWatsonTest.java, QanaryServiceControllerTest.java, SwaggerUiAvailabilityTest.java).

Build and run

Targets the current Qanary framework 4.0.0 (Spring Boot 3, Java 21). Install the framework first (mvn install in the Qanary repository), then build with JDK 21:

JAVA_HOME=/path/to/jdk21 mvn clean package
docker build --build-arg JAR_FILE=target/qanary-component-ned-watson.jar -t qanary/qanary-component-ned-watson .

Input specification

Not applicable as the textual question is a default parameter

Output specification

Comment: qa:score is in oa:hasSelector and is of type xsd:float.

@prefix qa: <http://www.wdaqua.eu/qa#> .
@prefix oa: <http://www.w3.org/ns/openannotation/core/> .

<urn:qanary:output> a qa:AnnotationOfInstance .
<urn:qanary:output> oa:hasTarget [
    a   oa:SpecificResource;
        oa:hasSource    <urn:qanary:myQanaryQuestion> ;
        oa:hasSelector  [
            a oa:TextPositionSelector ;
            oa:start "0"^^xsd:nonNegativeInteger ;
            oa:end  "5"^^xsd:nonNegativeInteger ;
            qa:score "0.5"^^xsd:float .
        ]
    ] .
<urn:qanary:output> oa:hasBody <urn:dbr:Resource> ;
    oa:annotatedBy <urn:qanary:Watson> ;
    oa:annotatedAt "2001-10-26T21:32:52"^^xsd:dateTime .

Remarks

  • this Qanary component contains a file-based caching mechanism