Merge pull request #44 from feedzai/develop

feat(fix): Updated the ReadMe mentioning 'context' as a requirement

README.md

@@ -55,9 +55,9 @@ cd autovizua11y
 | `type`                                         | Required            | string           | The type of data visualization. It is announced once a data visualization gets focused, after the title and before the descriptions.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `title`                                        | Required            | string           | The title of the visualization, which should be short and concise, showcasing the purpose of the content inside the data visualization. It is announced once a data visualization gets focused, before the type and the longer or shorter descriptions.                                                                                                                                                                                                                                                                                                                                                                  |
 | `insights`                                     | Required            | string           | Expects a `string` that corresponds to the key in the data object from which values will be used to derive statistical insights. For example, If the insights should be derived from the `amount` in the data, then that's what should be passed in this property. If an empty string `""` is passed, the user will receive an alert stating 'This shortcut does not work in this chart.' This applies to shortcuts related to minimum, average, and maximum values, as well as those involving comparisons to these insights and other data points. **Note: the values used for insights need to be of type `Number`.** |
+| `context`                                      | Required            | string           | The context in which the data visualization is present. It is passed in the prompt, when generating automatic the descriptions, resulting in contextualized outputs.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `descriptor`                                   | Optional            | string           | By receiving a `string`, this descriptor helps better contextualize what data elements are. It is added at the end of each data element. If no descriptor is provided, blank text (””) is set instead.                                                                                                                                                                                                                                                                                                                                                                                                                   |
 | `multiSeries`                                  | Optional            | string           | When working with multi-series data, provide a `string` that corresponds to the key in the data object that defines each series, allowing users to navigate between different series/clusters in addition to regular navigation. If an empty string `""` is passed, the tool interprets the data as single series.                                                                                                                                                                                                                                                                                                       |
-| `context`                                      | Optional            | string           | The context in which the data visualization is present. It is passed in the prompt, when generating automatic the descriptions, resulting in contextualized outputs.                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `shortcutGuide` <a id="shortcutGuideProp"></a> | Optional            | JSX.Element      | AutoVizuA11y has its default `NativeShortcutGuide` but you may create your own. The ShortcutGuide is wrapped in a `<dialog>`, and its reference can be obtained trought the property `dialogRef`, which you can add to your `shortcutGuide`. The `dialogRef` is a `RefObject<HTMLDialogElement>`, which you can use to create, for example, a button that handles the logic of closing this dialog.                                                                                                                                                                                                                      |
 | `autoDescriptions`                             | Required (option A) | object           | Various options regarding the creation of automatic descriptions with OpenAI models. AutoVizuA11y does two API calls per wrapped visualization, one for each type of description (longer and shorter). The options for this prop can be checked [here](#autoDescriptions-prop-options). This prop cannot be used at the same time as "manualDescriptions".                                                                                                                                                                                                                                                               |
 | `manualDescriptions`                           | Required (option B) | object           | Two manually written descriptions of the data. By providing this prop, no automatic descriptions are generated, thus not having any costs associated. The options for this prop can be checked [here](#manualdescriptions-prop-options). This prop cannot be used at the same time as "autoDescriptions".                                                                                                                                                                                                                                                                                                                |
@@ -143,6 +143,7 @@ function App() {
 				selectorType={{ element: "circle" }}
 				type="Multi line chart"
 				title="Latvia, Lithuania, and Croatia are among the countries where population is decreasing"
+				context="Interface with World data"
 				insights="y"
 				descriptor="millions"
 				multiSeries="series"