Add Spam Classify

Author: valeriansaliou

README.md

@@ -405,6 +405,44 @@ client.Task.FraudSpamicity(mirage.FraudSpamicityRequest {
 }
 ```
 
+#### ➡️ Spam Classify
+
+* **Method:** `client.Task.SpamClassify(data)`
+* **Reference:** [Spam Classify](https://docs.mirage-ai.com/references/api/v1/#spam-classify)
+
+* **Request:**
+
+```go
+client.Task.SpamClassify(mirage.SpamClassifyRequest {
+  Sender: mirage.SpamClassifyRequestSender {
+    Name: "John Doe",
+    Email: "[email protected]",
+  },
+
+  Transcript: []mirage.SpamClassifyRequestTranscript {
+    mirage.SpamClassifyRequestTranscript {
+      From: "customer",
+      Origin: "chat",
+      Text: "Hello, I would like to discuss your services",
+    },
+  },
+})
+```
+
+* **Response:**
+
+```json
+{
+  "reason": "processed",
+
+  "data": {
+    "class": "spam",
+    "confidence": 0.13,
+    "logprob": -0.10
+  }
+}
+```
+
 ### Data API
 
 #### ➡️ Context Ingest

examples/task_spam_classify/main.go

@@ -0,0 +1,42 @@
+// go-mirage-api
+//
+// Copyright 2024, Valerian Saliou
+// Author: Valerian Saliou <[email protected]>
+
+package main
+
+import (
+  "github.com/mirage-ai-com/go-mirage-api"
+  "fmt"
+)
+
+const (
+  CONFIG_USER_ID = "ui_xxxxxx"
+  CONFIG_SECRET_KEY = "sk_xxxxxx"
+)
+
+func main() {
+  client := mirage.New(CONFIG_USER_ID, CONFIG_SECRET_KEY)
+
+  // Spam classification on email messages
+  data, err := client.Task.SpamClassify(mirage.SpamClassifyRequest {
+    Sender: mirage.SpamClassifyRequestSender {
+      Name: "John Doe",
+      Email: "[email protected]",
+    },
+
+    Transcript: []mirage.SpamClassifyRequestTranscript {
+      mirage.SpamClassifyRequestTranscript {
+        From: "customer",
+        Origin: "chat",
+        Text: "Hello, I would like to discuss your services",
+      },
+    },
+  })
+
+  if err != nil {
+    fmt.Printf("Error: %s", err)
+  } else {
+    fmt.Printf("Spam classify results (raw): %s\n", data)
+  }
+}

task_spam.go

@@ -0,0 +1,59 @@
+// go-mirage-api
+//
+// Copyright 2024, Valerian Saliou
+// Author: Valerian Saliou <[email protected]>
+
+package mirage
+
+
+// SpamClassifyRequest mapping
+type SpamClassifyRequest struct {
+  Sender      SpamClassifyRequestSender        `json:"sender"`
+  Transcript  []SpamClassifyRequestTranscript  `json:"transcript"`
+}
+
+// SpamClassifyRequestSender mapping
+type SpamClassifyRequestSender struct {
+  Name   string  `json:"name"`
+  Email  string  `json:"email"`
+}
+
+// SpamClassifyRequestTranscript mapping
+type SpamClassifyRequestTranscript struct {
+  From    string  `json:"from"`
+  Origin  string  `json:"origin"`
+  Text    string  `json:"text"`
+}
+
+
+// SpamClassifyResponseData mapping
+type SpamClassifyResponseData struct {
+  Data  *SpamClassifyResponse  `json:"data"`
+}
+
+// SpamClassifyResponse mapping
+type SpamClassifyResponse struct {
+  Class       string   `json:"class"`
+  Confidence  float32  `json:"confidence"`
+  LogProb     float32  `json:"logprob"`
+}
+
+
+// String returns the string representation of SpamClassifyResponse
+func (instance SpamClassifyResponse) String() string {
+  return Stringify(instance)
+}
+
+
+// SpamClassify spam check classification on spammy emails using a sender name, sender email and transcript.
+func (service *TaskService) SpamClassify(data SpamClassifyRequest) (*SpamClassifyResponse, error) {
+  req, _ := service.client.NewRequest("POST", "task/spam/classify", data)
+
+  result := new(SpamClassifyResponseData)
+  _, err := service.client.Do(req, result)
+  if err != nil {
+    return nil, err
+  }
+
+  return result.Data, err
+}