com.ibm.watson.developer_cloud.personality_insights.v3

Class PersonalityInsights

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.personality_insights.v3.PersonalityInsights

public class PersonalityInsights
extends WatsonService

The IBM Watson™ Personality Insights service enables applications to derive insights from social media, enterprise data, or other digital communications. The service uses linguistic analytics to infer individuals' intrinsic personality characteristics, including Big Five, Needs, and Values, from digital communications such as email, text messages, tweets, and forum posts. The service can automatically infer, from potentially noisy social media, portraits of individuals that reflect their personality characteristics. The service can infer consumption preferences based on the results of its analysis and, for JSON content that is timestamped, can report temporal behavior. * For information about the meaning of the models that the service uses to describe personality characteristics, see [Personality models](https://cloud.ibm.com/docs/services/personality-insights/models.html). * For information about the meaning of the consumption preferences, see [Consumption preferences](https://cloud.ibm.com/docs/services/personality-insights/preferences.html). **Note:** Request logging is disabled for the Personality Insights service. Regardless of whether you set the `X-Watson-Learning-Opt-Out` request header, the service does not log or retain data from requests and responses.

See Also:

Personality Insights

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
PersonalityInsights(java.lang.String versionDate) Instantiates a new `PersonalityInsights`.
PersonalityInsights(java.lang.String versionDate, IamOptions iamOptions) Instantiates a new `PersonalityInsights` with IAM.
PersonalityInsights(java.lang.String versionDate, java.lang.String username, java.lang.String password) Instantiates a new `PersonalityInsights` with username and password.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceCall<Profile>	profile(ProfileOptions profileOptions) Get profile.
ServiceCall<java.io.InputStream>	profileAsCsv(ProfileOptions profileOptions, boolean includeHeaders) Get profile as csv.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureClient, configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isJsonMimeType, isJsonPatchMimeType, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PersonalityInsights

public PersonalityInsights(java.lang.String versionDate)

Instantiates a new `PersonalityInsights`.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

PersonalityInsights

public PersonalityInsights(java.lang.String versionDate,
                   java.lang.String username,
                   java.lang.String password)

Instantiates a new `PersonalityInsights` with username and password.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

username - the username

password - the password

PersonalityInsights

public PersonalityInsights(java.lang.String versionDate,
                   IamOptions iamOptions)

Instantiates a new `PersonalityInsights` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires or after receiving a 401 error from the service. Failing to do so will result in authentication errors after this token expires.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

iamOptions - the options for authenticating through IAM

Method Detail

profile

public ServiceCall<Profile> profile(ProfileOptions profileOptions)

Get profile. Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile. The service can analyze text in Arabic, English, Japanese, Korean, or Spanish. It can return its results in a variety of languages. **See also:** * [Requesting a profile](https://cloud.ibm.com/docs/services/personality-insights/input.html) * [Providing sufficient input](https://cloud.ibm.com/docs/services/personality-insights/input.html#sufficient) ### Content types You can provide input content as plain text (`text/plain`), HTML (`text/html`), or JSON (`application/json`) by specifying the **Content-Type** parameter. The default is `text/plain`. * Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8. * Per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; for example, `Content-Type: text/plain;charset=utf-8`. **See also:** [Specifying request and response formats](https://cloud.ibm .com/docs/services/personality-insights/input.html#formats) ### Accept types You must request a response as JSON (`application/json`) or comma-separated values (`text/csv`) by specifying the **Accept** parameter. CSV output includes a fixed number of columns. Set the **csv_headers** parameter to `true` to request optional column headers for CSV output. **See also:** * [Understanding a JSON profile](https://cloud.ibm.com/docs/services/personality-insights/output.html) * [Understanding a CSV profile](https://cloud.ibm.com/docs/services/personality-insights/output-csv.html).

Parameters:

profileOptions - the ProfileOptions containing the options for the call

Returns:

a ServiceCall with a response type of Profile

profileAsCsv

public ServiceCall<java.io.InputStream> profileAsCsv(ProfileOptions profileOptions,
                                            boolean includeHeaders)

Get profile as csv. Generates a personality profile for the author of the input text. The service accepts a maximum of 20 MB of input content, but it requires much less text to produce an accurate profile. The service can analyze text in Arabic, English, Japanese, Korean, or Spanish. It can return its results in a variety of languages. **See also:** * [Requesting a profile](https://cloud.ibm.com/docs/services/personality-insights/input.html) * [Providing sufficient input](https://cloud.ibm.com/docs/services/personality-insights/input.html#sufficient) ### Content types You can provide input content as plain text (`text/plain`), HTML (`text/html`), or JSON (`application/json`) by specifying the **Content-Type** parameter. The default is `text/plain`. * Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8. * Per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; for example, `Content-Type: text/plain;charset=utf-8`. **See also:** [Specifying request and response formats](https://cloud.ibm .com/docs/services/personality-insights/input.html#formats) ### Accept types You must request a response as JSON (`application/json`) or comma-separated values (`text/csv`) by specifying the **Accept** parameter. CSV output includes a fixed number of columns. Set the **csv_headers** parameter to `true` to request optional column headers for CSV output. **See also:** * [Understanding a JSON profile](https://cloud.ibm.com/docs/services/personality-insights/output.html) * [Understanding a CSV profile](https://cloud.ibm.com/docs/services/personality-insights/output-csv.html).

Parameters:

profileOptions - the ProfileOptions containing the options for the call

includeHeaders - the boolean saying whether or not to include headers in the response

Returns:

a ServiceCall with a response type of InputStream