Commit @9fa6f952d191d65ceeeb5ee8ee62e4943d5ff914 - yjyoon/whisper_server

Fedir Zadniprovskyi 01-12

docs: add a note about api key

@9fa6f952d191d65ceeeb5ee8ee62e4943d5ff914

9ff425b

9fa6f95

docs/introduction.md

--- docs/introduction.md

+++ docs/introduction.md


-!!! warning
+!!! note
 
-    Under development. I don't yet recommend using these docs as reference for now.
+    This project was previously named `faster-whisper-server`. It has been renamed to `speaches` to ...
 
 TODO: add HuggingFace Space URL
 

9ff425b

9fa6f95

docs/usage/speech-to-text.md

--- docs/usage/speech-to-text.md

+++ docs/usage/speech-to-text.md


 https://platform.openai.com/docs/guides/speech-to-text
 
 TODO: add a note about automatic downloads
-TODO: add a note about api-key
 TODO: mention streaming
 TODO: add a demo
 TODO: talk about audio format

 
 ## OpenAI SDKs
 
+!!! note
+
+    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.
+
+    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.
+
 === "Python"
 
     ```python

9ff425b

9fa6f95

docs/usage/text-to-speech.md

--- docs/usage/text-to-speech.md

+++ docs/usage/text-to-speech.md


 https://platform.openai.com/docs/guides/text-to-speech
 http://localhost:8001/faster-whisper-server/api/
 TODO: add a note about automatic downloads
-TODO: add a note about api-key
 TODO: add a demo
 
 ## Prerequisite

 
 ## OpenAI SDKs
 
+!!! note
+
+    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.
+
+    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.
+
 === "Python"
 
     ```python

Add a comment

Open 0
Closed 0

List

...	...	@@ -2,7 +2,6 @@
2	2	https://platform.openai.com/docs/guides/speech-to-text
3	3
4	4	TODO: add a note about automatic downloads
5		-TODO: add a note about api-key
6	5	TODO: mention streaming
7	6	TODO: add a demo
8	7	TODO: talk about audio format
...	...	@@ -29,6 +28,12 @@
29	28
30	29	## OpenAI SDKs
31	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	+
32	37	=== "Python"
33	38
34	39	```python

...	...	@@ -6,7 +6,6 @@
6	6	https://platform.openai.com/docs/guides/text-to-speech
7	7	http://localhost:8001/faster-whisper-server/api/
8	8	TODO: add a note about automatic downloads
9		-TODO: add a note about api-key
10	9	TODO: add a demo
11	10
12	11	## Prerequisite
...	...	@@ -74,6 +73,12 @@
74	73
75	74	## OpenAI SDKs
76	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	+
77	82	=== "Python"
78	83
79	84	```python

...	...	@@ -1,6 +1,6 @@
1		-!!! warning
	1	+!!! note
2	2
3		- Under development. I don't yet recommend using these docs as reference for now.
	3	+ This project was previously named `faster-whisper-server`. It has been renamed to `speaches` to ...
4	4
5	5	TODO: add HuggingFace Space URL
6	6

Delete comment