Knowledge - Feature - Alias Suggest

Owned by Caleb Burch (Unlicensed)
Last updated: Mar 07, 2012 by AlexI (Unlicensed)Version comment
1 min read
/knowledge/feature/aliasSuggest/{field}/{term}/{comma-separated-list-of-community-ids}

Returns a list of alias sugggestions (ie alternative names for an entity) that have been found in other documents, based on your query term.

Authentication

Required, see Auth - Login

Arguments

field (required)
The entity field on which to search, ie "index", "disambiguated_name", or "actual_name"

term (required)
The value of the entity field on which to search for aliases. Note this needs to be URL-escaped, eg "/" in the "index" would be represented by "%2F"

community id list (required)
The list of community IDs or community ID - regex in the URL controls which sources the query will use. Obviously the logged-in user must have access rights to those communities. A user's communities can be viewed using the "person/get" API call.

Example

http://infinite.ikanow.com/api/knowledge/feature/aliasSuggest/index/barack obama%2Fperson/4c927585d591d31d7b37097a,4db5c05fb246d25364aceca0
http://infinite.ikanow.com/api/knowledge/feature/aliasSuggest/disambiguated_name/barack obama/4c927585d591d31d7b37097a,4db5c05fb246d25364aceca0
http://infinite.ikanow.com/api/knowledge/feature/aliasSuggest/actual_name/Barry%20Obama/4c927585d591d31d7b37097a,4db5c05fb246d25364aceca0

Example Response
{
    "response": {
        "action": "aliasSuggest",
        "success": true,
        "message": "Successfully returned aliases",
        "time": 0
    },
    "data": [
        "BARACK OBAMA",
        "Barack Obama"
    ]
}