fix(api): Updated documentation related to score field

freelawproject · Nov 20, 2024 · c37e051 · c37e051
1 parent 0114e21
commit c37e051
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/cl/api/templates/search-api-docs-vlatest.html b/cl/api/templates/search-api-docs-vlatest.html
@@ -93,7 +93,10 @@ <h2 id="usage">Basic Usage</h2>
             "lexisCite": "",
             "meta": {
                 "timestamp": "2024-06-22T10:26:35.320787Z",
-                "date_created": "2022-06-26T23:24:18.926040Z"
+                "date_created": "2022-06-26T23:24:18.926040Z",
+                "score": {
+                    "bm25": 2.1369965
+                }
             },
             "neutralCite": "",
             "non_participating_judge_ids": [],
@@ -249,6 +252,10 @@ <h3 id="notes">Special Notes</h3>
       <p>This field only displays Opinion text content.
       </p>
     </li>
+    <li>
+      <p>The <code>meta</code> field in main documents contains the <code>score</code> field, which is currently a hash that includes the <code>bm25</code> score used by Elasticsearch to rank results. Additional scores may be introduced in the future.
+      </p>
+    </li>
   </ol>