REVAI-3918 Split NlpModel to have separate enums for Translation and Summarization (revdotcom#107)

* REVAI-3918: Split NlpModel to have separate enums for Translation and Summarization
https://revinc.atlassian.net/browse/REVAI-3918

Author: kirillatrev

README.md

@@ -75,7 +75,7 @@ job = client.submit_job_url("https://example.com/file-to-transcribe.mp3",
     language='en',
     translation_config=TranslationOptions(
         target_languages: [
-            TranslationLanguageOptions("es", NlpModel.PREMIUM),
+            TranslationLanguageOptions("es", TranslationModel.PREMIUM),
             TranslationLanguageOptions("de")
         ]
     ));

examples/async_summarize.py

@@ -31,7 +31,7 @@
 #                                    delete_after_seconds=2592000,
 #                                    language='en',
 #                                    summarization_config=SummarizationOptions(
-#                                        model=NlpModel.PREMIUM
+#                                        model=SummarizationModel.PREMIUM
 #                                    ))
 
 
@@ -41,7 +41,7 @@
 job = client.submit_job_url(media_url=url,
                             delete_after_seconds=2592000,
                             language='en',
-                            summarization_config=SummarizationOptions(model=NlpModel.PREMIUM))
+                            summarization_config=SummarizationOptions(model=SummarizationModel.PREMIUM))
 
 print("Submitted Job")
 print("Job Status : {}".format(job.status))

examples/async_translate.py

@@ -18,7 +18,7 @@
 from rev_ai.models.asynchronous.translation_job_status import TranslationJobStatus
 from rev_ai.models.asynchronous.translation_language_options import TranslationLanguageOptions
 from rev_ai.models.asynchronous.translation_options import TranslationOptions
-from rev_ai.models.nlp_model import NlpModel
+from rev_ai.models.asynchronous.translation_model import TranslationModel
 
 # String containing your access token
 access_token = "<your_access_token>"
@@ -33,7 +33,7 @@
 #                             language='en',
 #                             translation_config=TranslationOptions(
 #                                 target_languages=[
-#                                     TranslationLanguageOptions("es", NlpModel.PREMIUM)
+#                                     TranslationLanguageOptions("es", TranslationModel.PREMIUM)
 #                                 ]
 #                             ))
 
@@ -45,7 +45,7 @@
                             language='en',
                             translation_config=TranslationOptions(
                                 target_languages=[
-                                    TranslationLanguageOptions("es", NlpModel.PREMIUM)
+                                    TranslationLanguageOptions("es", TranslationModel.PREMIUM)
                                 ]
                             ))
 

setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.19.0
+current_version = 2.19.1
 commit = True
 tag = True
 

src/rev_ai/__init__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """Top-level package for rev_ai"""
 
-__version__ = '2.19.1'
+__version__ = '2.19.2'
 
 from .models import Job, JobStatus, Account, Transcript, Monologue, Element, MediaConfig, \
     CaptionType, CustomVocabulary, TopicExtractionJob, TopicExtractionResult, Topic, Informant, \

src/rev_ai/apiclient.py

@@ -413,23 +413,21 @@ def get_captions(self, id_, content_type=CaptionType.SRT, channel_id=None):
 
         return response.text
 
-    def get_translated_captions(self, id_, language, content_type=CaptionType.SRT, channel_id=None):
+    def get_translated_captions(self, id_, language, content_type=CaptionType.SRT):
         """Get the captions output of a specific job and return it as plain text
 
         :param id_: id of job to be requested
         :param content_type: caption type which should be returned. Defaults to SRT
-        :param channel_id: id of speaker channel to be captioned, only matters for multichannel jobs
         :returns: caption data as text
         :raises: HTTPError
         """
         if not id_:
             raise ValueError('id_ must be provided')
-        query = self._create_captions_query(channel_id)
 
         response = self._make_http_request(
             "GET",
             urljoin(self.base_url,
-                    'jobs/{0}/captions/translation/{1}{2}'.format(id_, language, query)),
+                    'jobs/{0}/captions/translation/{1}'.format(id_, language)),
             headers={'Accept': content_type.value}
         )
 

src/rev_ai/models/asynchronous/summarization_model.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class SummarizationModel(str, Enum):
+    STANDARD = "standard"
+    PREMIUM = "premium"

src/rev_ai/models/asynchronous/summarization_options.py

@@ -1,6 +1,6 @@
 from .summarization_formatting_options import SummarizationFormattingOptions
 from .summarization_job_status import SummarizationJobStatus
-from ..nlp_model import NlpModel
+from .summarization_model import SummarizationModel
 
 
 class SummarizationOptions:
@@ -9,7 +9,7 @@ class SummarizationOptions:
     def __init__(
             self,
             prompt: str = None,
-            model: NlpModel = None,
+            model: SummarizationModel = None,
             formatting_type: SummarizationFormattingOptions = None):
         self.prompt = prompt
         self.model = model
@@ -35,7 +35,7 @@ class Summarization(SummarizationOptions):
     def __init__(
             self,
             prompt: str = None,
-            model: NlpModel = None,
+            model: SummarizationModel = None,
             formatting_type: SummarizationFormattingOptions = None,
             status: SummarizationJobStatus = None,
             completed_on: str = None,

src/rev_ai/models/asynchronous/translation_language_options.py

@@ -1,13 +1,13 @@
 from .translation_job_status import TranslationJobStatus
-from ..nlp_model import NlpModel
+from .translation_model import TranslationModel
 
 
 class TranslationLanguageOptions:
     """Translation language request options."""
     def __init__(
             self,
             language: str = None,
-            model: NlpModel = None):
+            model: TranslationModel = None):
         self.language = language
         self.model = model
 
@@ -28,7 +28,7 @@ class TranslationLanguage(TranslationLanguageOptions):
     def __init__(
             self,
             language: str = None,
-            model: NlpModel = None,
+            model: TranslationModel = None,
             status: TranslationJobStatus = None,
             failure: str = None):
         super().__init__(language, model)

src/rev_ai/models/nlp_model.py renamed to src/rev_ai/models/asynchronous/translation_model.py

@@ -1,6 +1,6 @@
 from enum import Enum
 
 
-class NlpModel(str, Enum):
+class TranslationModel(str, Enum):
     STANDARD = "standard"
     PREMIUM = "premium"