liamcripwell commited on
Commit
845d18b
·
verified ·
1 Parent(s): f1dd4b5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -1
README.md CHANGED
@@ -30,9 +30,12 @@ Support types include:
30
  * `integer` - a whole number.
31
  * `number` - a whole or decimal number.
32
  * `date-time` - ISO formatted date.
 
33
  * `enum` - a choice from set of possible answers (represented in template as an array of options, e.g. `["yes", "no", "maybe"]`).
34
  * `multi-label` - an enum that can have multiple possible answers (represented in template as a double-wrapped array, e.g. `[["A", "B", "C"]]`).
35
 
 
 
36
  The following is an example template:
37
  ```json
38
  {
@@ -46,7 +49,19 @@ The following is an example template:
46
  "languages_spoken": [["English", "French", "Japanese", "Mandarin", "Spanish"]]
47
  }
48
  ```
49
-
 
 
 
 
 
 
 
 
 
 
 
 
50
 
51
  ⚠️ We recommend using NuExtract with a temperature at or very close to 0. Some inference frameworks, such as Ollama, use a default of 0.7 which is not well suited to many extraction tasks.
52
 
 
30
  * `integer` - a whole number.
31
  * `number` - a whole or decimal number.
32
  * `date-time` - ISO formatted date.
33
+ * Array of any of the above types (e.g. `["string"]`)
34
  * `enum` - a choice from set of possible answers (represented in template as an array of options, e.g. `["yes", "no", "maybe"]`).
35
  * `multi-label` - an enum that can have multiple possible answers (represented in template as a double-wrapped array, e.g. `[["A", "B", "C"]]`).
36
 
37
+ If the model does not identify relevant information for a field, it will return `null` or `[]` (for arrays and multi-labels).
38
+
39
  The following is an example template:
40
  ```json
41
  {
 
49
  "languages_spoken": [["English", "French", "Japanese", "Mandarin", "Spanish"]]
50
  }
51
  ```
52
+ An example output:
53
+ ```json
54
+ {
55
+ "first_name": "Susan",
56
+ "last_name": "Smith",
57
+ "description": "A student studying computer science.",
58
+ "age": 20,
59
+ "gpa": 3.7,
60
+ "birth_date": "2005-03-01",
61
+ "nationality": "England",
62
+ "languages_spoken": ["English", "French"]
63
+ }
64
+ ```
65
 
66
  ⚠️ We recommend using NuExtract with a temperature at or very close to 0. Some inference frameworks, such as Ollama, use a default of 0.7 which is not well suited to many extraction tasks.
67