`comparison`

Two or more subjects compared row by row.

Version 1 · schema comparison.v1.schema.json

Layouts

Every card type has full. Pick a layout with the element's layout attribute, render.layout, or a theme.

Fields

The fields of card.data. Values a source doesn't provide are null; new optional fields can appear within version 1.

Field	Type	Required	Notes
`subjects[]`	`object[]`	yes
`subjects[].name`	`string`	yes
`subjects[].image`	`image \| null`	yes
`subjects[].image.url`	`url`	yes	WebKnox media URL: https://webknox.com/media/v1/<host>/<path>. Treat it as opaque.
`subjects[].image.width`	`integer \| null`
`subjects[].image.height`	`integer \| null`
`subjects[].image.credit`	`string`	yes
`subjects[].image.license`	`string`	yes
`subjects[].image.source_url`	`url`	yes
`subjects[].source_url`	`url \| null`	yes
`rows[]`	`object[]`	yes
`rows[].label`	`string`	yes
`rows[].values[]`	`string[]`	yes	One per subject, same order.

Example

A recorded answer to “Ravens vs crows”. Open it in the Answer Lab to see every layout and style.

Response

1{
2  "v": 2,
3  "id": "ans_el59yzbu9b6gdzcw",
4  "matched": true,
5  "locale": "en",
6  "skill": "compare",
7  "confidence": 0.9,
8  "text": "Ravens are generally larger and heavier-billed than crows. Ravens often have wedge-shaped tails and deeper calls, while crows commonly make a familiar caw.\nSize: Generally larger (Ravens), Generally smaller (Crows)\nBill: Heavier, more curved (Ravens), Usually slimmer (Crows)\nTail: Often wedge-shaped (Ravens), Usually fan-shaped (Crows)\nCall: Deep croak (Ravens), Often a caw (Crows)",
9  "speech": "Ravens are generally larger and heavier-billed than crows. Ravens often have wedge-shaped tails and deeper calls, while crows commonly make a familiar caw.",
10  "card": {
11    "type": "comparison",
12    "version": 1,
13    "data": {
14      "subjects": [
15        {
16          "name": "Ravens",
17          "image": {
18            "url": "https://webknox.com/media/v1/thumb.wikimedia.org/wikipedia/commons/thumb/9/91/Corvus_corax_clarionensis%2C_Point_Reyes_National_Seashore.jpg/960px-Corvus_corax_clarionensis%2C_Point_Reyes_National_Seashore.jpg",
19            "width": 960,
20            "height": 640,
21            "credit": "Frank Schulenburg",
22            "license": "CC BY-SA 4.0",
23            "source_url": "https://commons.wikimedia.org/wiki/File:Corvus_corax_clarionensis,_Point_Reyes_National_Seashore.jpg"
24          },
25          "source_url": "https://en.wikipedia.org/wiki/Common_raven"
26        },
27        {
28          "name": "Crows",
29          "image": {
30            "url": "https://webknox.com/media/v1/upload.wikimedia.org/wikipedia/commons/a/a9/Corvus_corone_-near_Canford_Cliffs%2C_Poole%2C_England-8.jpg",
31            "width": 871,
32            "height": 929,
33            "credit": "Ian Kirk from Broadstone, Dorset, UK",
34            "license": "CC BY 2.0",
35            "source_url": "https://commons.wikimedia.org/wiki/File:Corvus_corone_-near_Canford_Cliffs,_Poole,_England-8.jpg"
36          },
37          "source_url": "https://en.wikipedia.org/wiki/Crow"
38        }
39      ],
40      "rows": [
41        {
42          "label": "Size",
43          "values": [
44            "Generally larger",
45            "Generally smaller"
46          ]
47        },
48        {
49          "label": "Bill",
50          "values": [
51            "Heavier, more curved",
52            "Usually slimmer"
53          ]
54        },
55        {
56          "label": "Tail",
57          "values": [
58            "Often wedge-shaped",
59            "Usually fan-shaped"
60          ]
61        },
62        {
63          "label": "Call",
64          "values": [
65            "Deep croak",
66            "Often a caw"
67          ]
68        }
69      ]
70    }
71  },
72  "sources": [
73    {
74      "name": "Wikimedia Commons",
75      "url": "https://commons.wikimedia.org",
76      "license": "per image"
77    }
78  ],
79  "follow_ups": [],
80  "actions": [],
81  "usage": {
82    "billable": true
83  }
84}