Remove 'alternatives' key when accessing results.

daspecster · daspecster · commit 92b2b89bb84e · 2016-09-27T10:18:40.000-04:00
diff --git a/docs/speech-usage.rst b/docs/speech-usage.rst
@@ -55,9 +55,9 @@ See: `Speech Asynchronous Recognize`_
       ...     operation.poll()  # API call
       >>> operation.complete
       True
-      >>> operation.results[0]['alternatives'][0]['transcript']
-      "how old is the Brooklyn Bridge"
-      >>> operation.results[0]['alternatives'][0]['confidence']
+      >>> operation.results[0].transcript
+      'how old is the Brooklyn Bridge'
+      >>> operation.results[0].confidence
       0.98267895
 
 
diff --git a/google/cloud/speech/operation.py b/google/cloud/speech/operation.py
@@ -15,11 +15,15 @@
 """Long running operation representation for Google Speech API"""
 
 from google.cloud._helpers import _rfc3339_to_datetime
+from google.cloud import operation
 
 
-class Operation(object):
+class Operation(operation.Operation):
     """Representation of a Google API Long-Running Operation.
 
+    :type client: :class:`~google.cloud.speech.client.Client`
+    :param client: Instance of speech client.
+
     :type name: int
     :param name: ID assigned to an operation.
 
@@ -52,31 +56,21 @@ def __init__(self, client, name, complete=False, last_updated=None,
     def from_api_repr(cls, client, response):
         """Factory:  construct an instance from Google Speech API.
 
+        :type client: :class:`~google.cloud.speech.client.Client`
+        :param client: Instance of speech client.
+
         :type response: dict
         :param response: Dictionary response from Google Speech Operations API.
 
         :rtype: :class:`Operation`
         :returns: Instance of `~google.cloud.speech.operations.Operation`.
         """
-        last_updated = None
-        progress_percent = 0
-        results = None
-        start_time = None
-
         name = response['name']
-        metadata = response.get('metadata', None)
-
-        if metadata:
-            last_updated = _rfc3339_to_datetime(metadata.get('lastUpdateTime'))
-            start_time = _rfc3339_to_datetime(metadata.get('startTime'))
-            progress_percent = metadata.get('progressPercent')
-
-        if response.get('response'):
-            results = response.get('response').get('results')
         complete = response.get('done', False)
 
-        return cls(client, name, complete, last_updated, progress_percent,
-                   results, start_time)
+        operation_instance = cls(client, name, complete)
+        operation_instance._update(response)
+        return operation_instance
 
     @property
     def complete(self):
@@ -150,10 +144,46 @@ def _update(self, response):
         :param response: Response from Speech API Operations endpoint.
                          See: `speech_operations`_.
         """
-        metadata = response['metadata']
-        results = response.get('response', {}).get('results')
-        self._last_updated = _rfc3339_to_datetime(metadata['lastUpdateTime'])
+        metadata = response.get('metadata', None)
+        raw_results = response.get('response', {}).get('results', None)
+        results = []
+        if raw_results:
+            for result in raw_results[0]['alternatives']:
+                results.append(Transcript(result))
+        if metadata:
+            self._last_updated = _rfc3339_to_datetime(
+                metadata['lastUpdateTime'])
+            self._start_time = _rfc3339_to_datetime(metadata['startTime'])
+            self._progress_percent = metadata.get('progressPercent', 0)
+
         self._results = results
-        self._start_time = _rfc3339_to_datetime(metadata['startTime'])
         self._complete = response.get('done', False)
-        self._progress_percent = metadata.get('progressPercent', 0)
+
+
+class Transcript(object):
+    """Representation of Speech Transcripts
+
+    :type result: dict
+    :param result: Dictionary of transcript and confidence of recognition.
+    """
+    def __init__(self, result):
+        self._transcript = result.get('transcript')
+        self._confidence = result.get('confidence')
+
+    @property
+    def transcript(self):
+        """Transcript text from audio.
+
+        :rtype: str
+        :returns: Text detected in audio.
+        """
+        return self._transcript
+
+    @property
+    def confidence(self):
+        """Confidence score for recognized speech.
+
+        :rtype: float
+        :returns: Confidence score of recognized speech [0-1].
+        """
+        return self._confidence
diff --git a/speech/unit_tests/_fixtures.py b/speech/unit_tests/_fixtures.py
@@ -40,7 +40,7 @@
                   'google.cloud.speech.v1beta1.AsyncRecognizeMetadata'),
         'progressPercent': 100,
         'startTime': '2016-09-22T17:52:25.536964Z',
-        'lastUpdateTime': '2016-09-22T17:52:27.802902Z'
+        'lastUpdateTime': '2016-09-22T17:52:27.802902Z',
     },
     'done': True,
     'response': {
@@ -52,11 +52,11 @@
                     {
                         'transcript': 'how old is the Brooklyn Bridge',
                         'confidence': 0.98267895
-                    }
-                ]
-            }
-        ]
-    }
+                    },
+                ],
+            },
+        ],
+    },
 }
 
 OPERATION_INCOMPLETE_RESPONSE = {
@@ -66,7 +66,7 @@
                   'google.cloud.speech.v1beta1.AsyncRecognizeMetadata'),
         'progressPercent': 27,
         'startTime': '2016-09-22T17:52:25.536964Z',
-        'lastUpdateTime': '2016-09-22T17:52:27.802902Z'
+        'lastUpdateTime': '2016-09-22T17:52:27.802902Z',
     },
-    'done': False
+    'done': False,
 }
diff --git a/unit_tests/speech/test_operation.py b/unit_tests/speech/test_operation.py
@@ -24,6 +24,7 @@ def test_ctor_defaults(self):
 
     def test_from_api_repr(self):
         from unit_tests.speech._fixtures import OPERATION_COMPLETE_RESPONSE
+        from google.cloud.speech.operation import Transcript
         RESPONSE = OPERATION_COMPLETE_RESPONSE
 
         client = _Client()
@@ -34,11 +35,10 @@ def test_from_api_repr(self):
         self.assertEqual('123456789', operation.name)
         self.assertTrue(operation.complete)
 
-        alternatives = operation.results[0]['alternatives']
-
+        self.assertIsInstance(operation.results[0], Transcript)
         self.assertEqual('how old is the Brooklyn Bridge',
-                         alternatives[0]['transcript'])
-        self.assertEqual(0.98267895, alternatives[0]['confidence'])
+                         operation.results[0].transcript)
+        self.assertEqual(0.98267895, operation.results[0].confidence)
         self.assertTrue(operation.complete)
 
     def test_update_response(self):
@@ -84,8 +84,10 @@ def test_poll_complete(self):
 class _Connection(object):
     def __init__(self, response):
         self.response = response
+        self._requested = []
 
     def api_request(self, method, path):
+        self._requested.append({'method': method, 'path': path})
         return self.response
 
 
