Adding Annotations class in language implementation.

dhermes · dhermes · commit 3ea7bd506a95 · 2016-08-29T12:59:36.000-07:00
To be used in Document.annotate_text().
diff --git a/gcloud/language/document.py b/gcloud/language/document.py
@@ -17,6 +17,8 @@
 A document is used to hold text to be analyzed and annotated.
 """
 
+import collections
+
 from gcloud.language.entity import Entity
 from gcloud.language.sentiment import Sentiment
 
@@ -25,6 +27,26 @@
 """Default document language, English."""
 
 
+Annotations = collections.namedtuple(
+    'Annotations',
+    'sentences tokens sentiment entities')
+"""Annotations for a document.
+
+:type sentences: list
+:param sentences: List of :class:`.Sentence` in a document.
+
+:type tokens: list
+:param tokens: List of :class:`.Token` from a document.
+
+:type sentiment: :class:`Sentiment`
+:param sentiment: The sentiment of a document.
+
+:type entities: list
+:param entities: List of :class:`~.language.entity.Entity`
+                 found in a document.
+"""
+
+
 class Encoding(object):
     """Document text encoding types."""
 
