Kumo 0.3.1

Kumo

Enriching Microsoft Word documents with semantic annotations.

What is Kumo?

Kumo is a semantic annotation library that enables the user to easily specify relationships between text fragments within a document and places, concepts, people, dates and other things that may be stored in an ontology. This is accomplished by providing a simple way to create a relationship and apply it to one or more text fragments within the document.

Getting started

The library is available at NuGet: https://www.nuget.org/packages/Kumo/

To get the latest version of the library, clone this repository and reference the project under src/Kumo in your solution.

Examples

Please note that the library is work in progress.

Some features are yet to be implemented, while others may contain major bugs.

The library API is still subject to change.

The examples here demonstrate some of the basic functionality.

The following code snippet opens a document and retrieves a text fragment.

using System;
using Kumo;

using (var d = Document.Open("path/to/document.docx"))
{
    var text = d.Range(0, 42).Text();

    Console.WriteLine(text);
}

To annotate a text fragment, one must create a Property object which represents an edge with node connected to it in a knowledge graph.

using System;
using Kumo;

using (var d = Documents.Open("path/to/document", true))
{
    var r = d.Range(0, 42);

    r.Attach(
        new Property(
            new("http://example.org/rel"),
            new Resource.Unique("http://example.org/val")
        )
    );
}

You can also attach multiple properties at once to a range.

using System;
using Kumo;

using var d = Documents.Open("path/to/document", true);
{
    var propertyName = new Uri("https://example.orh/references");
    
    var pA = new Property(
        propertyName,
        new Resource.Unique("https://example.org/A")
    );

    var pB = new Property(
        propertyName,
        new Resource.Unique("https://example.org/B")
    );

    var pC = new Property(
        propertyName,
        new Resource.Unique("https://example.org/C")
    );

    var r = d.Range(0, 5);

    r.Attach(new Property[] { pA, pB, pC });
}

Accessing all annotated text fragments within a document is simple.

using System;
using Kumo;

using (var d = Document.Open("path/to/document.docx"))
{
    // Yes, they are called stars.
    var stars = d.Stars();

    foreach (var s in stars)
    {
        Console.WriteLine(s.Text());
    }
}