The Homer Multitext Microservice

These examples demonstrate the Scala Cite Services (Akka) application, SCS-Akka, running at beta.hpcc.uh.edu/scs/, and serving data from the 2018d Release of the Homer Multitext Data.

The service accepts requests via HTTP, and returns JSON.

This collection of microservices is serving current data from the Homer Multitext, edited by Casey Dué and Mary Ebbott, a project of the Center for Hellenic Studies of Harvard University.

For more information on this service, please see https://github.com/cite-architecture/scs-akka.

For information on the CITE Architecture, please see https://cite-architecture.github.io.

Report bugs by filing issues on GitHub.

Texts

About the Service’s Catalog

http://beta.hpcc.uh.edu/scs/libraryinfo

See the Text Catalog

Get the First Valid Reference in a text

http://beta.hpcc.uh.edu/scs/texts/firsturn/urn:cts:greekLit:tlg0012.tlg001.msA:

Get Valid References

All references for a version of a text:

http://beta.hpcc.uh.edu/scs/texts/reff/urn:cts:greekLit:tlg0012.tlg001.msA:

Valid references for parts of a text:

Get Passages

Passages for a specific version of a text:

Passages for all versions of a text:

NGrams

NGrams in works present in the library:

http://beta.hpcc.uh.edu/scs/texts/ngram/urn:cts:greekLit:tlg5026.msA.va_dipl:?n=3 (3-grams in the Venetus A Main Scholia)
http://beta.hpcc.uh.edu/scs/texts/ngram/urn:cts:greekLit:tlg5026.msA.va_dipl:?n=3&t=20 ( occuring more than t times)
http://beta.hpcc.uh.edu/scs/texts/ngram/urn:cts:greekLit:tlg5026.msA.va_dipl:?n=3&s=Ζηνόδοτος (Filter for string, s=Ζηνόδοτος.)

Find citations to NGrams:

http://beta.hpcc.uh.edu/scs/texts/ngram/urns?ng=ὅτι+Ζηνόδοτος+γράφει (find URNs for a given N-gram in the entire library)
http://beta.hpcc.uh.edu/scs/texts/ngram/urns/urn:cts:greekLit:tlg0012.tlg001.msA:?ng=προσέφη+πόδας+ὠκὺς (find URNs for a given N-gram in one text)

Returning a Corpus of Passages containing an NGram:

http://beta.hpcc.uh.edu/scs/texts/ngram/urns/tocorpus?ng=ὅτι+Ζηνόδοτος+γράφει (find URNs for a given N-gram in the entire library)
http://beta.hpcc.uh.edu/scs/texts/ngram/urns/tocorpus/urn:cts:greekLit:tlg0012.tlg001.msA:?ng=προσέφη+πόδας+ὠκὺς (find URNs for a given N-gram in one text)

String Searches

Token Searches

http://beta.hpcc.uh.edu/scs/texts/token?t=Ἀγαμέμνων
http://beta.hpcc.uh.edu/scs/texts/token/urn:cts:greekLit:tlg0012.tlg001.msA:?t=Ἀγαμέμνων
http://beta.hpcc.uh.edu/scs/texts/tokens?t=πόδας&t=ὠκὺς
http://beta.hpcc.uh.edu/scs/texts/tokens/urn:cts:greekLit:tlg0012.tlg001.msA:?t=πόδας&t=ὠκὺς
http://beta.hpcc.uh.edu/scs/texts/tokens?dist=3&t=ὅτι&t=γράφει (Two tokens within dist=3 of each other)
http://beta.hpcc.uh.edu/scs/texts/tokens?dist=3&t=ὅτι&t=γράφει (Two tokens within dist=2 of each other, should return no passages)

Collections of Objects

Catalog

http://beta.hpcc.uh.edu/scs/collections/ (all collections)
http://beta.hpcc.uh.edu/scs/collections/urn:cite2:hmt:msA.v1: (filter by URN)
http://beta.hpcc.uh.edu/scs/collections/reff/urn:cite2:hmt:msA.v1: (filter by URN, just URNs)
http://beta.hpcc.uh.edu/scs/collections/hasobject/urn:cite2:hmt:msA.v1:1r (check for an object; should return true)
http://beta.hpcc.uh.edu/scs/collections/hasobject/urn:cite2:hmt:msA.v1:NOTOBJECT (check for an object; should return false)
http://beta.hpcc.uh.edu/collections/labelmap (returns a map of Cite2Urn -> String, the label of each citable object)

Objects

http://beta.hpcc.uh.edu/scs/objects/urn:cite2:hmt:msA.v1: (all objects for version v1 of collection urn:cite2:hmt:msA:)
http://beta.hpcc.uh.edu/scs/objects/prevurn/urn:cite2:hmt:msA.v1:2v (get the URN of the previous object in an ordered collection)
http://beta.hpcc.uh.edu/scs/objects/nexturn/urn:cite2:hmt:msA.v1:1r (get the URN of the next object in an ordered collection)
http://beta.hpcc.uh.edu/scs/objects/urn:cite2:hmt:msA.v1:12r-13v (a range of objects in an ordered versioned collection)
http://beta.hpcc.uh.edu/scs/objects/urn:cite2:hmt:msA.v1:12r-13v?dse=true (a range of objects in an ordered versioned collection, with all DSE records associated with those objects and properties of those objects [see below])
http://beta.hpcc.uh.edu/scs/objects/paged/urn:cite2:hmt:msA.v1:?offset=1&limit=10 (paged viewing of objects in an ordered collection)
http://beta.hpcc.uh.edu/scs/objects/paged/urn:cite2:hmt:msA.v1:?offset=11&limit=10 (paged viewing of objects in an ordered collection)
http://beta.hpcc.uh.edu/scs/objects/paged/urn:cite2:hmt:msA.v1: (paged viewing, with default values, offset=1, limit=10, of objects in an ordered collection)

