Versions Compared

Old Version 1

changes.mady.by.user Caleb Burch

Saved on

compared with

New Version Current

changes.mady.by.user AlexI

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

/knowledge/feature/aliasSuggest/{field}/{term}/{comma-separated-list-of-community-ids}
Info

Returns a list of alias 's sugggestions (ie alternative names for an entity) that have been found in other documents, based on your query term. Performs a gazateer lookup on the entity name submitted.

Authentication

Required, see Auth - Login

Arguments

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

term (required)
entity name The value of the entity field on which to search for aliases on. 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
Info
Code Block

{
    "response": {
        "action": "SuggestionsaliasSuggest",
        "success": true,
        "message": "suggestionsSuccessfully returned successfullyaliases",
        "time": 210
    },
    "data": {
        "dimensions": [
            {
                "dimension": "who"BARACK OBAMA",
                "value": "obama white house",
                "type": "organization",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obama-as-carter",
                "type": "person",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obama-as-reagan",
                "type": "person",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obama] administration",
                "type": "organization",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obama--has",
                "type": "person",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obama administrations",
                "type": "organization",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obama administra­tion",
                "type": "organization",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obama-biden administration",
                "type": "organization",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obamamaniacs",
                "type": "person",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            },
            {
                "dimension": "who",
                "value": "obama-petraeus",
                "type": "person",
                "groupids": [
                    "4c927585d591d31d7b37097a"
                ]
            }
        ]
    }
}

...

"Barack Obama"
    ]
}