Helix Search: Data model

This section details the five data models used by Helix Search.

ChangeModel

One instance of this represents single change in the Helix Server.

Name Description Type

type

Fixed string "change"

String

change

Helix Server change number

Long

date

Change date

Long

client

Helix Server client name

String

user

Helix Server user

String

restricted

Whether the change is restricted or not

Boolean

description

Change description

String

depotFile

Depot file path

String

ContentModel

One instance of this represents contents of single changed file in the Helix Server:

Name Description Type

type

Fixed string "content"

String

depotFile

Depot file path

String

rev

Helix Server revision number

Integer

change

Helix Server change number

Long

date

Change date

Long

fileName

File name

String

fileSize

File size in bytes

Long

fileType

File type, for example: text, binary, symlink, unicode, utf8, utf16. For more information on filetypes, see File Types in the Helix Core Command-Line (P4) Reference.

String

action

Helix Server action, for example: add and edit

String

user

User that submitted the change

String

contentType

Content type detected by the Tika library

String

content

The content of the file indexed by the Tika library

String

blur

The BlurHash for the thumbnail

String

detected

Auto-detected image tags. For <TagModel>, see TagModel.

List<TagModel>

RevisionModel

One instance of this represents single revision of a file in the Helix Server:

Name Description Type

type

Fixed string "revision"

String

change

Helix Server change number

Long

date

Change date

Long

depotFile

Depot file path

String

action

Helix Server action,for example: add and edit

String

fileType

File type, for example: text, binary, symlink, unicode, utf8, utf16. For more information on filetypes, see File Types in the Helix Core Command-Line (P4) Reference.

String

rev

Helix Server revision number

Integer

fileName

File name

String

fileSize

File size in bytes

Long

digest

An MD5 digest of the file represented by a 32 hexadecimal digit string

String

user

User that submitted the change

String

TagModel

One instance of this represents a single instance of an auto-detected tag on a file in the Helix Server:

Name Description Type

tag

Tag name

String

confidence

Confidence of detection (floating-point value from 0 to 1 where 1 represents 100%)

Float

positions

Optional: 1 or more x,y points locating the tag within the image. Stored as a floating-point value from top-left (0,0) to bottom-right (1,1)

List<Point2D.Float>

AssetModel

One instance of this represents a Helix DAM asset in the Helix Server:

Name Description Type

type

Fixed string "asset"

String

depotFile

Depot file path

String

rev

Helix Server revision number

Integer

blur

The BlurHash for the image

String

attributes

List of 'key' and 'value' pair of tags

List<AttributeModel>

customAttributes

Array of 'uuid' and 'value' pairs

JsonArray

change

Helix Server change number

Long

date

Change date

Long

fileName

File name

String

fileSize

File size in bytes

Long

fileType

File Type

String

action

Helix Server action, for example: add and edit

String

user

User that submitted the change

String