ParallelDots
============



Uses ParallelDots AI to process or compare text for a variety of features.
See the API documentation, at
http://apis.paralleldots.com/text_docs/index.html

Terms of use: https://www.paralleldots.com/terms-and-conditions



.. toctree::
    :maxdepth: 2
    :titlesonly:
    :caption: RPC Categories





RPCS
----

.. function:: ParallelDots.getAbuse(text: String)

    Classify the given text as ``abusive``, ``hate_speech``, or ``neither``.
    The returned structured data has confidence levels for each of these categories.

    **Arguments:**

    - ``text: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - text to analyze

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - structured data containing the confidence levels


.. function:: ParallelDots.getEmotion(text: String)

    Find the emotion in the given text.
    This is returned as structured data containing confidence levels for each of the following emotions:
    ``excited``, ``angry``, ``bored``, ``fear``, ``sad``, and ``happy``.

    **Arguments:**

    - ``text: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - text to analyze

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - structured data with confidence levels for each emotion


.. function:: ParallelDots.getIntent(text: String)

    Get the intent of the given text along with the confidence score.
    This is returned as structured data with confidence levels for each of the following intents:
    ``news``, ``query``, ``spam``, ``marketing``, and ``feedback``.

    **Arguments:**

    - ``text: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - text to analyze

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - structured data with confidence levels for each intent


.. function:: ParallelDots.getKeywords(text: String)

    Extract keywords from the given text along with their confidence score.

    **Arguments:**

    - ``text: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - text to analyze

    **Returns:** ``List`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - information about keywords in the text


.. function:: ParallelDots.getNamedEntities(text: String)

    Identify named entities in the given text.

    **Arguments:**

    - ``text: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - text to analyze

    **Returns:** ``List`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - speculated information about named entities in the text, including the confidence level


.. function:: ParallelDots.getSarcasmProbability(text: String)

    Compute the probability of sarcasm for the given text.

    **Arguments:**

    - ``text: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - text to analyze

    **Returns:** ``BoundedNumber<0, 1>`` (`BoundedNumber </docs/fundamentals/rpc-arg-types.html#BoundedNumber>`__) - predicted likelihood that the text is sarcastic


.. function:: ParallelDots.getSentiment(text: String)

    Find the overall sentiment of the given text along with the confidence score.
    The returned structured data hasa confidence level for each of the following sentiment categories:
    ``negative``, ``neutral``, and ``positive``.

    **Arguments:**

    - ``text: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - text to analyze

    **Returns:** ``Object`` (`Object </docs/fundamentals/rpc-arg-types.html#Object>`__) - structured data with confidence level for each category


.. function:: ParallelDots.getSimilarity(text1: String, text2: String)

    Get the level of similarity between two snippets of text.
    Note that the two pieces of text should be long, like full sentences (not just 2 words).

    **Arguments:**

    - ``text1: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - the first piece of text
    - ``text2: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - a second piece of text

    **Returns:** ``BoundedNumber<0, 1>`` (`BoundedNumber </docs/fundamentals/rpc-arg-types.html#BoundedNumber>`__) - the computed similarity level


.. function:: ParallelDots.getTaxonomy(text: String)

    Classify the given text into IAB categories.
    
    For more information about IAB categories, see
    https://www.iab.com/guidelines/iab-quality-assurance-guidelines-qag-taxonomy/

    **Arguments:**

    - ``text: String`` (`String </docs/fundamentals/rpc-arg-types.html#String>`__) - text to analyze

    **Returns:** ``List`` (`List </docs/fundamentals/rpc-arg-types.html#List>`__) - information about the category breakdown, along with confidence scores