Info |
---|
Work in progress, some fields are not yet documented. |
Squirro items are represented in JSON format. This is true both for data loading and data consumption with the API. The following tables documents the properties a Squirro item can have.
Table of Contents
Table of Contents | ||||
---|---|---|---|---|
|
Common Fields
The fields in this table are used in both the data loading and data consumption APIs.
Field | Data type | Description | |||||
---|---|---|---|---|---|---|---|
id | Unique Identifier | While this field is called the same in data loading and consumption, it has different semantics. See the sections Data Loading Fields and Data Consumption Fields for details. | |||||
link | URL | Link to the item at its original location. | |||||
title | String | Item title. | |||||
body | HTML String | Item body. This field is in HTML format and special characters need to be escaped. | |||||
language | Language Codes | Content language of the item. If this is not specified, it is auto-detected based on the content. | |||||
created_at | Date and Time | Item creation date. Ideally this is the creation date of the item in its source system. If this is not specified for data loading, the import process goes through the following steps:
| |||||
webshot_url | URL | Main item picture. This image is displayed in the result list to represent the story. For data loading, the If this is not set, it is automatically extracted from the web site specified with the | |||||
webshot_height | Integer | Height of the webshot in pixels. | |||||
webshot_width | Integer | Width of the webshot in pixels. | |||||
keywords | Dictionary, values represented as lists | Keywords attached to the item. They are the structured information of an item.
Example item with keywords:
| |||||
location | |||||||
comments | |||||||
files |
When importing data into Squirro at least one of the fields title
, body
or files
must be set. All other fields are optional.
Data Loading Fields
These fields can be specified in the data loading APIs. They will be transformed and output with different names in the data consumption APIs.
Field | Data type | Description |
---|---|---|
id | Unique Identifier | External item identifier. When a value is specified here at import, it is written into the Used by data providers to reference their source system. Squirro uses this identifier for deduplication. |
summary | Text String | Item summary text. If not specified, this is generated from the |
webshot_picture_hint | URL | Main item picture. If this URL exists and can be downloaded, the image is archived by Squirro. The resulting URL is written into the Note: processing of webshots is disabled by default for custom data imports (bulk provider). |
Data Consumption Fields
Some fields are only available during data consumption because they are calculated on the fly or represent a user state. This table documents these fields.
...
Internal item identifier, generated by Squirro only.
...
External item identifier. See the id
field in the data loading fields for details.
...
Item abstract. This is generated from the summary
field, or if that field doesn't exist, from the body
.
In case the item is returned as a matching result to a query search, the abstract is calculated around the most relevant matching keywords.
...
This page can now be found atItem Format on the Squirro Docs site.