PersonalityInsights (ibm-watson 9.0.0 API)

java.lang.Object
- com.ibm.cloud.sdk.core.service.BaseService
- - com.ibm.watson.personality_insights.v3.PersonalityInsights

```
public class PersonalityInsights
extends com.ibm.cloud.sdk.core.service.BaseService
```
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/personality-insights?topic=personality-insights-models#models). * For information about the meaning of the consumption preferences, see [Consumption preferences](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-preferences#preferences).
**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
Modifier and Type Field and Description

static java.lang.String DEFAULT_SERVICE_NAME

static java.lang.String DEFAULT_SERVICE_URL
- Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService
  JSON_MIME_PATTERN, JSON_PATCH_MIME_PATTERN, PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_URL

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEFAULT_SERVICE_NAME`
`static java.lang.String`	`DEFAULT_SERVICE_URL`

Constructor Summary

Constructors
Constructor and Description
`PersonalityInsights(java.lang.String version)` Constructs an instance of the `PersonalityInsights` client.
`PersonalityInsights(java.lang.String version, com.ibm.cloud.sdk.core.security.Authenticator authenticator)` Constructs an instance of the `PersonalityInsights` client.
`PersonalityInsights(java.lang.String version, java.lang.String serviceName)` Constructs an instance of the `PersonalityInsights` client.
`PersonalityInsights(java.lang.String version, java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)` Constructs an instance of the `PersonalityInsights` client.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getVersion()` Gets the version.
`com.ibm.cloud.sdk.core.http.ServiceCall<Profile>`	`profile(ProfileOptions profileOptions)` Get profile.
`com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream>`	`profileAsCsv(ProfileOptions profileOptions)` Get profile as csv.
`void`	`setVersion(java.lang.String version)` Sets the version.

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService
configureClient, configureHttpClient, configureService, createServiceCall, enableGzipCompression, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, processServiceCall, setAuthentication, setClient, setDefaultHeaders, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_SERVICE_NAME
```
public static final java.lang.String DEFAULT_SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SERVICE_URL
```
public static final java.lang.String DEFAULT_SERVICE_URL
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PersonalityInsights
```
public PersonalityInsights(java.lang.String version)
```
    Constructs an instance of the `PersonalityInsights` client. The default service name is used to configure the client instance.
    
    Parameters:
    
    version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2017-10-13`.
  - PersonalityInsights
```
public PersonalityInsights(java.lang.String version,
                           com.ibm.cloud.sdk.core.security.Authenticator authenticator)
```
    Constructs an instance of the `PersonalityInsights` client. The default service name and specified authenticator are used to configure the client instance.
    
    Parameters:
    
    version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2017-10-13`.
    
    authenticator - the Authenticator instance to be configured for this client
  - PersonalityInsights
```
public PersonalityInsights(java.lang.String version,
                           java.lang.String serviceName)
```
    Constructs an instance of the `PersonalityInsights` client. The specified service name is used to configure the client instance.
    
    Parameters:
    
    version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2017-10-13`.
    
    serviceName - the service name to be used when configuring the client instance
  - PersonalityInsights
```
public PersonalityInsights(java.lang.String version,
                           java.lang.String serviceName,
                           com.ibm.cloud.sdk.core.security.Authenticator authenticator)
```
    Constructs an instance of the `PersonalityInsights` client. The specified service name and authenticator are used to configure the client instance.
    
    Parameters:
    
    version - Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2017-10-13`.
    
    serviceName - the service name to be used when configuring the client instance
    
    authenticator - the Authenticator instance to be configured for this client
- Method Detail
  - getVersion
```
public java.lang.String getVersion()
```
    Gets the version.
    Release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format. The current version is `2017-10-13`.
    
    Returns:
    
    the version
  - setVersion
```
public void setVersion(java.lang.String version)
```
    Sets the version.
    
    Parameters:
    
    version - the new version
  - profile
```
public com.ibm.cloud.sdk.core.http.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/personality-insights?topic=personality-insights-input#input) * [Providing sufficient input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#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/personality-insights?topic=personality-insights-input#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/personality-insights?topic=personality-insights-output#output) * [Understanding a CSV profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-outputCSV#outputCSV).
    
    Parameters:
    
    profileOptions - the ProfileOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a result of type Profile
  - profileAsCsv
```
public com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> profileAsCsv(ProfileOptions profileOptions)
```
    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/personality-insights?topic=personality-insights-input#input) * [Providing sufficient input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#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/personality-insights?topic=personality-insights-input#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/personality-insights?topic=personality-insights-output#output) * [Understanding a CSV profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-outputCSV#outputCSV).
    
    Parameters:
    
    profileOptions - the ProfileOptions containing the options for the call
    
    Returns:
    
    a ServiceCall with a result of type String

Class PersonalityInsights

Field Summary

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

Constructor Summary

Method Summary

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SERVICE_NAME

DEFAULT_SERVICE_URL

Constructor Detail

PersonalityInsights

PersonalityInsights

PersonalityInsights

PersonalityInsights

Method Detail

getVersion

setVersion

profile

profileAsCsv