Links to audio endpoint api documentation updated

cequence-io · Nov 28, 2023 · 6a4b67b · 6a4b67b
1 parent bdb872a
commit 6a4b67b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ This is a no-nonsense async Scala client for OpenAI API supporting all the avail
 * **Edits**: [createEdit](https://platform.openai.com/docs/api-reference/edits/create) (deprecated)
 * **Images**: [createImage](https://platform.openai.com/docs/api-reference/images/create), [createImageEdit](https://platform.openai.com/docs/api-reference/images/create-edit), and [createImageVariation](https://platform.openai.com/docs/api-reference/images/create-variation)
 * **Embeddings**: [createEmbeddings](https://platform.openai.com/docs/api-reference/embeddings/create)
-* **Audio**: [createAudioTranscription](https://platform.openai.com/docs/api-reference/audio/create), [createAudioTranslation](https://platform.openai.com/docs/api-reference/audio/create) 
+* **Audio**: [createAudioTranscription](https://platform.openai.com/docs/api-reference/audio/createTranscription), [createAudioTranslation](https://platform.openai.com/docs/api-reference/audio/createTranslation), and [createAudioSpeech](https://platform.openai.com/docs/api-reference/audio/createSpeech)
 * **Files**: [listFiles](https://platform.openai.com/docs/api-reference/files/list), [uploadFile](https://platform.openai.com/docs/api-reference/files/upload), [deleteFile](https://platform.openai.com/docs/api-reference/files/delete), [retrieveFile](https://platform.openai.com/docs/api-reference/files/retrieve), and [retrieveFileContent](https://platform.openai.com/docs/api-reference/files/retrieve-content)
 * **Fine-tunes**: [createFineTune](https://platform.openai.com/docs/api-reference/fine-tunes/create), [listFineTunes](https://platform.openai.com/docs/api-reference/fine-tunes/list), [retrieveFineTune](https://platform.openai.com/docs/api-reference/fine-tunes/retrieve), [cancelFineTune](https://platform.openai.com/docs/api-reference/fine-tunes/cancel), [listFineTuneEvents](https://platform.openai.com/docs/api-reference/fine-tunes/events), and [deleteFineTuneModel](https://platform.openai.com/docs/api-reference/fine-tunes/delete-model)
 * **Moderations**: [createModeration](https://platform.openai.com/docs/api-reference/moderations/create)

diff --git a/openai-core/src/main/scala/io/cequence/openaiscala/service/OpenAIService.scala b/openai-core/src/main/scala/io/cequence/openaiscala/service/OpenAIService.scala
@@ -124,7 +124,8 @@ trait OpenAIService extends OpenAICoreService {
    * Creates an image given a prompt.
    *
    * @param prompt
-   *   A text description of the desired image(s). The maximum length is 1000 characters for dall-e-2 and 4000 characters for dall-e-3.
+   *   A text description of the desired image(s). The maximum length is 1000 characters for
+   *   dall-e-2 and 4000 characters for dall-e-3.
    * @param settings
    * @return
    *   image response (might contain multiple data items - one per image)
@@ -190,9 +191,10 @@ trait OpenAIService extends OpenAICoreService {
    *
    * @param settings
    * @return
-   * The audio file content.
+   *   The audio file content.
    * @see
-   * <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech">OpenAI Doc</a>
+   *   <a href="https://platform.openai.com/docs/api-reference/audio/createSpeech">OpenAI
+   *   Doc</a>
    */
   def createAudioSpeech(
     input: String,
@@ -213,7 +215,9 @@ trait OpenAIService extends OpenAICoreService {
    *   transcription text
    *
    * @see
-   *   <a href="https://platform.openai.com/docs/api-reference/audio/create">OpenAI Doc</a>
+   *   <a
+   *   href="https://platform.openai.com/docs/api-reference/audio/createTranscription">OpenAI
+   *   Doc</a>
    */
   def createAudioTranscription(
     file: File,
@@ -235,7 +239,8 @@ trait OpenAIService extends OpenAICoreService {
    *   translation text
    *
    * @see
-   *   <a href="https://platform.openai.com/docs/api-reference/audio/create">OpenAI Doc</a>
+   *   <a href="https://platform.openai.com/docs/api-reference/audio/createTranslation">OpenAI
+   *   Doc</a>
    */
   def createAudioTranslation(
     file: File,