You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,7 +55,6 @@ cd autovizua11y
55
55
|`type`| Required | string | The type of data visualization. It is announced once a data visualization gets focused, after the title and before the descriptions. |
56
56
|`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. |
57
57
|`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`.**|
58
-
|`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. |
59
58
|`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. |
60
59
|`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. |
61
60
|`shortcutGuide` <aid="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. |
|`dynamicDescriptions`| Optional | boolean | Setting this to `false` stops the component from generating the two descriptions for that chart after the first render (the descriptions get saved in localstorage). This should be useful for static visualizations. |
78
76
|`apiKey`| Required | string | The OpenAI or OpenAI-compatible API key, enabling an LLM to generate human-like descriptions of the data visualization. [You can get yours here](https://platform.openai.com/account/api-keys), It is recommended for the developer to take the necessary precautions in order to hide the API key. |
77
+
|`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. |
78
+
|`dynamicDescriptions`| Optional | boolean | Setting this to `false` stops the component from generating the two descriptions for that chart after the first render (the descriptions get saved in localstorage). This should be useful for static visualizations. |
79
79
|`model`| Optional | string | The LLM responsible for generating both descriptions. [You can check the models available here](https://platform.openai.com/docs/models). If no model is provided, `gpt-3.5-turbo` will be chosen by `default`. |
80
80
|`baseUrl`| Optional | string | The base URL for the API compatible with the OpenAI [Chat Completions API](https://platform.openai.com/docs/api-reference/chat) endpoint. If no base URL is provided, `https://api.openai.com/v1/` (OpenAI) will be chosen by `default`. |
81
81
|`temperature`| Optional | number | A temperature, from `0` to `1`, used in the model responsible for generating both descriptions. Descriptions with temperatures closer to 0 should be more deterministic between API calls while those being closer to 1 should be more random between API calls. [You can check the models available here](https://platform.openai.com/docs/models). If no model is provided, `0` will be chosen by `default`. |
@@ -142,12 +142,12 @@ function App() {
142
142
selectorType={{ element:"rect" }}
143
143
type="bar chart"
144
144
title="Number of hours spent looking at a screen per day of the week."
145
-
context="Screen time dashboard"
146
145
insights="value"
147
146
descriptor="hours"
148
147
autoDescriptions={{
149
-
dynamicDescriptions:false,
150
148
apiKey:API_KEY,
149
+
context="Screen time dashboard"
150
+
dynamicDescriptions:false,
151
151
model:"gpt-3.5-turbo",
152
152
temperature:0.1,
153
153
}}
@@ -161,7 +161,6 @@ function App() {
161
161
selectorType={{ element:"circle" }}
162
162
type="Multi line chart"
163
163
title="Latvia, Lithuania, and Croatia are among the countries where population is decreasing"
164
-
context="Interface with World data"
165
164
insights="y"
166
165
descriptor="millions"
167
166
multiSeries="series"
@@ -179,7 +178,6 @@ function App() {
179
178
selectorType={{ element:"rect" }}
180
179
type="graphique à barres"
181
180
title="Temps d'écran par jour de la semaine"
182
-
context="Tableau de bord du temps d'écran"
183
181
insights="value"
184
182
descriptor="heures"
185
183
internationalization={{
@@ -237,12 +235,12 @@ The Shortcut Guide can be acessed by the user, using the <kbd>?</kbd> key, while
0 commit comments