Adding an optional display (header) file name to OpenAIService.uploadFile function. If not specified a full path is used as a file name instead.

Author: peterbanda

openai-client/src/main/scala/io/cequence/openaiscala/service/OpenAIServiceImpl.scala

@@ -197,7 +197,7 @@ private class OpenAIServiceImpl(
   ): Future[ImageInfo] =
     execPOSTMultipart(
       Command.images_edits,
-      fileParams = Seq(Tag.image -> image) ++ mask.map((Tag.mask ->_)),
+      fileParams = Seq((Tag.image, image, None)) ++ mask.map((Tag.mask, _, None)),
       bodyParams = Seq(
         Tag.prompt -> Some(prompt),
         Tag.n -> settings.n,
@@ -215,7 +215,7 @@ private class OpenAIServiceImpl(
   ): Future[ImageInfo] =
     execPOSTMultipart(
       Command.images_variations,
-      fileParams = Seq(Tag.image -> image),
+      fileParams = Seq((Tag.image, image, None)),
       bodyParams = Seq(
         Tag.n -> settings.n,
         Tag.size -> settings.size.map(_.toString),
@@ -254,7 +254,7 @@ private class OpenAIServiceImpl(
   ): Future[TranscriptResponse] =
     execPOSTMultipartWithStatusString(
       Command.audio_transcriptions,
-      fileParams = Seq(Tag.file -> file),
+      fileParams = Seq((Tag.file, file, None)),
       bodyParams = Seq(
         Tag.prompt -> prompt,
         Tag.model -> Some(settings.model),
@@ -271,7 +271,7 @@ private class OpenAIServiceImpl(
   ): Future[TranscriptResponse] =
     execPOSTMultipartWithStatusString(
       Command.audio_translations,
-      fileParams = Seq(Tag.file -> file),
+      fileParams = Seq((Tag.file, file, None)),
       bodyParams = Seq(
         Tag.prompt -> prompt,
         Tag.model -> Some(settings.model),
@@ -323,11 +323,12 @@ private class OpenAIServiceImpl(
 
   override def uploadFile(
     file: File,
-    settings: UploadFileSettings = DefaultSettings.UploadFile
+    displayFileName: Option[String],
+    settings: UploadFileSettings
   ): Future[FileInfo] =
     execPOSTMultipart(
       Command.files,
-      fileParams = Seq(Tag.file -> file),
+      fileParams = Seq((Tag.file, file, displayFileName)),
       bodyParams = Seq(
         Tag.purpose -> Some(settings.purpose)
       )
@@ -478,7 +479,7 @@ private class OpenAIServiceImpl(
 
   override def createModeration(
     input: String,
-    settings: CreateModerationSettings = DefaultSettings.CreateModeration
+    settings: CreateModerationSettings
   ): Future[ModerationResponse] =
     execPOST(
       Command.moderations,

openai-client/src/main/scala/io/cequence/openaiscala/service/ws/WSRequestHelper.scala

@@ -86,22 +86,28 @@ trait WSRequestHelper extends WSHelper {
   // POST //
   //////////
 
+  /**
+   * @param fileParams - the third param in a tuple is a display (header) file name
+   */
   protected def execPOSTMultipart(
     endPoint: PEP,
     endPointParam: Option[String] = None,
     params: Seq[(PT, Option[Any])] = Nil,
-    fileParams: Seq[(PT, File)] = Nil,
+    fileParams: Seq[(PT, File, Option[String])] = Nil,
     bodyParams: Seq[(PT, Option[Any])] = Nil
   ): Future[JsValue] =
     execPOSTMultipartWithStatus(
       endPoint, endPointParam, params, fileParams, bodyParams
     ).map(handleErrorResponse)
 
+  /**
+   * @param fileParams - the third param in a tuple is a display (header) file name
+   */
   protected def execPOSTMultipartWithStatus(
     endPoint: PEP,
     endPointParam: Option[String] = None,
     params: Seq[(PT, Option[Any])] = Nil,
-    fileParams: Seq[(PT, File)] = Nil,
+    fileParams: Seq[(PT, File, Option[String])] = Nil,
     bodyParams: Seq[(PT, Option[Any])] = Nil,
     acceptableStatusCodes: Seq[Int] = defaultAcceptableStatusCodes
   ): Future[RichJsResponse] = {
@@ -113,11 +119,14 @@ trait WSRequestHelper extends WSHelper {
     execPOSTJsonAux(request, formData, Some(endPoint), acceptableStatusCodes)
   }
 
+  /**
+   * @param fileParams - the third param in a tuple is a display (header) file name
+   */
   protected def execPOSTMultipartWithStatusString(
     endPoint: PEP,
     endPointParam: Option[String] = None,
     params: Seq[(PT, Option[Any])] = Nil,
-    fileParams: Seq[(PT, File)] = Nil,
+    fileParams: Seq[(PT, File, Option[String])] = Nil,
     bodyParams: Seq[(PT, Option[Any])] = Nil,
     acceptableStatusCodes: Seq[Int] = defaultAcceptableStatusCodes
   ): Future[RichStringResponse] = {
@@ -131,15 +140,16 @@ trait WSRequestHelper extends WSHelper {
 
   // create a multipart form data holder contain classic data (key-value) parts as well as file parts
   private def createMultipartFormData(
-    fileParams: Seq[(PT, File)] = Nil,
+    fileParams: Seq[(PT, File, Option[String])] = Nil,
     bodyParams: Seq[(PT, Option[Any])] = Nil
   ) = MultipartFormData(
     dataParts = bodyParams.collect { case (key, Some(value)) =>
       (key.toString, Seq(value.toString))
     }.toMap,
 
-    // TODO: we can potentially use here header-file-names as well (if provided as function's params)
-    files = fileParams.map { case (key, file) => FilePart(key.toString, file.getPath) }
+    files = fileParams.map { case (key, file, headerFileName) =>
+      FilePart(key.toString, file.getPath, headerFileName)
+    }
   )
 
   protected def execPOST(

openai-core/src/main/scala/io/cequence/openaiscala/service/OpenAIService.scala

@@ -213,6 +213,7 @@ trait OpenAIService extends OpenAIServiceConsts {
    */
   def uploadFile(
     file: File,
+    displayFileName: Option[String] = None,
     settings: UploadFileSettings = DefaultSettings.UploadFile
   ): Future[FileInfo]