add delete message method

Author: michal.zyga

core/src/main/scala/sttp/openai/OpenAI.scala

@@ -25,7 +25,6 @@ import sttp.openai.requests.completions.chat.ChatRequestResponseData.ChatRespons
 import sttp.openai.requests.embeddings.EmbeddingsRequestBody.EmbeddingsBody
 import sttp.openai.requests.embeddings.EmbeddingsResponseBody.EmbeddingResponse
 import sttp.openai.requests.files.FilesResponseData._
-import sttp.openai.requests.{batch, finetuning}
 import sttp.openai.requests.finetuning._
 import sttp.openai.requests.images.ImageResponseData.ImageResponse
 import sttp.openai.requests.images.creation.ImageCreationRequestBody.ImageCreationBody
@@ -38,7 +37,7 @@ import sttp.openai.requests.threads.QueryParameters
 import sttp.openai.requests.threads.ThreadsRequestBody.CreateThreadBody
 import sttp.openai.requests.threads.ThreadsResponseData.{DeleteThreadResponse, ThreadData}
 import sttp.openai.requests.threads.messages.ThreadMessagesRequestBody.CreateMessage
-import sttp.openai.requests.threads.messages.ThreadMessagesResponseData.{ListMessagesResponse, MessageData}
+import sttp.openai.requests.threads.messages.ThreadMessagesResponseData.{DeleteMessageResponse, ListMessagesResponse, MessageData}
 import sttp.openai.requests.threads.runs.ThreadRunsRequestBody._
 import sttp.openai.requests.threads.runs.ThreadRunsResponseData.{ListRunStepsResponse, ListRunsResponse, RunData, RunStepData}
 import sttp.openai.requests.vectorstore.VectorStoreRequestBody.{CreateVectorStoreBody, ModifyVectorStoreBody}
@@ -49,6 +48,7 @@ import sttp.openai.requests.vectorstore.file.VectorStoreFileResponseData.{
   ListVectorStoreFilesResponse,
   VectorStoreFile
 }
+import sttp.openai.requests.{batch, finetuning}
 
 import java.io.{File, InputStream}
 import java.nio.file.Paths
