Merge pull request #60 from pkusunjy/remote

Documentation and example about audio text-to-speech method

documentation/audio/README.md

@@ -3,6 +3,7 @@
 
 This class and its associated <code>liboai::OpenAI</code> interface allow access to the <a href="https://beta.openai.com/docs/api-reference/audio">Audio</a> endpoint of the OpenAI API; this endpoint's functionality can be found below.</p>
 - Turn audio to text.
+- Turn text to audio.
 
 <br>
 <h2>Methods</h2>
@@ -62,6 +63,32 @@ liboai::FutureResponse translate_async(
 ) const& noexcept(false);
 ```
 
+<h3>Text to speech</h3>
+<p>Turn text into lifelike spoken audio. Returns a <code>liboai::Response</code> containing response data. The audio data is in the <code>content</code> field of the <code>liboai::Response</code></p>
+
+```cpp
+liboai::Response speech(
+  const std::string& model,
+  const std::string& voice,
+  const std::string& input,
+  std::optional<std::string> response_format = std::nullopt,
+  std::optional<float> speed = std::nullopt
+) const& noexcept(false);
+```
+
+<h3>Text to speech (async)</h3>
+<p>Asynchronously turn text into lifelike spoken audio. Returns a <code>liboai::FutureResponse</code> containing response data. The audio data is in the <code>content</code> field of the <code>liboai::Response</code></p>
+
+```cpp
+liboai::FutureResponse speech_async(
+  const std::string& model,
+  const std::string& voice,
+  const std::string& input,
+  std::optional<std::string> response_format = std::nullopt,
+  std::optional<float> speed = std::nullopt
+) const& noexcept(false);
+```
+
 <p>All function parameters marked <code>optional</code> are not required and are resolved on OpenAI's end if not supplied.</p>
 
 <br>

documentation/audio/examples/create_speech.cpp

@@ -5,15 +5,14 @@ using namespace liboai;
 int main() {
   OpenAI oai;
 
-  std::ofstream ocout("demo.mp3", std::ios::binary);
-
   if (oai.auth.SetKeyEnv("OPENAI_API_KEY")) {
     try {
       Response res = oai.Audio->speech(
         "tts-1",
         "alloy",
         "Today is a wonderful day to build something people love!"
       );
+      std::ofstream ocout("demo.mp3", std::ios::binary);
       ocout << res.content;
       ocout.close();
       std::cout << res.content.size() << std::endl;

documentation/audio/examples/create_speech_async.cpp

@@ -7,7 +7,6 @@ int main() {
 
   if (oai.auth.SetKeyEnv("OPENAI_API_KEY")) {
     try {
-      std::ofstream ocout("demo.mp3", std::ios::binary);
       auto fut = oai.Audio->speech_async(
         "tts-1",
         "alloy",
@@ -20,7 +19,7 @@ int main() {
 
       // get the contained response
       auto res = fut.get();
-
+      std::ofstream ocout("demo.mp3", std::ios::binary);
       ocout << res.content;
       ocout.close();
       std::cout << res.content.size() << std::endl;