WS-3151: fix description, fix example

Author: Adam Soos

examples/record_similarity.py

@@ -91,8 +91,6 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     params["properties"] = properties
     params["records"] = records
 
-    #params["parameters"] = {"conflictScore": "0.9", "deletionScore": "0.2"}
-
     try:
         return api.record_similarity(params)
     except RosetteException as exception:
@@ -107,6 +105,6 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
                     default='https://api.rosette.com/rest/v1/')
 
 if __name__ == '__main__':
-    # ARGS = PARSER.parse_args()
-    RESULT = run("key", "http://localhost:8181/rest/v1/")
+    ARGS = PARSER.parse_args()
+    RESULT = run(ARGS.key, ARGS.url)
     print(RESULT)

rosette/api.py

@@ -348,9 +348,10 @@ def validate(self):
 class RecordSimilarityParameters(_RequestParametersBase):
     """Parameter object for C{record-similarity} endpoint.
     Required:
-    C{records} A list of C{record} objects
-    C{properties} A C{property} object
-    C{fields} A dictionary of C{field} objects
+    C{records} The records to be compared; where each left record is compared to the associated right record.
+    C{properties} Parameters used in the call
+    C{fields} The definition of the fields used in the comparison. There must be a minimum of 1 field and
+    can have a maximum of 5 fields.
     """
 
     def __init__(self):