Documentation
Standard Schema
We believe that a consistent wording of metadata (same should be named the same and different things different) is key to an easy integration of your content sources into enterprise search or into retrieval augmented generation. Therefore, we follow the following wording for our search schemas.
All connectors will fill a subset of these fields and the search interface will use these for rendering search results and filters.
Fieldname | Type | Semantics |
|---|---|---|
id | String | Unique id of this item |
title | String | |
url | String | Clickable URL |
body | byte[] | Document body of this item (e.g. HTML for a web page or bytes for an Excel) |
parentItemTitle | String | Title of the parent item, for instance a space |
parentItemUrl | String | Url of the parent item, for instance a space |
rootItemUrl | String | Title of the content source |
rootItemTitle | String | Url of the content source |
attachmentParentTitle | String | Title of the parent item of an attachment, for instance of a page |
attachmentParentUrl | String | Url of the parent item of an attachment, for instance of a page |
itemType | String | Determines the item type in a human-friendly way. For instance PDF document, web page, wiki page, issue or card) |
fileExtension | String | Is the file extension of this document, if applicable |
iconSvg | String | Contains an SVG which can be used for rendering of a standartized icon for this item |
lastModifiedDate | Date | Date, when the item was last modified |
createdDate | Date | Date, when the item was created |
allow_acl | List<String> | Allow access control list which comprises user Ids and group Ids |
deny_acl | List<String> | Deny access control list which comprises user Ids and group Ids (which are excluded from access to this item) |
authors | List<String> | Author names (display names) of this item |
authorsMail | List<String> | Mail addresses of the authors. |
creators | List<String> | Creator name (display name) of this item |
keywords | List<String> | Is a list of keywords or tags. |
Additional Schema Fields | ||
iconUrl | String | Can be used to use own icon material for items. |
iconBytes | String | Bytes as used for e.g. Jira Project images |
assignee | String | Determines the assignee at indexing time of an issue |
status | List<String> | Status of an issue |
previewImageUrl | String | Contains a link to a static preview image URL, if the content source supports it. For instance our SharePoint and SharePoint Online connectors fill this field. |
interactivePreviewUrl | String | Contains a link to an interactive preview, if the content source supports it. For instance our SharePoint and SharePoint Online connectors fill this field. |
comment | List<String> | A list of comments, for instance for wiki pages, issues |
commitId | List<String> | Is the unique id of a commit, as given by our Git connectors. |
profilePictureUrl | String | Profile information. Link to a profile picture. |
mobilePhone | String | Profile information |
businessPhone | String | Profile information |
jobTitle | String | Profile information |
department | String | Profile information |
officeLocation | String | Profile information |
mailAddress | String | Profile information |
userPrincipalName | String | Profile information |
city | String | Profile information |
zipCode | String | Profile information |
street | String | Profile information |
country | String | Profile information |
position | String | Profile information |
language | String | Is optionally used if a content language is given |
Dates
Dates will in particular be provided in the format yyyy-MM-dd'T'HH:mm:ss.SSSZ.