Get objects from multiple collections:

http://beta.hpcc.uh.edu/scs/collections/objects?urn:cite2:cite:datamodels.v1:&urn=urn:cite2:hmt:msA.v1:&urn=urn:cite2:hmt:compimg.v1:

Finding Objects

urn-match

http://beta.hpcc.uh.edu/scs/objects/find/urnmatch?find=urn:cite2:hmt:msA.v1:12r (search all property-values for a URN)
http://beta.hpcc.uh.edu/scs/objects/find/urnmatch?find=urn:cite2:hmt:msA.v1:12r&dse=true (search all property-values for a URN, with DSE records for the returned objecs.)
http://beta.hpcc.uh.edu/scs/objects/find/urnmatch?find=urn:cite2:hmt:msA.v1:12r&offset=0&limit=3 (search all property-values for a URN; offset=0 start at the first result; limit=3 return only three results; these optional parameters apply to all searching requests and allow paged access to results)
http://beta.hpcc.uh.edu/scs/objects/find/urnmatch/urn:cite2:hmt:va_dse.v1:?find=urn:cite2:hmt:msA.v1:12r (limit to a specified collection)
http://beta.hpcc.uh.edu/scs/objects/find/urnmatch/urn:cite2:hmt:va_dse.v1:?find=urn:cite2:hmt:msA.v1:12r&parameterurn=urn:cite2:hmt:va_dse.v1.surface: (limit to a specified collection and a specified property)

regexmatch

http://beta.hpcc.uh.edu/scs/objects/find/regexmatch?find=[0-9]{2} (use regular expressions to search property values)
http://beta.hpcc.uh.edu/scs/objects/find/regexmatch/urn:cite2:hmt:compimg.v1:?find=[0-9]{2} (use regular expressions to search property values)

stringcontains

valueequals

numeric less-than

numeric less-than-or-equal

numeric equals

numeric greater-than

numeric greater-than-or-equal

numeric within

Data Models

Images

Basic Image Retrieval

http://beta.hpcc.uh.edu/scs/image/urn:cite2:hmt:vaimg.2017a:VA012RN_0013 (resolve to image)
http://beta.hpcc.uh.edu/scs/image/urn:cite2:hmt:vaimg.2017a:VA012RN_0013@0.04506,0.2196,0.1344,0.10093 (resolve to image)
http://beta.hpcc.uh.edu/scs/image/urn:cite2:hmt:vaimg.2017a:VA012RN_0013?resolveImage=false (return URL to image)
http://beta.hpcc.uh.edu/scs/image/urn:cite2:hmt:vaimg.2017a:VA012RN_0013@0.04506,0.2196,0.1344,0.10093?resolveImage=false (return URL to image)

Defining a width

Defining MaxWidth and MaxHeight

Embedding

Relations

CITE Relations are associations of URN to URN, with the relationship specified by a Cite2 URN.

http://beta.hpcc.uh.edu/scs/relations/urn:cts:greekLit:tlg0012.tlg001:1.1 Get all relations for a URN.
http://beta.hpcc.uh.edu/scs/relations/urn:cts:greekLit:tlg0012.tlg001:1.1?filter=urn:cite2:cite:verbs.v1:commentsOn Get all relations, filtered by a relation-URN.

Commentary Data Model

If a library includes CiteRelations and implements the Commentary datamodel, comments associated with passages of text can (optionally) be attached to replies for a corpus of texts.

http://beta.hpcc.uh.edu/scs/texts/urn:cts:greekLit:tlg0012.tlg001:1.1?commentary=true

Documented Scholarly Editions (DSE) Data Model

The DSE Data model consists of a CITE Collection of objects, each documenting a three-way relationship between (a) a text-bearing artifact, (b) a documentary image (ideally with a region-of-interest defined), and © a citable passage of text.

http://beta.hpcc.uh.edu/scs/dse/recordsforsurface/urn:cite2:hmt:msA.v1:12r Get all DSE Records associated with a Text Bearing Artifact.
http://beta.hpcc.uh.edu/scs/dse/recordsforimage/urn:cite2:hmt:vaimg.2017a:VA012RN_0013Get all DSE Records associated with a Citable Image.
http://beta.hpcc.uh.edu/scs/dse/recordsfortext/urn:cts:greekLit:tlg0012.tlg001.msA:1.1 Get all DSE Records associated with a passage of text.
http://beta.hpcc.uh.edu/scs/dse/recordsfortext/urn:cts:greekLit:tlg0012.tlg001.msA:1.1-1.3 Get all DSE Records associated with a passage of text expressed by a range-URN.
http://beta.hpcc.uh.edu/scs/objects/urn:cite2:hmt:msA.v1:12r-13v?dse=true (a range of objects in an ordered versioned collection, with all DSE records associated with those objects and properties of those objects [see below])
http://beta.hpcc.uh.edu/scs/objects/find/urnmatch?find=urn:cite2:hmt:msA.v1:12r&dse=true&offset=0&limit=3 Search all property-values for a URN, with DSE records for the returned objecs. If offset and limit are not used to constrain the returned results, the list of DSEs might be huge, and cause the request to timeout.
http://beta.hpcc.uh.edu/scs/texts/urn:cts:greekLit:tlg0012.tlg001.msA:1.1-1.5?dse=true Load a corpus of text, with DSE records, if any, for each citable node.

(The dse=true parameter is valid for all object-searching, as well as for retrieval of individual objects or ranges of objects.)