docs(personality-insights): Add newest generated code docs

lpatino10 · lpatino10 · commit 8303306c09a7 · 2018-04-17T14:24:52.000-04:00
diff --git a/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/PersonalityInsights.java b/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/PersonalityInsights.java
@@ -24,36 +24,19 @@
 import com.ibm.watson.developer_cloud.util.Validator;
 
 /**
- * ### Service Overview
- * The IBM Watson Personality Insights service provides a Representational State Transfer (REST) Application Programming
- * Interface (API) that 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 report consumption preferences based on the results of its
- * analysis, and for JSON content that is timestamped, it can report temporal behavior.
- * ### API Usage
- * The following information provides details about using the service to obtain a personality profile:
- * * **The profile method:** The service offers a single `/v3/profile` method that accepts up to 20 MB of input data and
- * produces results in JSON or CSV format. The service accepts input in Arabic, English, Japanese, Korean, or Spanish
- * and can produce output in a variety of languages.
- * * **Authentication:** You authenticate to the service by using your service credentials. You can use your credentials
- * to authenticate via a proxy server that resides in IBM Cloud, or you can use your credentials to obtain a token and
- * contact the service directly. See [Service credentials for Watson
- * services](https://console.bluemix.net/docs/services/watson/getting-started-credentials.html) and [Tokens for
- * authentication](https://console.bluemix.net/docs/services/watson/getting-started-tokens.html).
- * * **Request Logging:** By default, all Watson services log requests and their results. Data is collected only to
- * improve the Watson services. If you do not want to share your data, set the header parameter
- * `X-Watson-Learning-Opt-Out` to `true` for each request. Data is collected for any request that omits this header. See
- * [Controlling request logging for Watson
- * services](https://console.bluemix.net/docs/services/watson/getting-started-logging.html).
+ * 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.
  *
- * For more information about the service, see [About Personality
- * Insights](https://console.bluemix.net/docs/services/personality-insights/index.html). For information about calling
- * the service and the responses it can generate, see [Requesting a
- * profile](https://console.bluemix.net/docs/services/personality-insights/input.html), [Understanding a JSON
- * profile](https://console.bluemix.net/docs/services/personality-insights/output.html), and [Understanding a CSV
- * profile](https://console.bluemix.net/docs/services/personality-insights/output-csv.html).
+ * 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://console.bluemix.net/docs/services/personality-insights/models.html). For information
+ * about the meaning of the consumption preferences, see [Consumption
+ * preferences](https://console.bluemix.net/docs/services/personality-insights/preferences.html).
  *
  * @version v3
  * @see <a href="http://www.ibm.com/watson/developercloud/personality-insights.html">Personality Insights</a>
@@ -96,13 +79,23 @@ public PersonalityInsights(String versionDate, String username, String password)
   }
 
   /**
-   * Generates a personality profile based on input text.
+   * Get profile.
    *
-   * Derives personality insights for up to 20 MB of input content written by an author, though the service requires
-   * much less text to produce an accurate profile; for more information, see [Providing sufficient
-   * input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). Accepts input in
-   * Arabic, English, Japanese, Korean, or Spanish and produces output in one of eleven languages. Provide plain text,
-   * HTML, or JSON content, and receive results in JSON or CSV format.
+   * 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; for more information, see [Providing
+   * sufficient input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). The
+   * service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of
+   * languages. You can provide plain text, HTML, or JSON input by specifying the **Content-Type** parameter; the
+   * default is `text/plain`. Request a JSON or comma-separated values (CSV) response by specifying the **Accept**
+   * parameter; CSV output includes a fixed number of columns and optional headers. 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`. For detailed information about calling the service and the
+   * responses it can generate, see (Requesting a
+   * profile)[https://console.bluemix.net/docs/services/personality-insights/input.html], (Understanding a JSON
+   * profile)[https://console.bluemix.net/docs/services/personality-insights/output.html], and (Understanding a CSV
+   * profile)[https://console.bluemix.net/docs/services/personality-insights/output-csv.html].
    *
    * @param profileOptions the {@link ProfileOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of {@link Profile}
@@ -134,13 +127,23 @@ public ServiceCall<Profile> profile(ProfileOptions profileOptions) {
   }
 
   /**
-   * Generates a personality profile based on input text.
+   * Get profile. as csv
    *
-   * Derives personality insights for up to 20 MB of input content written by an author, though the service requires
-   * much less text to produce an accurate profile; for more information, see [Providing sufficient
-   * input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). Accepts input in
-   * Arabic, English, Japanese, Korean, or Spanish and produces output in one of eleven languages. Provide plain text,
-   * HTML, or JSON content, and receive results in JSON or CSV format.
+   * 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; for more information, see [Providing
+   * sufficient input](https://console.bluemix.net/docs/services/personality-insights/input.html#sufficient). The
+   * service analyzes text in Arabic, English, Japanese, Korean, or Spanish and returns its results in a variety of
+   * languages. You can provide plain text, HTML, or JSON input by specifying the **Content-Type** parameter; the
+   * default is `text/plain`. Request a JSON or comma-separated values (CSV) response by specifying the **Accept**
+   * parameter; CSV output includes a fixed number of columns and optional headers. 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`. For detailed information about calling the service and the
+   * responses it can generate, see (Requesting a
+   * profile)[https://console.bluemix.net/docs/services/personality-insights/input.html], (Understanding a JSON
+   * profile)[https://console.bluemix.net/docs/services/personality-insights/output.html], and (Understanding a CSV
+   * profile)[https://console.bluemix.net/docs/services/personality-insights/output-csv.html].
    *
    * @param profileOptions the {@link ProfileOptions} containing the options for the call
    * @param includeHeaders option to have the CSV headers returned with the response
diff --git a/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/Behavior.java b/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/Behavior.java
@@ -29,7 +29,8 @@ public class Behavior extends GenericModel {
   /**
    * Gets the traitId.
    *
-   * The unique identifier of the characteristic to which the results pertain. IDs have the form `behavior_{value}`.
+   * The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form
+   * `behavior_{value}`.
    *
    * @return the traitId
    */
