Places

places(data, [api_key], [cloud], [threshold])
Identify references to specific places found in a document.

Current Version: 2

Arguments

data – String | List – required – text to be analyzed
[api_key] – String – optional – your indico API key
[cloud] – String – optional – your private cloud subdomain
[v or version] – Integer – optional (defaults to 2) – specify model version
[threshold] – Float (defaults to 0.01) – optional – only return named entities with likelihood greater than this number

Output

This function will return a list of dictionaries of three key-value pairs. Each dictionary represents a substring from the input document that the model has predicted is a place, with confidence greater than your threshold. Each dictionary has three keys: text, confidence, and position. The text key maps to a substring from the document that is predicted to be a place. The confidence key maps to a float between 0 and 1, representing how confident the model is that the text is a place. The position key maps to a two element list with the start character position and end character position of text in the input document.

# single output
[
    {
        'text': 'London',
        'confidence':  0.913224,
        'position':  [0, 6]
    }
]

# batch output
[
    [
        {
            'text': 'London',
            'confidence':  0.913224,
            'position':  [0, 6]
        }
    ],
        [
        {
            'text': 'London',
            'confidence':  0.913224,
            'position':  [0, 6]
        }
    ]
]

Example

import indicoio
indicoio.config.api_key = 'YOUR_API_KEY'

# single example
indicoio.places("London Underground's boss Mike Brown warned that the strike ...")

# batch example
indicoio.places([
    "London Underground's boss Mike Brown warned that the strike ...",
    "London Underground's boss Mike Brown warned that the strike ..."
])