Semantic Signature® Call

Service Call:
http://api.semantichacker.com/TOKEN/signature[/ConfigurationID]?

Overview

The signature service call analyzes the content provided in the call and returns a Semantic Signature®. The returned Semantic Signature® can be used for a variety of applications such as matching, similarity search, tagging and categorization of content.

The signature service allows for an optional configuration ID to be provided at the end of the request path. View the Service Configurations page for more information.

Signature Call Parameters

In addition to the common request parameters, the signature call has the following optional parameters.

Name Value Required
(Yes/No)		 Usage Notes
format 'xml','json', or 'rdf' No In addition to JSON and XML, the signature service supports the RDF ('rdf') output format. NOTE: the 'externalId' parameter is required when using the RDF output format.
showLabels 'true' or 'false' No Can be used to indicate whether or not the response should include dimension labels or dimension numeric IDs. The default is 'false', and the response will only have dimension numeric IDs. Using numeric IDs and extracting labels locally from a labels file can save a significant amount of bandwidth and is highly recommended. Labels files for all configurations can be found on our Service Configurations page.
includeCacheInfo None Required No The system may cache results for frequently processed URIs. To see if the signature in a response came from cache add the 'includeCacheInfo' parameter to the request. The 'includeCacheInfo' parameter is just a switch, no value is required. If 'includeCacheInfo' is added to the request parameters, the 'fromCache' field will be included in the response with a value of 'true' or 'false' and the 'resultCreationTimestamp' field will be included with a timestamp value in milliseconds since the epoch (January 1, 1970 UTC).

XML Response Example

http://api.semantichacker.com/TOKEN/signature?uri=http%3a%2f%2fwww.nfl.com

<?xml version="1.0" encoding="UTF-8"?>
<response xmlns="http://www.semantichacker.com/api">
        <about>
                <requestId>15CABD8705457B3ADE70BB5B15B00E24</requestId>
                <docId>12B9CC519FA32800883C988C03ED726A</docId>
                <systemType>signature</systemType>
                <configId>odp_2007_l1_1.7k</configId>
                <contentType>text/html</contentType>
                <contentDigest>D2E55B7DE02181F6E7C988EED40AD67C</contentDigest>
                <requestDate>2011-08-30T19:25:25+00:00</requestDate>
                <systemVersion>2.1</systemVersion>
                <sourceUri>http://www.nfl.com</sourceUri>
        </about>
        <siggen>
                <siggenResponse>
                        <signature>
                                <dimension weight="0.7467229" index="1711"  />
                                <dimension weight="0.43940154" index="543"  />
                                ...
                                ...
                                ...
                                <dimension weight="0.03876335" index="1767"  />
                                <dimension weight="0.037602082" index="1754"  />
                        </signature>
                </siggenResponse>
        </siggen>
</response>

JSON Response Example

http://api.semantichacker.com/TOKEN/signature?uri=http%3a%2f%2fwww.nfl.com&format=JSON

{
    "about":     {
        "requestId": "46F2E70B578A4CFA76A6F76E9FA44D38",
        "docId": "12B9CC519FA32800883C988C03ED726A",
        "systemType": "signature",
        "configId": "odp_2007_l1_1.7k",
        "contentType": "text/html",
        "contentDigest": "D2E55B7DE02181F6E7C988EED40AD67C",
        "requestDate": "2011-08-30T19:28:06+00:00",
        "systemVersion": "2.1",
        "sourceUri": "http://www.nfl.com"
    },
    "siggen": {"siggenResponse": {"signature":     [
                {
            "weight": "0.7467229",
            "index": "1711"
        },
                {
            "weight": "0.43940154",
            "index": "543"
        },
        ...
        ...
        ...
                {
            "weight": "0.03876335",
            "index": "1767"
        },
                {
            "weight": "0.037602082",
            "index": "1754"
        }
    ]}}
}

RDF Response Example

http://api.semantichacker.com/TOKEN/signature?uri=http%3a%2f%2fwww.nfl.com&format=rdf&externalId=000001

<rdf:RDF
    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
    xmlns:twtype="http://s.textwise.com/1.0/type#"
    xmlns:dc="http://purl.org/dc/elements/1.1/"
    xmlns:tw="http://s.textwise.com/1.0/pred#" > 
  <rdf:Description rdf:about="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#DocInfo"/>
    <tw:externalId>000001</tw:externalId>
    <tw:sourceUrl>http://www.nfl.com</tw:sourceUrl>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/meta">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#DocInfoMeta"/>
    <tw:docId rdf:resource="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9"/>
    <tw:configId>odp_2007_l1_1.7k</tw:configId>
    <tw:tagSpaceLanguage>en_US</tw:tagSpaceLanguage>
    <tw:tagSpace>http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension</tw:tagSpace>
    <tw:systemVersion>2.1</tw:systemVersion>
    <tw:contentType>text/html</tw:contentType>
    <tw:requestDate>2011-08-30T19:36:09+00:00</tw:requestDate>
    <tw:contentDigest>F143D3121B579551ECCEF1423F24A7A9</tw:contentDigest>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/Signature">
    <tw:docId rdf:resource="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9"/>
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Signature"/>
    <tw:dimensions rdf:nodeID="A0"/>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension/1711">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Dimension"/>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/Instance/1">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Instance"/>
    <tw:subject rdf:resource="http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension/1711"/>
    <tw:weight>0.7467229</tw:weight>
  </rdf:Description>
  <rdf:Description rdf:nodeID="A0">
    <rdf:rest rdf:nodeID="A1"/>
    <rdf:first rdf:resource="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/Instance/1"/>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension/543">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Dimension"/>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/Instance/2">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Instance"/>
    <tw:subject rdf:resource="http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension/543"/>
    <tw:weight>0.43940154</tw:weight>
  </rdf:Description>
  ...
  ...
  ...
  <rdf:Description rdf:about="http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension/1767">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Dimension"/>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/Instance/29">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Instance"/>
    <tw:subject rdf:resource="http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension/1767"/>
    <tw:weight>0.03876335</tw:weight>
  </rdf:Description>
  <rdf:Description rdf:nodeID="A28">
    <rdf:rest rdf:nodeID="A29"/>
    <rdf:first rdf:resource="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/Instance/29"/>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension/1754">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Dimension"/>
  </rdf:Description>
  <rdf:Description rdf:about="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/Instance/30">
    <rdf:type rdf:resource="http://s.textwise.com/1.0/type#Instance"/>
    <tw:subject rdf:resource="http://d.textwise.com/1.0/element/odp_2007_l1_1.7k/en_US/dimension/1754"/>
    <tw:weight>0.037602082</tw:weight>
  </rdf:Description>
  <rdf:Description rdf:nodeID="A29">
    <rdf:rest rdf:resource="http://www.w3.org/1999/02/22-rdf-syntax-ns#nil"/>
    <rdf:first rdf:resource="http://d.textwise.com/1.0/dochash/36004d4e-ef9f-d89b-da55-36eed8bfa5a9/Instance/30"/>
  </rdf:Description>
</rdf:RDF>

Signature Tools

Semantic Signatures® can be related mathematically, and additional Tools are provided to aid in accessing the API and using the resulting signatures to perform the following tasks: