com.ibm.watson.personality_insights.v3.model

Class ProfileOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.personality_insights.v3.model.ProfileOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class ProfileOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The profile options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ProfileOptions.AcceptLanguage The desired language of the response.
static class	ProfileOptions.Builder Builder.
static interface	ProfileOptions.ContentLanguage The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish.

Method Summary

Modifier and Type	Method and Description
java.lang.String	acceptLanguage() Gets the acceptLanguage.
java.lang.String	body() Gets the body.
java.lang.Boolean	consumptionPreferences() Gets the consumptionPreferences.
Content	content() Gets the content.
java.lang.String	contentLanguage() Gets the contentLanguage.
java.lang.String	contentType() Gets the contentType.
java.lang.Boolean	csvHeaders() Gets the csvHeaders.
ProfileOptions.Builder	newBuilder() New builder.
java.lang.Boolean	rawScores() Gets the rawScores.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public ProfileOptions.Builder newBuilder()

New builder.

Returns:

a ProfileOptions builder

content

public Content content()

Gets the content. A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see [Providing sufficient input](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-input#sufficient). For JSON input, provide an object of type `Content`.

Returns:

the content

body

public java.lang.String body()

Gets the body. A maximum of 20 MB of content to analyze, though the service requires much less text; for more information, see [Providing sufficient input](https://cloud.ibm.com/docs/services/personality-insights?topic=personality-insights-input#sufficient). For JSON input, provide an object of type `Content`.

Returns:

the body

contentType

public java.lang.String contentType()

Gets the contentType. The type of the input. For more information, see **Content types** in the method description.

Returns:

the contentType

contentLanguage

public java.lang.String contentLanguage()

Gets the contentLanguage. The language of the input text for the request: Arabic, English, Japanese, Korean, or Spanish. Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. The effect of the **Content-Language** parameter depends on the **Content-Type** parameter. When **Content-Type** is `text/plain` or `text/html`, **Content-Language** is the only way to specify the language. When **Content-Type** is `application/json`, **Content-Language** overrides a language specified with the `language` parameter of a `ContentItem` object, and content items that specify a different language are ignored; omit this parameter to base the language on the specification of the content items. You can specify any combination of languages for **Content-Language** and **Accept-Language**.

Returns:

the contentLanguage

acceptLanguage

public java.lang.String acceptLanguage()

Gets the acceptLanguage. The desired language of the response. For two-character arguments, regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. You can specify any combination of languages for the input and response content.

Returns:

the acceptLanguage

rawScores

public java.lang.Boolean rawScores()

Gets the rawScores. Indicates whether a raw score in addition to a normalized percentile is returned for each characteristic; raw scores are not compared with a sample population. By default, only normalized percentiles are returned.

Returns:

the rawScores

csvHeaders

public java.lang.Boolean csvHeaders()

Gets the csvHeaders. Indicates whether column labels are returned with a CSV response. By default, no column labels are returned. Applies only when the response type is CSV (`text/csv`).

Returns:

the csvHeaders

consumptionPreferences

public java.lang.Boolean consumptionPreferences()

Gets the consumptionPreferences. Indicates whether consumption preferences are returned with the results. By default, no consumption preferences are returned.

Returns:

the consumptionPreferences