Removed entities/linked (#59)

* Removed entities/linked

- Removed example
- Removed resolve_entities parameter and check
- Updated README
- tests pass

* Removed unnecessary doc directory

- updated .gitignore to ignore doc/ directory

* Removed linked entities in comment

Author: cp2boston

.gitignore

@@ -23,6 +23,7 @@ __pycache__/
 
 # Distribution / packaging
 .Python
+doc/
 env/
 build/
 develop-eggs/

README.md

@@ -65,7 +65,7 @@ The samples use the following procedure:
  `NameSimilarityParameters`; Other parameters are optional.
 
 6. Invoke the `API` method for the endpoint you are calling. The methods are
-    * `entities(linked)` where `linked` is `False` for entity extraction and `True` for entity linking.
+    * `entities()` 
     * `categories()`
     * `sentiment()`
     * `language()`

doc/api.html

@@ -24,7 +24,6 @@ Each example, when run, prints its output to the console.
 | -------------                 |-------------                                        | 
 | categories.py                    | Gets the category of a document at a URL              | 
 | entities.py                      | Gets the entities from a piece of text                | 
-| entities_linked.py               | Gets the linked (to Wikipedia) entities from a piece of text |
 | info.py                          | Gets information about Rosette API                    | 
 | language.py                      | Gets the language of a piece of text                  | 
 | matched-name.py                  | Gets the similarity score of two names                | 

examples/README.md

@@ -777,23 +777,16 @@ def morphology(self, parameters, facet=MorphologyOutput.COMPLETE):
         @return: A python dictionary containing the results of morphological analysis."""
         return EndpointCaller(self, "morphology/" + facet).call(parameters)
 
-    def entities(self, parameters, resolve_entities=False):
+    def entities(self, parameters):
         """
         Create an L{EndpointCaller}  to identify named entities found in the texts
-        to which it is applied and call it. Linked entity information is optional, and
-        its need must be specified at the time the operator is created.
+        to which it is applied and call it.
         @param parameters: An object specifying the data,
         and possible metadata, to be processed by the entity identifier.
         @type parameters: L{DocumentParameters} or L{str}
-        @param resolve_entities: Specifies whether or not linked entity information will
-        be wanted.
-        @type resolve_entities: Boolean
         @return: A python dictionary containing the results of entity extraction."""
-        if resolve_entities:
-            warnings.warn("entities(params,resolve_entities) is deprecated and replaced by entities(params).", DeprecationWarning)
-            return EndpointCaller(self, "entities/linked").call(parameters)
-        else:
-            return EndpointCaller(self, "entities").call(parameters)
+
+        return EndpointCaller(self, "entities").call(parameters)
 
     def categories(self, parameters):
         """

examples/entities_linked.py

@@ -323,21 +323,6 @@ def test_the_entities_endpoint(api, json_response, doc_params):
     httpretty.disable()
     httpretty.reset()
 
-# Test the entities/linked endpoint
-
-
-def test_the_entities_linked_endpoint(api, json_response, doc_params):
-    httpretty.enable()
-    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/info",
-                           body=json_response, status=200, content_type="application/json")
-    httpretty.register_uri(httpretty.POST, "https://api.rosette.com/rest/v1/entities/linked",
-                           body=json_response, status=200, content_type="application/json")
-
-    result = api.entities(doc_params, True)
-    assert result["name"] == "Rosette API"
-    httpretty.disable()
-    httpretty.reset()
-
 # Test the categories endpoint