sasctl.services.sentiment_analysis#

class sasctl._services.sentiment_analysis.SentimentAnalysis[source]#

Bases: Service

The Sentiment Analysis API is used to perform sentiment analysis on natural language text documents according to a prebuilt or user-defined model.

Methods

analyze_sentiment(documents[, caslib, ...])

Performs sentiment analysis on the input data.

delete(*args, **kwargs)

Send a DELETE request.

get(*args, **kwargs)

Send a GET request.

get_link(obj, rel)

Get link information from a resource.

head(*args, **kwargs)

Send a HEAD request.

info()

Version and build information for the service.

is_available()

Check if the service is currently available.

post(*args, **kwargs)

Send a POST request.

put(*args, **kwargs)

Send a PUT request.

request(verb, path[, session, format_])

Send an HTTP request with a session.

request_link(obj, rel, **kwargs)

Request a link from a resource.

is_uuid

classmethod analyze_sentiment(documents, caslib=None, id_column=None, text_column=None, description=None, model=None, output_postfix=None, language='en')[source]#

Performs sentiment analysis on the input data.

Creates a setiment analysis task that executes asynchronously. There are two different interactions for sentiment analysis: analyzing documents in CAS tables and analyzing documents that are uploaded directly.

Parameters:
documentsstr or dict or list_like:

Documents to analyze. May be either the URI to a CAS table where the documents are currently stored, or an iterable of strings containing the documents’ text.

caslibstr or dict, optional

URI of a caslib in which the documents will be stored. Required if documents is a list of strings.

id_columnstr, optional

The column in documents that contains a unique id for each document. Required if documents is a CAS table URI.

text_columnstr, optional

The column in documents that contains the document text to analyze. Required if documents is a CAS table URI.

descriptionstr, optional

Description to add to the sentiment analysis job.

model
output_postfixstr, optional

Text to be added to the end of all output table names.

languagestr, optional

Two letter ISO 639-1 code indicating the source language. Defaults to ‘en’.

Returns:
RestObj

The submitted job

See also

cas_management.get_caslib
cas_management.get_table