Update sdk #13

eff-kay · 2022-12-06T00:47:39Z

fixes #7 , #8 , #11 , #10

eff-kay · 2022-12-23T23:47:59Z

.gitignore

@@ -1,2 +0,0 @@
-.DS_Store
-services.py


we need a .gitignore

eff-kay · 2022-12-23T23:48:33Z

src/speechtotext.py

@@ -0,0 +1,75 @@
+import requests


remove the *.pyc file above.

eff-kay · 2022-12-23T23:49:44Z

src/speechtotext.py

+
+            return "UNKNOWN ERROR"
+
+    #    return response.json()["transcription_data"]["transcription"]


remove comments

eff-kay · 2022-12-23T23:53:19Z

src/speechtotext.py

+        if API_KEY:
+            token="Token {0}".format(API_KEY)
+            self.HEADERS = {'authorization': token}
+           # print("Auth with "+API_KEY+"\nMake sure this matches your API Key generated in the dashboard settings")


remove comments

eff-kay · 2022-12-23T23:53:46Z

src/speechtotext.py

+    HEADERS:dict = {}
+    ## add the api key to sys path envs 
+    def __init__(self,API_KEY: str = None):
+        self.API_KEY=None


this variable is not required

eff-kay · 2022-12-23T23:54:28Z

src/speechtotext.py

+           # print("Auth with environment variable SLASHML_API_KEY")
+        else:
+            self.HEADERS=None 
+            print("No Auth, there are certain limites to the usage")


limits typo

point them to the relevant webpage where they can get the API token

eff-kay · 2022-12-23T23:55:04Z

src/speechtotext.py