@@ -40,7 +41,7 @@ public String getTraitId() {
   /**
    * Gets the name.
    *
-   * The user-visible name of the characteristic.
+   * The user-visible, localized name of the characteristic.
    *
    * @return the name
    */
diff --git a/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/ConsumptionPreferences.java b/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/ConsumptionPreferences.java
@@ -28,7 +28,7 @@ public class ConsumptionPreferences extends GenericModel {
   /**
    * Gets the consumptionPreferenceId.
    *
-   * The unique identifier of the consumption preference to which the results pertain. IDs have the form
+   * The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form
    * `consumption_preferences_{preference}`.
    *
    * @return the consumptionPreferenceId
@@ -40,7 +40,7 @@ public String getConsumptionPreferenceId() {
   /**
    * Gets the name.
    *
-   * The user-visible name of the consumption preference.
+   * The user-visible, localized name of the consumption preference.
    *
    * @return the name
    */
diff --git a/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/ConsumptionPreferencesCategory.java b/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/ConsumptionPreferencesCategory.java
@@ -31,8 +31,8 @@ public class ConsumptionPreferencesCategory extends GenericModel {
   /**
    * Gets the consumptionPreferenceCategoryId.
    *
-   * The unique identifier of the consumption preferences category to which the results pertain. IDs have the form
-   * `consumption_preferences_{category}`.
+   * The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have
+   * the form `consumption_preferences_{category}`.
    *
    * @return the consumptionPreferenceCategoryId
    */
diff --git a/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/ContentItem.java b/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/ContentItem.java
@@ -21,8 +21,8 @@
 public class ContentItem extends GenericModel {
 
   /**
-   * MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed;
-   * plain text is processed as submitted.
+   * The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is
+   * analyzed; plain text is processed as submitted.
    */
   public interface Contenttype {
     /** text/plain. */
@@ -32,12 +32,12 @@ public interface Contenttype {
   }
 
   /**
-   * Language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en`
+   * The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en`
    * (English). Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. A
-   * language specified with the `Content-Type` header overrides the value of this parameter; any content items that
-   * specify a different language are ignored. Omit the `Content-Type` header to base the language on the most prevalent
-   * specification among the content items; again, content items that specify a different language are ignored. You can
-   * specify any combination of languages for the input and response content.
+   * language specified with the **Content-Type** parameter overrides the value of this parameter; any content items
+   * that specify a different language are ignored. Omit the **Content-Type** parameter to base the language on the most
+   * prevalent specification among the content items; again, content items that specify a different language are
+   * ignored. You can specify any combination of languages for the input and response content.
    */
   public interface Language {
     /** ar. */
@@ -237,7 +237,8 @@ public Builder newBuilder() {
   /**
    * Gets the content.
    *
-   * Content that is to be analyzed. The service supports up to 20 MB of content for all items combined.
+   * The content that is to be analyzed. The service supports up to 20 MB of content for all `ContentItem` objects
+   * combined.
    *
    * @return the content
    */
@@ -248,7 +249,7 @@ public String content() {
   /**
    * Gets the id.
    *
-   * Unique identifier for this content item.
+   * A unique identifier for this content item.
    *
    * @return the id
    */
@@ -259,7 +260,7 @@ public String id() {
   /**
    * Gets the created.
    *
-   * Timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch
+   * A timestamp that identifies when this content was created. Specify a value in milliseconds since the UNIX Epoch
    * (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.
    *
    * @return the created
@@ -271,8 +272,8 @@ public Long created() {
   /**
    * Gets the updated.
    *
-   * Timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX Epoch
-   * (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.
+   * A timestamp that identifies when this content was last updated. Specify a value in milliseconds since the UNIX
+   * Epoch (January 1, 1970, at 0:00 UTC). Required only for results that include temporal behavior data.
    *
    * @return the updated
    */
@@ -283,8 +284,8 @@ public Long updated() {
   /**
    * Gets the contenttype.
    *
-   * MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is analyzed;
-   * plain text is processed as submitted.
+   * The MIME type of the content. The default is plain text. The tags are stripped from HTML content before it is
+   * analyzed; plain text is processed as submitted.
    *
    * @return the contenttype
    */
@@ -295,12 +296,12 @@ public String contenttype() {
   /**
    * Gets the language.
    *
-   * Language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en`
+   * The language identifier (two-letter ISO 639-1 identifier) for the language of the content item. The default is `en`
    * (English). Regional variants are treated as their parent language; for example, `en-US` is interpreted as `en`. A
-   * language specified with the `Content-Type` header overrides the value of this parameter; any content items that
-   * specify a different language are ignored. Omit the `Content-Type` header to base the language on the most prevalent
-   * specification among the content items; again, content items that specify a different language are ignored. You can
-   * specify any combination of languages for the input and response content.
+   * language specified with the **Content-Type** parameter overrides the value of this parameter; any content items
+   * that specify a different language are ignored. Omit the **Content-Type** parameter to base the language on the most
+   * prevalent specification among the content items; again, content items that specify a different language are
+   * ignored. You can specify any combination of languages for the input and response content.
    *
    * @return the language
    */
@@ -311,7 +312,7 @@ public String language() {
   /**
    * Gets the parentid.
    *
-   * Unique ID of the parent content item for this item. Used to identify hierarchical relationships between
+   * The unique ID of the parent content item for this item. Used to identify hierarchical relationships between
    * posts/replies, messages/replies, and so on.
    *
    * @return the parentid
diff --git a/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/Profile.java b/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/Profile.java
@@ -45,8 +45,8 @@ public interface ProcessedLanguage {
   @SerializedName("word_count_message")
   private String wordCountMessage;
   private List<Trait> personality;
-  private List<Trait> values;
   private List<Trait> needs;
+  private List<Trait> values;
   private List<Behavior> behavior;
   @SerializedName("consumption_preferences")
   private List<ConsumptionPreferencesCategory> consumptionPreferences;
@@ -66,7 +66,7 @@ public String getProcessedLanguage() {
   /**
    * Gets the wordCount.
    *
-   * The number of words that were found in the input.
+   * The number of words from the input that were used to produce the profile.
    *
    * @return the wordCount
    */
@@ -89,7 +89,8 @@ public String getWordCountMessage() {
   /**
    * Gets the personality.
    *
-   * Detailed results for the Big Five personality characteristics (dimensions and facets) inferred from the input text.
+   * A recursive array of `Trait` objects that provides detailed results for the Big Five personality characteristics
+   * (dimensions and facets) inferred from the input text.
    *
    * @return the personality
    */
@@ -98,25 +99,25 @@ public List<Trait> getPersonality() {
   }
 
   /**
-   * Gets the values.
+   * Gets the needs.
    *
    * Detailed results for the Needs characteristics inferred from the input text.
    *
-   * @return the values
+   * @return the needs
    */
-  public List<Trait> getValues() {
-    return values;
+  public List<Trait> getNeeds() {
+    return needs;
   }
 
   /**
-   * Gets the needs.
+   * Gets the values.
    *
    * Detailed results for the Values characteristics inferred from the input text.
    *
-   * @return the needs
+   * @return the values
    */
-  public List<Trait> getNeeds() {
-    return needs;
+  public List<Trait> getValues() {
+    return values;
   }
 
   /**
@@ -135,7 +136,7 @@ public List<Behavior> getBehavior() {
   /**
    * Gets the consumptionPreferences.
    *
-   * If the `consumption_preferences` query parameter is `true`, detailed results for each category of consumption
+   * If the **consumption_preferences** parameter is `true`, detailed results for each category of consumption
    * preferences. Each element of the array provides information inferred from the input text for the individual
    * preferences of that category.
    *
diff --git a/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/ProfileOptions.java b/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/ProfileOptions.java
diff --git a/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/Trait.java b/personality-insights/src/main/java/com/ibm/watson/developer_cloud/personality_insights/v3/model/Trait.java

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,8 @@ public class Behavior extends GenericModel {`
`29`	`29`	`/**`
`30`	`30`	`* Gets the traitId.`
`31`	`31`	`*`
`32`		- * The unique identifier of the characteristic to which the results pertain. IDs have the form `behavior_{value}`.
	`32`	`+ * The unique, non-localized identifier of the characteristic to which the results pertain. IDs have the form`
	`33`	+ * `behavior_{value}`.
`33`	`34`	`*`
`34`	`35`	`* @return the traitId`
`35`	`36`	`*/`
`@@ -40,7 +41,7 @@ public String getTraitId() {`
`40`	`41`	`/**`
`41`	`42`	`* Gets the name.`
`42`	`43`	`*`
`43`		`- * The user-visible name of the characteristic.`
	`44`	`+ * The user-visible, localized name of the characteristic.`
`44`	`45`	`*`
`45`	`46`	`* @return the name`
`46`	`47`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ public class ConsumptionPreferences extends GenericModel {`
`28`	`28`	`/**`
`29`	`29`	`* Gets the consumptionPreferenceId.`
`30`	`30`	`*`
`31`		`- * The unique identifier of the consumption preference to which the results pertain. IDs have the form`
	`31`	`+ * The unique, non-localized identifier of the consumption preference to which the results pertain. IDs have the form`
`32`	`32`	* `consumption_preferences_{preference}`.
`33`	`33`	`*`
`34`	`34`	`* @return the consumptionPreferenceId`
`@@ -40,7 +40,7 @@ public String getConsumptionPreferenceId() {`
`40`	`40`	`/**`
`41`	`41`	`* Gets the name.`
`42`	`42`	`*`
`43`		`- * The user-visible name of the consumption preference.`
	`43`	`+ * The user-visible, localized name of the consumption preference.`
`44`	`44`	`*`
`45`	`45`	`* @return the name`
`46`	`46`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -31,8 +31,8 @@ public class ConsumptionPreferencesCategory extends GenericModel {`
`31`	`31`	`/**`
`32`	`32`	`* Gets the consumptionPreferenceCategoryId.`
`33`	`33`	`*`
`34`		`- * The unique identifier of the consumption preferences category to which the results pertain. IDs have the form`
`35`		- * `consumption_preferences_{category}`.
	`34`	`+ * The unique, non-localized identifier of the consumption preferences category to which the results pertain. IDs have`
	`35`	+ * the form `consumption_preferences_{category}`.
`36`	`36`	`*`
`37`	`37`	`* @return the consumptionPreferenceCategoryId`
`38`	`38`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,8 @@ public interface ProcessedLanguage {`
`45`	`45`	`@SerializedName("word_count_message")`
`46`	`46`	`private String wordCountMessage;`
`47`	`47`	`private List<Trait> personality;`
`48`		`- private List<Trait> values;`
`49`	`48`	`private List<Trait> needs;`
	`49`	`+ private List<Trait> values;`
`50`	`50`	`private List<Behavior> behavior;`
`51`	`51`	`@SerializedName("consumption_preferences")`
`52`	`52`	`private List<ConsumptionPreferencesCategory> consumptionPreferences;`
`@@ -66,7 +66,7 @@ public String getProcessedLanguage() {`
`66`	`66`	`/**`
`67`	`67`	`* Gets the wordCount.`
`68`	`68`	`*`
`69`		`- * The number of words that were found in the input.`
	`69`	`+ * The number of words from the input that were used to produce the profile.`
`70`	`70`	`*`
`71`	`71`	`* @return the wordCount`
`72`	`72`	`*/`
`@@ -89,7 +89,8 @@ public String getWordCountMessage() {`
`89`	`89`	`/**`
`90`	`90`	`* Gets the personality.`
`91`	`91`	`*`
`92`		`- * Detailed results for the Big Five personality characteristics (dimensions and facets) inferred from the input text.`
	`92`	+ * A recursive array of `Trait` objects that provides detailed results for the Big Five personality characteristics
	`93`	`+ * (dimensions and facets) inferred from the input text.`
`93`	`94`	`*`
`94`	`95`	`* @return the personality`
`95`	`96`	`*/`
`@@ -98,25 +99,25 @@ public List<Trait> getPersonality() {`
`98`	`99`	`}`
`99`	`100`
`100`	`101`	`/**`
`101`		`- * Gets the values.`
	`102`	`+ * Gets the needs.`
`102`	`103`	`*`
`103`	`104`	`* Detailed results for the Needs characteristics inferred from the input text.`
`104`	`105`	`*`
`105`		`- * @return the values`
	`106`	`+ * @return the needs`
`106`	`107`	`*/`
`107`		`- public List<Trait> getValues() {`
`108`		`- return values;`
	`108`	`+ public List<Trait> getNeeds() {`
	`109`	`+ return needs;`
`109`	`110`	`}`
`110`	`111`
`111`	`112`	`/**`
`112`		`- * Gets the needs.`
	`113`	`+ * Gets the values.`
`113`	`114`	`*`
`114`	`115`	`* Detailed results for the Values characteristics inferred from the input text.`
`115`	`116`	`*`
`116`		`- * @return the needs`
	`117`	`+ * @return the values`
`117`	`118`	`*/`
`118`		`- public List<Trait> getNeeds() {`
`119`		`- return needs;`
	`119`	`+ public List<Trait> getValues() {`
	`120`	`+ return values;`
`120`	`121`	`}`
`121`	`122`
`122`	`123`	`/**`
`@@ -135,7 +136,7 @@ public List<Behavior> getBehavior() {`
`135`	`136`	`/**`
`136`	`137`	`* Gets the consumptionPreferences.`
`137`	`138`	`*`
`138`		- * If the `consumption_preferences` query parameter is `true`, detailed results for each category of consumption
	`139`	+ * If the consumption_preferences parameter is `true`, detailed results for each category of consumption
`139`	`140`	`* preferences. Each element of the array provides information inferred from the input text for the individual`
`140`	`141`	`* preferences of that category.`
`141`	`142`	`*`