Spaces:
Configuration error
Configuration error
Fedir Zadniprovskyi
commited on
Commit
·
838b1d7
1
Parent(s):
7b442f3
docs: add a note about api key
Browse files- docs/introduction.md +2 -2
- docs/usage/speech-to-text.md +6 -1
- docs/usage/text-to-speech.md +6 -1
docs/introduction.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
| 1 |
-
!!!
|
| 2 |
|
| 3 |
-
|
| 4 |
|
| 5 |
TODO: add HuggingFace Space URL
|
| 6 |
|
|
|
|
| 1 |
+
!!! note
|
| 2 |
|
| 3 |
+
This project was previously named `faster-whisper-server`. It has been renamed to `speaches` to ...
|
| 4 |
|
| 5 |
TODO: add HuggingFace Space URL
|
| 6 |
|
docs/usage/speech-to-text.md
CHANGED
|
@@ -2,7 +2,6 @@ https://platform.openai.com/docs/api-reference/audio/createTranscription
|
|
| 2 |
https://platform.openai.com/docs/guides/speech-to-text
|
| 3 |
|
| 4 |
TODO: add a note about automatic downloads
|
| 5 |
-
TODO: add a note about api-key
|
| 6 |
TODO: mention streaming
|
| 7 |
TODO: add a demo
|
| 8 |
TODO: talk about audio format
|
|
@@ -29,6 +28,12 @@ curl http://localhost:8000/v1/audio/transcriptions -F "[email protected]"
|
|
| 29 |
|
| 30 |
## OpenAI SDKs
|
| 31 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
=== "Python"
|
| 33 |
|
| 34 |
```python
|
|
|
|
| 2 |
https://platform.openai.com/docs/guides/speech-to-text
|
| 3 |
|
| 4 |
TODO: add a note about automatic downloads
|
|
|
|
| 5 |
TODO: mention streaming
|
| 6 |
TODO: add a demo
|
| 7 |
TODO: talk about audio format
|
|
|
|
| 28 |
|
| 29 |
## OpenAI SDKs
|
| 30 |
|
| 31 |
+
!!! note
|
| 32 |
+
|
| 33 |
+
Although this project doesn't require an API key, all OpenAI SDKs require an API key. Therefore, you will need to set it to a non-empty value. Additionally, you will need to overwrite the base URL to point to your server.
|
| 34 |
+
|
| 35 |
+
This can be done by setting the `OPENAI_API_KEY` and `OPENAI_BASE_URL` environment variables or by passing them as arguments to the SDK.
|
| 36 |
+
|
| 37 |
=== "Python"
|
| 38 |
|
| 39 |
```python
|
docs/usage/text-to-speech.md
CHANGED
|
@@ -6,7 +6,6 @@ https://platform.openai.com/docs/api-reference/audio/createSpeech
|
|
| 6 |
https://platform.openai.com/docs/guides/text-to-speech
|
| 7 |
http://localhost:8001/faster-whisper-server/api/
|
| 8 |
TODO: add a note about automatic downloads
|
| 9 |
-
TODO: add a note about api-key
|
| 10 |
TODO: add a demo
|
| 11 |
|
| 12 |
## Prerequisite
|
|
@@ -74,6 +73,12 @@ curl http://localhost:8000/v1/audio/speech --header "Content-Type: application/j
|
|
| 74 |
|
| 75 |
## OpenAI SDKs
|
| 76 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 77 |
=== "Python"
|
| 78 |
|
| 79 |
```python
|
|
|
|
| 6 |
https://platform.openai.com/docs/guides/text-to-speech
|
| 7 |
http://localhost:8001/faster-whisper-server/api/
|
| 8 |
TODO: add a note about automatic downloads
|
|
|
|
| 9 |
TODO: add a demo
|
| 10 |
|
| 11 |
## Prerequisite
|
|
|
|
| 73 |
|
| 74 |
## OpenAI SDKs
|
| 75 |
|
| 76 |
+
!!! note
|
| 77 |
+
|
| 78 |
+
Although this project doesn't require an API key, all OpenAI SDKs require an API key. Therefore, you will need to set it to a non-empty value. Additionally, you will need to overwrite the base URL to point to your server.
|
| 79 |
+
|
| 80 |
+
This can be done by setting the `OPENAI_API_KEY` and `OPENAI_BASE_URL` environment variables or by passing them as arguments to the SDK.
|
| 81 |
+
|
| 82 |
=== "Python"
|
| 83 |
|
| 84 |
```python
|