🏷️ Make evidence value optional (#174)

* 📝 Make evidence value optional Signed-off-by: Evaline Ju <[email protected]> * 🏷️💡 Make evidence value optional Signed-off-by: Evaline Ju <[email protected]> --------- Signed-off-by: Evaline Ju <[email protected]>
foundation-model-stack · Aug 22, 2024 · de0aa8c · de0aa8c
1 parent 6ef348a
commit de0aa8c
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 17 deletions.
diff --git a/docs/api/openapi_detector_api.yaml b/docs/api/openapi_detector_api.yaml
@@ -370,7 +370,6 @@ components:
       type: object
       required:
         - name
-        - value
       title: Evidence
     EvidenceObj:
       properties:
@@ -397,7 +396,6 @@ components:
       type: object
       required:
         - name
-        - value
       title: EvidenceObj
     GenerationAnalysisHttpRequest:
       properties:

diff --git a/docs/api/orchestrator_openapi_0_1_0.yaml b/docs/api/orchestrator_openapi_0_1_0.yaml
@@ -615,7 +615,6 @@ components:
       type: object
       required:
         - name
-        - value
       title: Evidence
     EvidenceObj:
       properties:
@@ -641,7 +640,6 @@ components:
       type: object
       required:
         - name
-        - value
       title: EvidenceObj
     FinishReason:
       type: string

diff --git a/src/clients/detector.rs b/src/clients/detector.rs
@@ -162,9 +162,11 @@ impl ContentAnalysisRequest {
 pub struct Evidence {
     /// Evidence name
     pub name: String,
-    /// Evidence value
-    pub value: String,
+    /// Optional, evidence value
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub value: Option<String>,
     /// Optional, score for evidence
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub score: Option<f64>,
 }
 
@@ -173,9 +175,11 @@ pub struct Evidence {
 pub struct EvidenceObj {
     /// Evidence name
     pub name: String,
-    /// Evidence value
-    pub value: String,
+    /// Optional, evidence value
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub value: Option<String>,
     /// Optional, score for evidence
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub score: Option<f64>,
     /// Optional, evidence on evidence value
     // Evidence nesting should likely not go beyond this

diff --git a/src/models.rs b/src/models.rs
@@ -986,9 +986,11 @@ fn validate_detector_params(
 pub struct Evidence {
     // Name for the evidence
     pub name: String,
-    // Value for the evidence
-    pub value: String,
-    // Computed score for the value
+    // Optional, value for the evidence
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub value: Option<String>,
+    // Optional, computed score for the value
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub score: Option<f64>,
 }
 
@@ -997,11 +999,13 @@ pub struct Evidence {
 pub struct EvidenceObj {
     // Name for the evidence
     pub name: String,
-    // Value for the evidence
-    pub value: String,
-    // Computed score for the value
+    // Optional, value for the evidence
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub value: Option<String>,
+    // Optional, omputed score for the value
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub score: Option<f64>,
-    // Additional evidence
+    // Optional, additional evidence
     #[serde(skip_serializing_if = "Option::is_none")]
     pub evidence: Option<Vec<Evidence>>,
 }

diff --git a/src/orchestrator/unary.rs b/src/orchestrator/unary.rs
@@ -968,7 +968,7 @@ mod tests {
             evidence: Some(
                 [EvidenceObj {
                     name: "relevant chunk".into(),
-                    value: "What is capital of Brazil".into(),
+                    value: Some("What is capital of Brazil".into()),
                     score: Some(0.99),
                     evidence: None,
                 }]
@@ -988,7 +988,7 @@ mod tests {
             evidence: Some(
                 [EvidenceObj {
                     name: "relevant chunk".into(),
-                    value: "What is capital of Brazil".into(),
+                    value: Some("What is capital of Brazil".into()),
                     score: Some(0.99),
                     evidence: None,
                 }]