Change interesting_score to sort_score (#558)

* change interesting_score to sort_score

* renaming

Author: djstrong

apps/api.nameai.dev/nameai/models.py

@@ -53,9 +53,9 @@ class NameAIReport(BaseModel):
         ge=0.0,
         le=1.0,
     )
-    interesting_score: float = Field(
-        title='Interesting score of the input',
-        description='Score indicating how interesting/memorable the name is. For single labels, returns the score directly. For 2-label names (e.g., "nick.eth"), returns the score for the first label ("nick"). For 3 or more labels, returns 0. If the label is not inspected, this field will be 0. The score ranges from 0.0 to 1.0 inclusive, where 0.0 indicates least interesting and 1.0 indicates most interesting.',
+    sort_score: float = Field(
+        title='Sort score of the input',
+        description='Score indicating the relative ranking of the name. For single labels, returns the score directly. For 2-label names (e.g., "nick.eth"), returns the score for the first label ("nick"). For 3 or more labels, returns 0. If the label is not inspected, this field will be 0. The score ranges from 0.0 to 1.0 inclusive, where 0.0 indicates lowest rank and 1.0 indicates highest rank.',
         ge=0.0,
         le=1.0,
     )

apps/api.nameai.dev/nameai/name_ai.py

@@ -23,11 +23,11 @@ def inspect_label(self, label: str) -> NameAIResponse:
 
         if nameguard_report.inspected:
             nlp_analysis = self.nlp_inspector.nlp_analyse_label(label)
-            purity, interesting = self.scorer.score_label(nlp_analysis)
+            purity, sort_score = self.scorer.score_label(nlp_analysis)
 
             nameai_report = NameAIReport(
                 purity_score=purity,
-                interesting_score=interesting,
+                sort_score=sort_score,
                 analysis=NLPLabelAnalysis(
                     inspection=nlp_analysis.inspection,
                     status=nlp_analysis.status,
@@ -41,7 +41,7 @@ def inspect_label(self, label: str) -> NameAIResponse:
         else:
             nameai_report = NameAIReport(
                 purity_score=0,
-                interesting_score=0,
+                sort_score=0,
                 analysis=None,
             )
 
@@ -67,7 +67,7 @@ def inspect_name(self, name: str) -> NameAIResponse:
             nlp_analysis = self.nlp_inspector.nlp_analyse_label(labels[0])
             nameai_report = NameAIReport(
                 purity_score=0,
-                interesting_score=0,
+                sort_score=0,
                 analysis=NLPLabelAnalysis(
                     inspection=nlp_analysis.inspection,
                     status=nlp_analysis.status,
@@ -81,7 +81,7 @@ def inspect_name(self, name: str) -> NameAIResponse:
         else:
             nameai_report = NameAIReport(
                 purity_score=0,
-                interesting_score=0,
+                sort_score=0,
                 analysis=None,
             )
 

apps/api.nameai.dev/nameai/nameai_api.py

@@ -124,7 +124,7 @@ async def inspect_name_get(
 
     For names with multiple labels:
     - If the name has 2 labels (e.g., "nick.eth"), the analysis is performed on the first label ("nick").
-    - For 3 or more labels, only the first label is analyzed, but the NameRank scores (purity and interesting) are set to 0.
+    - For 3 or more labels, only the first label is analyzed, but the NameRank scores (purity and sort score) are set to 0.
 
     This endpoint does not perform automated labelhash resolution.
 
@@ -152,7 +152,7 @@ async def inspect_name_post(request: InspectNameRequest) -> NameAIResponse:
 
     For names with multiple labels:
     - If the name has 2 labels (e.g., "nick.eth"), the analysis is performed on the first label ("nick").
-    - For 3 or more labels, only the first label is analyzed, but the NameRank scores (purity and interesting) are set to 0.
+    - For 3 or more labels, only the first label is analyzed, but the NameRank scores (purity and sort score) are set to 0.
 
     This endpoint does not perform automated labelhash resolution.
 

apps/api.nameai.dev/nameai/scorer.py

@@ -14,11 +14,11 @@ def __init__(self):
 
     def score_label(self, label_analysis: NLPLabelAnalysis) -> Tuple[float, float]:
         """
-        Calculates the purity_score and interesting_score of the label.
-        Returns (purity_score, interesting_score).
+        Calculates the purity_score and sort_score of the label.
+        Returns (purity_score, sort_score).
         """
         purity = None
-        interesting = None
+        sort_score = None
 
         if self.label_is_unknown(label_analysis):
             # first check namehash because it is detected as not normalized
@@ -49,12 +49,12 @@ def score_label(self, label_analysis: NLPLabelAnalysis) -> Tuple[float, float]:
                 purity = 11
             elif self.word_count(label_analysis) == 0:
                 purity = 12
-            # everything above will have purity == interesting
+            # everything above will have purity == sort_score
             elif self.word_count(label_analysis) > 0:
                 if not label_analysis.probability:
-                    interesting = 13
+                    sort_score = 13
                 else:
-                    interesting = 13 + min(-1 / label_analysis.log_probability, 1.0)
+                    sort_score = 13 + min(-1 / label_analysis.log_probability, 1.0)
 
                 if self.word_count(label_analysis) >= 4:
                     purity = 13
@@ -68,13 +68,13 @@ def score_label(self, label_analysis: NLPLabelAnalysis) -> Tuple[float, float]:
             if purity is not None:
                 purity += self.short_label_bonus(label_analysis)
 
-        if interesting is None:
-            interesting = purity
+        if sort_score is None:
+            sort_score = purity
 
-        if purity is None or interesting is None:
+        if purity is None or sort_score is None:
             raise ValueError('error in scorer algorithm')
 
-        return purity / 17, interesting / 14
+        return purity / 17, sort_score / 14
 
     def label_length(self, label_analysis: NLPLabelAnalysis) -> int:
         # not using char_length because it is only available in the normalized response model

apps/api.nameai.dev/tests/test_nameai.py

@@ -18,7 +18,7 @@ def nameai():
 def test_normalized(nameai: 'NameAI'):
     result = nameai.inspect_label('nick')
     assert abs(result.nameai.purity_score - 0.9976234705882353) < 0.0001, result.nameai.purity_score
-    assert abs(result.nameai.interesting_score - 0.9354685918689098) < 0.0001, result.nameai.interesting_score
+    assert abs(result.nameai.sort_score - 0.9354685918689098) < 0.0001, result.nameai.sort_score
     assert result.nameai.analysis.status == 'normalized'
     assert abs(result.nameai.analysis.probability - 0.0000317942695746393) < 0.0001, result.nameai.analysis.probability
     assert (
@@ -32,25 +32,25 @@ def test_name(nameai: 'NameAI'):
     result = nameai.inspect_name('')
     assert result.nameai.analysis.inspection.label == ''
     assert result.nameai.purity_score == 0
-    assert result.nameai.interesting_score == 0
+    assert result.nameai.sort_score == 0
     assert result.nameai.analysis.status == 'normalized'
 
     result = nameai.inspect_name('nick')
     assert result.nameai.analysis.inspection.label == 'nick'
     assert abs(result.nameai.purity_score - 0.9976234705882353) < 0.0001, result.nameai.purity_score
-    assert abs(result.nameai.interesting_score - 0.9354685918689098) < 0.0001, result.nameai.interesting_score
+    assert abs(result.nameai.sort_score - 0.9354685918689098) < 0.0001, result.nameai.sort_score
     assert result.nameai.analysis.status == 'normalized'
 
     result = nameai.inspect_name('nick.eth')
     assert result.nameai.analysis.inspection.label == 'nick'
     assert abs(result.nameai.purity_score - 0.9976234705882353) < 0.0001, result.nameai.purity_score
-    assert abs(result.nameai.interesting_score - 0.9354685918689098) < 0.0001, result.nameai.interesting_score
+    assert abs(result.nameai.sort_score - 0.9354685918689098) < 0.0001, result.nameai.sort_score
     assert result.nameai.analysis.status == 'normalized'
 
     result = nameai.inspect_name('nick.eth.eth')
     assert result.nameai.analysis.inspection.label == 'nick'
     assert result.nameai.purity_score == 0
-    assert result.nameai.interesting_score == 0
+    assert result.nameai.sort_score == 0
     assert result.nameai.analysis.status == 'normalized'
 
 

apps/api.nameai.dev/tests/test_nlp_inspector.py

@@ -31,7 +31,7 @@ def test_inspector_tokenize(nlp_inspector: 'NLPInspector', input, output):
     assert tokenized_labels[0]['tokens'] == tuple(output)
 
 
-def test_inspector_interesting_score_precision(nlp_inspector: 'NLPInspector'):
+def test_inspector_sort_score_precision(nlp_inspector: 'NLPInspector'):
     lab1 = 'mrscopcake'
     lab2 = 'likemrscopcake'
     resp1 = nlp_inspector.nlp_analyse_label(lab1)
@@ -47,7 +47,7 @@ def test_inspector_prob_when_word_count_null_0(nlp_inspector: 'NLPInspector'):
     assert resp.log_probability < -100000
 
 
-def test_inspector_interesting_score(nlp_inspector: 'NLPInspector'):
+def test_inspector_sort_score(nlp_inspector: 'NLPInspector'):
     lab1 = 'ilikeyourcat'
     lab2 = 'catlikeiyour'
     resp1 = nlp_inspector.nlp_analyse_label(lab1)

apps/nameai.dev/app/sort/client.tsx

@@ -20,12 +20,12 @@ export function Client({ initialLabels }: { initialLabels: LabelItem[] }) {
         const result = await nameai.inspectName(label);
         const newLabelItem = {
           label,
-          interestingScore: result.nameai.interesting_score,
+          sortScore: result.nameai.sort_score,
         };
         setLabels((prevLabels) => {
           const updatedLabels = [...prevLabels, newLabelItem];
           return updatedLabels.sort(
-            (a, b) => b.interestingScore - a.interestingScore,
+            (a, b) => b.sortScore - a.sortScore,
           );
         });
       } else {

apps/nameai.dev/app/sort/list.tsx

@@ -13,7 +13,7 @@ export function SortedList({ labels }: { labels: LabelItem[] }) {
           <span className="font-bold">{item.label}</span>
           <div className="flex items-center gap-2">
             <span className="text-sm text-gray-600">
-              {item.interestingScore.toFixed(4)}
+              {item.sortScore.toFixed(4)}
             </span>
           </div>
         </li>

apps/nameai.dev/app/sort/page.tsx

@@ -5,7 +5,7 @@ import { Client } from "./client";
 
 export interface LabelItem {
   label: string;
-  interestingScore: number;
+  sortScore: number;
 }
 
 const defaultLabels = ["vitalik", "ethereum", "web3", "blockchain", "defi"];
@@ -16,12 +16,12 @@ async function getInitialLabelsItems(): Promise<LabelItem[]> {
       const result = await nameai.inspectName(label);
       return {
         label,
-        interestingScore: result.nameai.interesting_score,
+        sortScore: result.nameai.sort_score,
       };
     }),
   );
 
-  return loadedNames.sort((a, b) => b.interestingScore - a.interestingScore);
+  return loadedNames.sort((a, b) => b.sortScore - a.sortScore);
 }
 
 export default async function SortPage() {

packages/nameai-sdk/src/index.test.ts

@@ -15,7 +15,7 @@ describe("inspectName", () => {
     const data = await nameai.inspectName("vitalìk.eth");
 
     expect(data.nameai.purity_score).toBeCloseTo(0.28995870588235295, 2);
-    expect(data.nameai.interesting_score).toBeCloseTo(0.3520927142857143, 2);
+    expect(data.nameai.sort_score).toBeCloseTo(0.3520927142857143, 2);
   });
 });
 
@@ -30,7 +30,7 @@ describe("inspectName edge cases", () => {
     const longName = "a".repeat(MAX_INSPECTED_NAME_CHARACTERS + 1) + ".eth";
     const data = await nameai.inspectName(longName);
     expect(data.nameai.purity_score).toBe(0);
-    expect(data.nameai.interesting_score).toBe(0);
+    expect(data.nameai.sort_score).toBe(0);
   });
 
   it("should handle empty name", async () => {