piazza v0.1.4

piazza-api

piazza-api provides a node.js wrapper for performing all calls to the piazza API

Installing

npm install piazza

Usage

Require and Initialize

var Piazza = require('piazza');
var S = new Sable({
    server: SEE_PRIVATE_REPO_FOR_URL,
    auth: SEE_PRIVATE_REPO_FOR_AUTH
});

var C = new Concept({
    server: SEE_PRIVATE_REPO_FOR_URL,
    auth: SEE_PRIVATE_REPO_FOR_AUTH
});

Concept Functions

Multiple info -- finds info on multiple concepts

Label Search - finds concepts which text match a label

code

C.labelSearch('Analytics', function(err, concepts) {
    console.log('concepts');		   
});

response

[ { id: string,
    abstract: string,
    label: string,
    type: string,
    link: string } ,
    .....
]

Related - finds other concepts related to a concept

code

C.related({concepts:['Analytics']}, function(err, result) {
    console.log('result');				    
});

response

[ { id: string,
    kb: string,
    score: number } ,
    .....
]

Concept Distance - finds relational distance between two concepts

code

C.conceptDistance({source:'Analytics', target:'Machine_learning' }, function(err, result) {
    console.log('result');				    
});

response

[ { id: string,
    kb: string,
    score: number,
    source: string,
    target: string }
]

Concept Web - creates web/graph of concepts and associated scores... with info

Code

C.conceptWeb(['Analytics', 'Machine_learning', 'Data_mining'], function(err, result) {
    console.log('result');				    
});

response

{ concepts: [
   { id: string,
     name: string,
     .......,
     related: [
     	{
	  id: name
	  score: number
	},
	{
	  id: name
	  score: number
	}
     ]
   },
   .....
  ]
}

Sable Functions

List ids - lists ids within a domain

code

S.listIds({domain: 'mydomain'}, function(err, ids) {
    console.log(ids);	 
});

response

[ array of strings ]

Add Searchable - adds Searchable and sources to be indexed and annotated

code

S.add({
    domain: 'mydomain',
    id: 'foo',
    label: 'Foo',
    sources: {
        sourceA: "Works at IBM near New York City",
	sourceB: "Research Staff Member"
    }, function(err, response) {
          console.log(response);
});

response

{ responseCode: 201 }

Semantic Search - finds Searchables within domain

code

S.semanticSearch({ domain: 'mydomain',
		   ids: ['New York'],
	function(err, response) {
	    console.log(response);
});

response

type semanticResult struct {
     concepts	    array Concept objects
     results	    	  array of Searchables matched
}

Get State - get state of added Searchable

code

S.getState('mydomain', 'sableId', function(err, state) {
    console.log(state);    
});

response

{ stage: string,
  status: string,
  timestamp: string }

Relscore - computes relational score between Searchable and array of concpts

code

S.relScore({ domain: 'mydomain',
	     id: 'foo'',
	     concepts: ['Watson_(computer)', 'Business_Intelligence'] },
	 function(err, result) {
	     console.log(result);
});

response

{score: number}

name - description

code

response