+    def upload_audio(self, file_location:str,header=None):
+        headers = self.HEADERS
+        files=[
+        ('audio',('test_audio.mp3',open(file_location,'rb'),'audio/mpeg'))


improve the formatting

eff-kay · 2022-12-23T23:55:32Z

src/speechtotext.py

+        files=[
+        ('audio',('test_audio.mp3',open(file_location,'rb'),'audio/mpeg'))
+        ]
+        response = requests.post(self.SLASHML_UPLOAD_URL,


what if the response is an error.

eff-kay · 2022-12-23T23:55:53Z

src/speechtotext.py

+        ]
+        response = requests.post(self.SLASHML_UPLOAD_URL,
+                                headers=headers,files=files)
+        return  response.json()["upload_url"]


what if the json() does not contain upload_url.

eff-kay · 2022-12-23T23:56:04Z

src/speechtotext.py

+        transcript_request = {'audio_url': upload_url}
+        headers = self.HEADERS
+        payload = {
+        "uploaded_audio_url": upload_url,


improve formatting.

eff-kay · 2022-12-23T23:56:30Z

src/speechtotext.py

+        "service_provider": service_provider
+        }
+        response = requests.post(self.SLASHML_TRANSCRIPT_URL, headers=headers, data=payload)
+        return response.json()["id"]


same comment as upload function, what if the id is not in json.

eff-kay · 2022-12-23T23:57:41Z

src/speechtotext.py

+        response = requests.get(self.SLASHML_TRANSCRIPT_STATUS_URL(job_id) , headers=headers, data=payload)
+
+        # Check the status code of the response
+        if response.status_code == 200:


so we need a uniform pattern for how to deal with 400s, 500s. Either the same should be done for the other endpoints as well, or they should not be done for the other endpoints.

eff-kay · 2022-12-23T23:57:51Z

src/speechtotext.py

+    #    return response.json()["transcription_data"]["transcription"]
+
+
+    #### chgeck the code of the reponse, ifit is not 200, print back the error.


eff-kay · 2022-12-23T23:58:03Z

src/status_test.py

@@ -0,0 +1,24 @@
+import speechtotext


remove this file altogether.

eff-kay · 2022-12-23T23:59:07Z

src/test_speechtotext_1.py

@@ -0,0 +1,21 @@
+import speechtotext
+import os 


either convert this file to proper test_cases, or remove this file altogether. If the purpose is to show how to use the API, move this file to a samples folder and create a sample application in there, along with the relevant file.

eff-kay · 2022-12-23T23:59:42Z

src/test_speechtotext_1.py

+# Initialize SlashML 
+speect_to_text = speechtotext.SpeechToText()
+# optional local file to upload, if not an accessible url
+file_location="/Users/JJneid/Desktop/SlashMl/s2t_experiments/api_tests/2test_audio.mp3"


this location is specific to your computer, the file will not work on someone else's computer.

eff-kay · 2022-12-26T20:49:34Z

README.md

+# SLASHML Python client

-to be updated to guide users
+This is a Python client for SLASHML. It lets you run transcription jobs from your Python code or Jupyter notebook. Do a transcription job with three lines of code


Suggested change

This is a Python client for SLASHML. It lets you run transcription jobs from your Python code or Jupyter notebook. Do a transcription job with three lines of code

This is a Python client for [SlashML](https://slashml.com). It lets you call machine learning APIs from your Python code or Jupyter notebook.

Following is an example of how to do Transcription with 3 lines of code.

eff-kay · 2022-12-26T20:49:59Z

README.md

+
+speect_to_text = speechtotext.SpeechToText()
+transcribe_id= speect_to_text.transcribe(audio_url,service_provider="aws")
+status=speect_to_text.status(transcribe_id,service_provider=service_provider)


wait for status to be COMPLETED

eff-kay · 2022-12-26T20:50:57Z

README.md

+```
+or including it in your code as follows:
+```
+import speechtotext


I think this code is outdated

JJneid added 4 commits December 5, 2022 18:57

updated sdk with service_provider

7c395f6

removed unnecessary files

31879f6

removed unnecessary files 2

b207443

new update with response succeess/failed

0c2f7ec

JJneid force-pushed the update_sdk branch from 0968449 to 0c2f7ec Compare December 23, 2022 23:29

new update with response

5c65881

eff-kay commented Dec 23, 2022

View reviewed changes

.gitignore

@@ -1,2 +0,0 @@

.DS_Store

services.py

Copy link

Contributor Author

eff-kay Dec 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we need a .gitignore

eff-kay commented Dec 23, 2022

View reviewed changes

src/speechtotext.py

@@ -0,0 +1,75 @@

import requests

Copy link

Contributor Author

eff-kay Dec 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove the *.pyc file above.

eff-kay commented Dec 23, 2022

View reviewed changes

src/status_test.py

@@ -0,0 +1,24 @@

import speechtotext

Copy link

Contributor Author

eff-kay Dec 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this file altogether.

eff-kay commented Dec 23, 2022

View reviewed changes

eff-kay commented Dec 26, 2022

View reviewed changes

README.md

```

or including it in your code as follows:

```

import speechtotext

Copy link

Contributor Author

eff-kay Dec 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this code is outdated

JJneid mentioned this pull request Dec 28, 2022

Speechtext #15

Merged

JJneid closed this Dec 28, 2022

JJneid reopened this Dec 28, 2022


		return "UNKNOWN ERROR"

		# return response.json()["transcription_data"]["transcription"]

		# return response.json()["transcription_data"]["transcription"]


		#### chgeck the code of the reponse, ifit is not 200, print back the error. No newline at end of file

-This is a Python client for SLASHML. It lets you run transcription jobs from your Python code or Jupyter notebook. Do a transcription job with three lines of code
+This is a Python client for [SlashML](https://slashml.com). It lets you call machine learning APIs from your Python code or Jupyter notebook.
+Following is an example of how to do Transcription with 3 lines of code.

Update sdk #13

Are you sure you want to change the base?

Update sdk #13

Uh oh!

Conversation

eff-kay commented Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

eff-kay commented Dec 6, 2022 •

edited

Loading