Show documents as cards
get_document_carouselUse this when a person wants to see documents that search_documents or get_document returned: it shows up to three of them as a carousel of cards, each with the document's title, summary, size, number of pages and preview image, a button that opens the PDF and a link to contact the organisation. Pass the id of each document to show, taken from the id of its card, at most three. A document that is not published for this website is left out, and when none can be shown the answer is the one get_document gives for a document that is not found. Do not use it to find documents: call search_documents for that. A client that does not show cards receives the same answer as text.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | Yes | The id of each document to show, as search_documents and get_document give it: at most three. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | The documents, each as a card. | |
| message | No | Why there are no documents, in plain words, when there are none. | |
| available | Yes | False when the documents cannot be read now (reasonCode says why); true for every other answer, one with no documents included. | |
| reasonCode | Yes | A stable code that says why the documents cannot be read, and an empty string when they can. | |
| schemaVersion | Yes | The version of the shape of this answer: 1. |