Spam Classify -> Spam Conversation, Spam Document

Author: valeriansaliou

README.md

@@ -405,22 +405,22 @@ client.Task.FraudSpamicity(mirage.RequestContext{}, mirage.FraudSpamicityRequest
 }
 ```
 
-#### ➡️ Spam Classify
+#### ➡️ Spam Conversation
 
-* **Method:** `client.Task.SpamClassify(ctx, data)`
-* **Reference:** [Spam Classify](https://docs.mirage-ai.com/references/api/v1/#spam-classify)
+* **Method:** `client.Task.SpamConversation(ctx, data)`
+* **Reference:** [Spam Conversation](https://docs.mirage-ai.com/references/api/v1/#spam-conversation)
 
 * **Request:**
 
 ```go
-client.Task.SpamClassify(mirage.RequestContext{}, mirage.SpamClassifyRequest {
-  Sender: mirage.SpamClassifyRequestSender {
+client.Task.SpamConversation(mirage.RequestContext{}, mirage.SpamConversationRequest {
+  Sender: mirage.SpamConversationRequestSender {
     Name: "John Doe",
     Email: "[email protected]",
   },
 
-  Transcript: []mirage.SpamClassifyRequestTranscript {
-    mirage.SpamClassifyRequestTranscript {
+  Transcript: []mirage.SpamConversationRequestTranscript {
+    mirage.SpamConversationRequestTranscript {
       From: "customer",
       Origin: "chat",
       Text: "Hello, I would like to discuss your services",
@@ -450,6 +450,43 @@ client.Task.SpamClassify(mirage.RequestContext{}, mirage.SpamClassifyRequest {
 }
 ```
 
+#### ➡️ Spam Document
+
+* **Method:** `client.Task.SpamDocument(ctx, data)`
+* **Reference:** [Spam Document](https://docs.mirage-ai.com/references/api/v1/#spam-document)
+
+* **Request:**
+
+```go
+client.Task.SpamDocument(mirage.RequestContext{}, mirage.SpamDocumentRequest {
+  Name: "Spammy Domain",
+  Domain: "spammy-domain.crisp.help",
+  Title: "Spammy title",
+  Content: "Spammy content",
+})
+```
+
+* **Response:**
+
+```json
+{
+  "reason": "processed",
+
+  "data": {
+    "class": "spam",
+    "confidence": 0.82,
+    "logprob": -0.10,
+
+    "scores": {
+      "gibberish": 0.0,
+      "marketing": 0.0,
+      "regular": 0.0,
+      "spam": 0.82
+    }
+  }
+}
+```
+
 ### Data API
 
 #### ➡️ Context Ingest

examples/task_spam_classify/main.go renamed to examples/task_spam_conversation/main.go

@@ -19,14 +19,14 @@ func main() {
   client := mirage.New(CONFIG_USER_ID, CONFIG_SECRET_KEY)
 
   // Spam classification on email messages
-  data, err := client.Task.SpamClassify(mirage.RequestContext{}, mirage.SpamClassifyRequest {
-    Sender: mirage.SpamClassifyRequestSender {
+  data, err := client.Task.SpamConversation(mirage.RequestContext{}, mirage.SpamConversationRequest {
+    Sender: mirage.SpamConversationRequestSender {
       Name: "John Doe",
       Email: "[email protected]",
     },
 
-    Transcript: []mirage.SpamClassifyRequestTranscript {
-      mirage.SpamClassifyRequestTranscript {
+    Transcript: []mirage.SpamConversationRequestTranscript {
+      mirage.SpamConversationRequestTranscript {
         From: "customer",
         Origin: "chat",
         Text: "Hello, I would like to discuss your services",
@@ -37,6 +37,6 @@ func main() {
   if err != nil {
     fmt.Printf("Error: %s", err)
   } else {
-    fmt.Printf("Spam classify results (raw): %s\n", data)
+    fmt.Printf("Spam conversation results (raw): %s\n", data)
   }
 }

examples/task_spam_document/main.go

@@ -0,0 +1,34 @@
+// go-mirage-api
+//
+// Copyright 2025, 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.SpamDocument(mirage.RequestContext{}, mirage.SpamDocumentRequest {
+    Name: "Spammy Domain",
+    Domain: "spammy-domain.crisp.help",
+    Title: "Spammy title",
+    Content: "Spammy content",
+  })
+
+  if err != nil {
+    fmt.Printf("Error: %s", err)
+  } else {
+    fmt.Printf("Spam document results (raw): %s\n", data)
+  }
+}

task_spam.go

@@ -6,59 +6,81 @@
 package mirage
 
 
-// SpamClassifyRequest mapping
-type SpamClassifyRequest struct {
-  Sender      SpamClassifyRequestSender        `json:"sender"`
-  Transcript  []SpamClassifyRequestTranscript  `json:"transcript"`
+// SpamConversationRequest mapping
+type SpamConversationRequest struct {
+  Sender      SpamConversationRequestSender        `json:"sender"`
+  Transcript  []SpamConversationRequestTranscript  `json:"transcript"`
 }
 
-// SpamClassifyRequestSender mapping
-type SpamClassifyRequestSender struct {
+// SpamConversationRequestSender mapping
+type SpamConversationRequestSender struct {
   Name   *string  `json:"name"`
   Email  *string  `json:"email"`
 }
 
-// SpamClassifyRequestTranscript mapping
-type SpamClassifyRequestTranscript struct {
+// SpamConversationRequestTranscript mapping
+type SpamConversationRequestTranscript struct {
   From    string  `json:"from"`
   Origin  string  `json:"origin"`
   Text    string  `json:"text"`
 }
 
+// SpamDocumentRequest mapping
+type SpamDocumentRequest struct {
+  Name     string  `json:"name"`
+  Domain   string  `json:"domain"`
+  Title    string  `json:"title"`
+  Content  string  `json:"content"`
+}
+
 
-// SpamClassifyResponseData mapping
-type SpamClassifyResponseData struct {
-  Data  *SpamClassifyResponse  `json:"data"`
+// SpamGenericResponseData mapping
+type SpamGenericResponseData struct {
+  Data  *SpamGenericResponse  `json:"data"`
 }
 
-// SpamClassifyResponse mapping
-type SpamClassifyResponse struct {
-  Class       string                      `json:"class"`
-  Confidence  float32                     `json:"confidence"`
-  LogProb     float32                     `json:"logprob"`
-  Scores      SpamClassifyResponseScores  `json:"scores"`
+// SpamGenericResponse mapping
+type SpamGenericResponse struct {
+  Class       string                     `json:"class"`
+  Confidence  float32                    `json:"confidence"`
+  LogProb     float32                    `json:"logprob"`
+  Scores      SpamGenericResponseScores  `json:"scores"`
 }
 
-// SpamClassifyResponseScores mapping
-type SpamClassifyResponseScores struct {
+// SpamGenericResponseScores mapping
+type SpamGenericResponseScores struct {
   Gibberish  float32  `json:"gibberish"`
   Marketing  float32  `json:"marketing"`
   Regular    float32  `json:"regular"`
   Spam       float32  `json:"spam"`
 }
 
 
-// String returns the string representation of SpamClassifyResponse
-func (instance SpamClassifyResponse) String() string {
+// String returns the string representation of SpamGenericResponse
+func (instance SpamGenericResponse) String() string {
   return Stringify(instance)
 }
 
 
-// SpamClassify spam check classification on spammy emails using a sender name, sender email and transcript.
-func (service *TaskService) SpamClassify(ctx RequestContext, data SpamClassifyRequest) (*SpamClassifyResponse, error) {
-  req, _ := service.client.NewRequest("POST", "task/spam/classify", data, ctx)
+// SpamConversation spam check classification for conversations on spammy emails using a sender name, sender email and transcript.
+func (service *TaskService) SpamConversation(ctx RequestContext, data SpamConversationRequest) (*SpamGenericResponse, error) {
+  req, _ := service.client.NewRequest("POST", "task/spam/conversation", data, ctx)
+
+  result := new(SpamGenericResponseData)
+  _, err := service.client.Do(req, result)
+  if err != nil {
+    return nil, err
+  }
+
+  return result.Data, err
+}
+
+
+// SpamDocument spam check classification for documents on spammy documents using a title, content, author name and author domain.
+func (service *TaskService) SpamDocument(ctx RequestContext, data SpamDocumentRequest) (*SpamGenericResponse, error) {
+  req, _ := service.client.NewRequest("POST", "task/spam/document", data, ctx)
 
-  result := new(SpamClassifyResponseData)
+  result := new(SpamGenericResponseData)
   _, err := service.client.Do(req, result)
   if err != nil {
     return nil, err

task_summarize.go

@@ -40,43 +40,28 @@ type SummarizeConversationRequestTranscript struct {
 }
 
 
-// SummarizeParagraphsResponseData mapping
-type SummarizeParagraphsResponseData struct {
-  Data  *SummarizeParagraphsResponse  `json:"data"`
+// SummarizeGenericResponseData mapping
+type SummarizeGenericResponseData struct {
+  Data  *SummarizeGenericResponse  `json:"data"`
 }
 
-// SummarizeParagraphsResponse mapping
-type SummarizeParagraphsResponse struct {
+// SummarizeGenericResponse mapping
+type SummarizeGenericResponse struct {
   Summary  string  `json:"summary"`
 }
 
-// SummarizeConversationResponseData mapping
-type SummarizeConversationResponseData struct {
-  Data  *SummarizeConversationResponse  `json:"data"`
-}
-
-// SummarizeConversationResponse mapping
-type SummarizeConversationResponse struct {
-  Summary  string  `json:"summary"`
-}
-
-
-// String returns the string representation of SummarizeParagraphsResponse
-func (instance SummarizeParagraphsResponse) String() string {
-  return Stringify(instance)
-}
 
-// String returns the string representation of SummarizeConversationResponse
-func (instance SummarizeConversationResponse) String() string {
+// String returns the string representation of SummarizeGenericResponse
+func (instance SummarizeGenericResponse) String() string {
   return Stringify(instance)
 }
 
 
 // SummarizeParagraphs summarize given paragraphs.
-func (service *TaskService) SummarizeParagraphs(ctx RequestContext, data SummarizeParagraphsRequest) (*SummarizeParagraphsResponse, error) {
+func (service *TaskService) SummarizeParagraphs(ctx RequestContext, data SummarizeParagraphsRequest) (*SummarizeGenericResponse, error) {
   req, _ := service.client.NewRequest("POST", "task/summarize/paragraphs", data, ctx)
 
-  result := new(SummarizeParagraphsResponseData)
+  result := new(SummarizeGenericResponseData)
   _, err := service.client.Do(req, result)
   if err != nil {
     return nil, err
@@ -87,10 +72,10 @@ func (service *TaskService) SummarizeParagraphs(ctx RequestContext, data Summari
 
 
 // SummarizeConversation summarize a given conversation, from a list of messages.
-func (service *TaskService) SummarizeConversation(ctx RequestContext, data SummarizeConversationRequest) (*SummarizeConversationResponse, error) {
+func (service *TaskService) SummarizeConversation(ctx RequestContext, data SummarizeConversationRequest) (*SummarizeGenericResponse, error) {
   req, _ := service.client.NewRequest("POST", "task/summarize/conversation", data, ctx)
 
-  result := new(SummarizeConversationResponseData)
+  result := new(SummarizeGenericResponseData)
   _, err := service.client.Do(req, result)
   if err != nil {
     return nil, err