@@ -769,6 +769,24 @@ class OpenAI(authToken: String, baseUri: Uri = OpenAIUris.OpenAIBaseUri) {
       .body(metadata)
       .response(asJson_parseErrors[MessageData])
 
+  /** Deletes a message.
+    *
+    * [[https://platform.openai.com/docs/api-reference/messages/deleteMessage]]
+    *
+    * @param threadId
+    *   The ID of the thread to which this message belongs.
+    *
+    * @param messageId
+    *   The ID of the message to delete.
+    *
+    * @return
+    *   Deletion status
+    */
+  def deleteMessage(threadId: String, messageId: String): Request[Either[OpenAIException, DeleteMessageResponse]] =
+    betaOpenAIAuthRequest
+      .delete(openAIUris.threadMessage(threadId, messageId))
+      .response(asJson_parseErrors[DeleteMessageResponse])
+
   /** Create an assistant with a model and instructions.
     *
     * [[https://platform.openai.com/docs/api-reference/assistants/createAssistant]]

core/src/main/scala/sttp/openai/OpenAISyncClient.scala

@@ -29,7 +29,7 @@ import sttp.openai.requests.threads.QueryParameters
 import sttp.openai.requests.threads.ThreadsRequestBody.CreateThreadBody
 import sttp.openai.requests.threads.ThreadsResponseData.{DeleteThreadResponse, ThreadData}
 import sttp.openai.requests.threads.messages.ThreadMessagesRequestBody.CreateMessage
-import sttp.openai.requests.threads.messages.ThreadMessagesResponseData.{ListMessagesResponse, MessageData}
+import sttp.openai.requests.threads.messages.ThreadMessagesResponseData.{DeleteMessageResponse, ListMessagesResponse, MessageData}
 import sttp.openai.requests.threads.runs.ThreadRunsRequestBody.{CreateRun, CreateThreadAndRun, ToolOutput}
 import sttp.openai.requests.threads.runs.ThreadRunsResponseData.{ListRunStepsResponse, ListRunsResponse, RunData, RunStepData}
 import sttp.openai.requests.vectorstore.VectorStoreRequestBody.{CreateVectorStoreBody, ModifyVectorStoreBody}
@@ -518,6 +518,22 @@ class OpenAISyncClient private (
   def modifyMessage(threadId: String, messageId: String, metadata: Map[String, String]): MessageData =
     sendOrThrow(openAI.modifyMessage(threadId, messageId, metadata))
 
+  /** Deletes a message.
+    *
+    * [[https://platform.openai.com/docs/api-reference/messages/deleteMessage]]
+    *
+    * @param threadId
+    *   The ID of the thread to which this message belongs.
+    *
+    * @param messageId
+    *   The ID of the message to delete.
+    *
+    * @return
+    *   Deletion status
+    */
+  def deleteMessage(threadId: String, messageId: String): DeleteMessageResponse =
+    sendOrThrow(openAI.deleteMessage(threadId, messageId))
+
   /** Create an assistant with a model and instructions.
     *
     * [[https://platform.openai.com/docs/api-reference/assistants/createAssistant]]

core/src/main/scala/sttp/openai/requests/threads/messages/ThreadMessagesResponseData.scala

@@ -65,6 +65,14 @@ object ThreadMessagesResponseData {
   object ListMessagesResponse {
     implicit val listMessagesResponseR: SnakePickle.Reader[ListMessagesResponse] = SnakePickle.macroR[ListMessagesResponse]
   }
+  case class DeleteMessageResponse(
+      `object`: String = "thread.message.deleted",
+      id: String,
+      deleted: Boolean
+  )
+  object DeleteMessageResponse {
+    implicit val deleteMessageResponseR: SnakePickle.Reader[DeleteMessageResponse] = SnakePickle.macroR[DeleteMessageResponse]
+  }
 
   sealed trait Annotation
 

core/src/test/scala/sttp/openai/fixtures/ThreadMessagesFixture.scala

@@ -138,4 +138,11 @@ object ThreadMessagesFixture {
       |  }
       |}
       |""".stripMargin
+
+  val jsonDeleteMessageResponse: String =
+    """{
+       |  "id": "msg_abc123",
+       |  "object": "thread.message.deleted",
+       |  "deleted": true
+       |}""".stripMargin
 }

core/src/test/scala/sttp/openai/requests/threads/messages/ThreadMessagesDataSpec.scala

@@ -7,7 +7,7 @@ import sttp.openai.fixtures
 import sttp.openai.json.{SnakePickle, SttpUpickleApiExtension}
 import sttp.openai.requests.completions.chat.message.Attachment
 import sttp.openai.requests.threads.messages.ThreadMessagesResponseData.Content.{TextContent, TextContentValue}
-import sttp.openai.requests.threads.messages.ThreadMessagesResponseData.{ListMessagesResponse, MessageData}
+import sttp.openai.requests.threads.messages.ThreadMessagesResponseData.{DeleteMessageResponse, ListMessagesResponse, MessageData}
 
 class ThreadMessagesDataSpec extends AnyFlatSpec with Matchers with EitherValues {
 
@@ -187,4 +187,20 @@ class ThreadMessagesDataSpec extends AnyFlatSpec with Matchers with EitherValues
     // then
     givenResponse.value shouldBe expectedResponse
   }
+
+  "Given delete message response as Json" should "be properly deserialized to case class" in {
+    import DeleteMessageResponse._
+    // given
+    val jsonResponse = fixtures.ThreadMessagesFixture.jsonDeleteMessageResponse
+    val expectedResponse: DeleteMessageResponse = DeleteMessageResponse(
+      id = "msg_abc123",
+      deleted = true
+    )
+
+    // when
+    val givenResponse: Either[Exception, DeleteMessageResponse] = SttpUpickleApiExtension.deserializeJsonSnake.apply(jsonResponse)
+
+    // then
+    givenResponse.value shouldBe expectedResponse
+  }
 }