Page Comparison

...

Field Data type Description

id

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:

If the files property is specified, Squirro tries to extract a creation date from the file metadata.
As a fallback the server's current date and time is used.

webshot_url

URL

Main item picture. This image is displayed in the result list to represent the story.

For data loading, the webshot_picture_hint field should be used, because the picture will then automatically be archived.

If this is not set, it is automatically extracted from the web site specified with the link property, generally by using the first story picture.

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.

Item keywords are offered as filter options in the search screen.
Keyword and their values are offered in the search field as type ahead options.
Search tagging, known entity extraction and /wiki/spaces/KB/pages/2949480 are used to add additional keywords to items.

Example item with keywords:

Code Block

language	js

{
  "title": "Our offices",
  "body": "We have offices in Munich, …",
  "keywords": {
    "country": ["Germany"],
    "city": ["Munich", "Berlin"]
  }
}

location

comments

files

Two-element list

The geographical location for the item. This is stored as a two-element list of floats, representing the latitude and longitude.

Example:

Code Block

language	js

{
  "title": "Our offices",
  "body": "We have offices in Munich, …",
  "location": [48.1059422, 11.5668324]
}

comments

List of dictionaries.

A list of comments that are attached to the item. The user can toggle the display of these comments in the web interface on top of the item body. Three fields can be added to comments:

Field Description

id External identifier of the comment. This field is mandatory.

type Type of the comment. The type twitter is treated specially, for all other types no special handling has been implemented.

body

Comment body. This field is in HTML format and special characters need to be escaped.

If the type has been set to twitter, this needs to be a valid embedded tweet (without the script tags).

files

List of dictionaries.

A list of files that are uploaded for the item. Note: this is modeled as a list, but only one file can currently be attached.

The fields for individual files are:

Field	Description
content	Base64-encoded content of the file to upload. This or the `url` field are mandatory.
url	URL where the file can be downloaded from. This or the `content` field are mandatory.
name	File name without path. Mandatory when the content field is provided. If the `url` field is provided, the name is derived from the URL by default.

When importing data into Squirro at least one of the fields title, body or files must be set. All other fields are optional.

...

Field Data type Description

id

Unique Identifier

Internal item identifier, generated by Squirro only.

external_id

String

External item identifier. See the id field in the data loading fields for details.

read Boolean True if the item has been read.

starred Boolean True if the item has been starred.

abstract

Text String

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.

score Float Relevant score of the item. This is only set when the result list is ordered by relevance.

thumbler_url Partial URL Used internally by Squirro to display thumbnails of the webshot_url field.

explanation

Dictionary

Returned for items when the explain_smartfilters option is used in the Get Item resource. The dictionary contains a list of fields, for each of which the matching Smart Filter tokens are listed.

Example:

Code Block

language	js

{
  …
  "explanation

related_items

": {
    "matches": {
      "summary.stemmed": [
        {"term": "eliminated", "score": 0.010479515},
        {"term": "equipped", "score": 0.00846127}
      ],
      "body.stemmed": [
        {"term": "eliminated", "score": 0.010341313000000001},
        {"term": "equipped", "score": 0.008302803000000001}
      ],
      "language_code": [
        {"term": "en", "score": 0.0009886466000000001}
      ]
    }
  }
}

related_items

List

Returned when the filter_related_items option is set in the List Items resource. A list of dictionaries which contain the field id of any related (duplicate) items.

Example:

Code Block

language	js

{
  …
  "related_items": [
    {"id": "UfA8Ah08TeSLSUo-RBzm7Q"},
    {"id": "tjiS4mjaTgupKaIiZisYww"}
  ]
}

sub_items

highlight_matches

matching_sub_items

has_matching_sub_items

explain_smartfilters

Versions Compared

Old Version 2

New Version 3

Key