Skip to content

Commit 28855ed

Browse files
Merge pull request #390 from watson-developer-cloud/codegen/personality-insights
Regenerate Personality Insights
2 parents d351a19 + d226c9e commit 28855ed

1 file changed

Lines changed: 4 additions & 34 deletions

File tree

watson_developer_cloud/personality_insights_v3.py

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# coding: utf-8
22

3-
# Copyright 2017 IBM All Rights Reserved.
3+
# Copyright 2018 IBM All Rights Reserved.
44
#
55
# Licensed under the Apache License, Version 2.0 (the "License");
66
# you may not use this file except in compliance with the License.
@@ -15,44 +15,14 @@
1515
# limitations under the License.
1616
"""
1717
### Service Overview
18-
The IBM Watson Personality Insights service provides a Representational State Transfer
19-
(REST) Application Programming Interface (API) that enables applications to derive
18+
The IBM Watson Personality Insights service enables applications to derive
2019
insights from social media, enterprise data, or other digital communications. The service
2120
uses linguistic analytics to infer individuals' intrinsic personality characteristics,
2221
including Big Five, Needs, and Values, from digital communications such as email, text
2322
messages, tweets, and forum posts. The service can automatically infer, from potentially
2423
noisy social media, portraits of individuals that reflect their personality
2524
characteristics. The service can report consumption preferences based on the results of
2625
its analysis, and for JSON content that is timestamped, it can report temporal behavior.
27-
### API Usage
28-
The following information provides details about using the service to obtain a personality
29-
profile:
30-
* **The profile method:** The service offers a single `/v3/profile` method that accepts up
31-
to 20 MB of input data and produces results in JSON or CSV format. The service accepts
32-
input in Arabic, English, Japanese, Korean, or Spanish and can produce output in a variety
33-
of languages.
34-
* **Authentication:** You authenticate to the service by using your service credentials.
35-
You can use your credentials to authenticate via a proxy server that resides in Bluemix,
36-
or you can use your credentials to obtain a token and contact the service directly. See
37-
[Service credentials for Watson
38-
services](https://console.bluemix.net/docs/services/watson/getting-started-credentials.html)
39-
and [Tokens for
40-
authentication](https://console.bluemix.net/docs/services/watson/getting-started-tokens.html).
41-
* **Request Logging:** By default, all Watson services log requests and their results.
42-
Data is collected only to improve the Watson services. If you do not want to share your
43-
data, set the header parameter `X-Watson-Learning-Opt-Out` to `true` for each request.
44-
Data is collected for any request that omits this header. See [Controlling request logging
45-
for Watson
46-
services](https://console.bluemix.net/docs/services/watson/getting-started-logging.html).
47-
48-
For more information about the service, see [About Personality
49-
Insights](https://console.bluemix.net/docs/services/personality-insights/index.html). For
50-
information about calling the service and the responses it can generate, see [Requesting a
51-
profile](https://console.bluemix.net/docs/services/personality-insights/input.html),
52-
[Understanding a JSON
53-
profile](https://console.bluemix.net/docs/services/personality-insights/output.html), and
54-
[Understanding a CSV
55-
profile](https://console.bluemix.net/docs/services/personality-insights/output-csv.html).
5626
"""
5727

5828
from __future__ import absolute_import
@@ -733,7 +703,7 @@ class Trait(object):
733703
:attr str category: The category of the characteristic: * `personality` for Big Five personality characteristics * `needs` for Needs * `values` for Values.
734704
:attr float percentile: The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the population and less open than 39 percent of the population.
735705
:attr float raw_score: (optional) The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall scores and their range. The raw score is computed based on the input and the service model; it is not normalized or compared with a sample population. The raw score enables comparison of the results against a different sampling population and with a custom normalization approach.
736-
:attr bool significant: (optional) **`2017-10-13`**: Indicates whether the characteristic is meaningful for the input language. The field is always `true` for all characteristics of English, Spanish, and Japanese input. The field is `false` for the subset of characteristics of Arabic and Korean input for which the service's models are unable to generate meaningful results. **`2016-10-20`**: Not returned.
706+
:attr bool significant: (optional) **`2017-10-13`**: Indicates whether the characteristic is meaningful for the input language. The field is always `true` for all characteristics of English, Spanish, and Japanese input. The field is `false` for the subset of characteristics of Arabic and Korean input for which the service's models are unable to generate meaningful results. **`2016-10-19`**: Not returned.
737707
:attr list[Trait] children: (optional) For `personality` (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from the input text.
738708
"""
739709

@@ -753,7 +723,7 @@ def __init__(self,
753723
:param str category: The category of the characteristic: * `personality` for Big Five personality characteristics * `needs` for Needs * `values` for Values.
754724
:param float percentile: The normalized percentile score for the characteristic. The range is 0 to 1. For example, if the percentage for Openness is 0.60, the author scored in the 60th percentile; the author is more open than 59 percent of the population and less open than 39 percent of the population.
755725
:param float raw_score: (optional) The raw score for the characteristic. The range is 0 to 1. A higher score generally indicates a greater likelihood that the author has that characteristic, but raw scores must be considered in aggregate: The range of values in practice might be much smaller than 0 to 1, so an individual score must be considered in the context of the overall scores and their range. The raw score is computed based on the input and the service model; it is not normalized or compared with a sample population. The raw score enables comparison of the results against a different sampling population and with a custom normalization approach.
756-
:param bool significant: (optional) **`2017-10-13`**: Indicates whether the characteristic is meaningful for the input language. The field is always `true` for all characteristics of English, Spanish, and Japanese input. The field is `false` for the subset of characteristics of Arabic and Korean input for which the service's models are unable to generate meaningful results. **`2016-10-20`**: Not returned.
726+
:param bool significant: (optional) **`2017-10-13`**: Indicates whether the characteristic is meaningful for the input language. The field is always `true` for all characteristics of English, Spanish, and Japanese input. The field is `false` for the subset of characteristics of Arabic and Korean input for which the service's models are unable to generate meaningful results. **`2016-10-19`**: Not returned.
757727
:param list[Trait] children: (optional) For `personality` (Big Five) dimensions, more detailed results for the facets of each dimension as inferred from the input text.
758728
"""
759729
self.trait_id = trait_id

0 commit comments

Comments
 (0)