@attivio/suit

0.1.16

AbstractDocument

The basis for ingest and search documents.

new AbstractDocument(fields: Map<string, Array<string>>)
Parameters
fields (Map<string, Array<string>>)
Instance Members
fields

DataPoint

A single point of data in a time-based series.

new DataPoint(startTime: number, endTime: number, data: (number | null))
Parameters
startTime (number)
endTime (number)
data ((number | null))
Instance Members
startTime
endTime
data

FacetFilter

A facet filter for a query

new FacetFilter()
Instance Members
facetName
bucketLabel
filter

Placement

A query placement from a Business Center profile/campaign.

new Placement(label: string, linkUrl: (string | null), linkText: (string | null), imageUrl: (string | null), markup: (string | null))
Parameters
label (string)
linkUrl ((string | null))
linkText ((string | null))
imageUrl ((string | null))
markup ((string | null))
Instance Members
label
linkUrl
linkText
imageUrl
markup

Position

A geographic coordinate.

new Position(longitude: number, latitude: number)
Parameters
longitude (number)
latitude (number)
Instance Members
longitude
latitude

SearchFacetBucket

Details for a single value for a particular facet.

new SearchFacetBucket(value: any, label: string, count: number, filter: string, min: (string | null), max: (string | null), children: Array<SearchFacetBucket>, range: any)
Parameters
value (any)
label (string)
count (number)
filter (string)
min ((string | null) = null)
max ((string | null) = null)
children (Array<SearchFacetBucket> = [])
range (any)
Instance Members
displayLabel()
bucketKey()
value
label
count
filter
min
max
children
range

SearchFeedback

Feedback information about the query and how it was processed.

new SearchFeedback()
Instance Members
message
messageName
properties
stageName

SignalData

Signal data needed for doing click tracking, etc., with a document.

new SignalData()

SimplePrincipal

Principal object used by the Attivio server.

new SimplePrincipal(name: string, realm: string, groupMemberships: Array<SimplePrincipal>, type: ("user" | "group"))
Parameters
name (string)
realm (string)
groupMemberships (Array<SimplePrincipal> = [])
type (("user" | "group") = 'user')
Instance Members
name
realm
groupMemberships
type

FieldNames

The names of fields in the default Attivio schema that can be used to access values in a document.

new FieldNames()
Static Members
ID
ZONE
SCORE
RANDOM_SORT
FT_RETRY_COUNT
TITLE
LANGUAGE
LANGUAGES
DATE
SOURCEURI
TEXT
XML_DOM
SOURCEPATH
FILENAME
DOCTYPE
PARENT_DOCTYPE
CATEGORY
SENTIMENT
CONCEPTS
PEOPLE
ORGANIZATIONS
MIME_TYPE
PARENT_MIME_TYPE
CONTENT_POINTER
URI
HOSTNAME
ENCODING
SCORE_EXPLAIN
SIZE
PARENT_ID
PROGENATOR_ID
ANCESTOR_IDS
LINEAGE_IDS
POSITION
LATITUDE
LONGITUDE
CHILD_PATH
FIELD_NAMES
JOIN_CLAUSE_NAME
SOURCE_ENGINE
CONNECTOR_TYPE
DOC_STATUS
CONVERSION_ERROR
CONVERSION_ERROR_CODE
CONVERTED_FILE_PATH
CHILD_COUNT
CHILD_INDEX
TABLE
TEASER
ANCHOR_TEXT
DUPLICATES
CHECKSUM
JSON
PROCESSING_FEEDBACK_LEVEL
PROCESSING_FEEDBACK_MESSAGE
PROCESSING_FEEDBACK_COMPONENT
PROCESSING_FEEDBACK_ERROR_CODE
STATIC_FIELD_NAME
TAGS

SearchFacetStatistics

Statistics about the values in a given facet. Only applies to numeric fields.

new SearchFacetStatistics()
Instance Members
count
min
max
mean
midpoint
stdev
sum
var

SearchPlacement

A placement generated by the Attivio Business Center that you can display along with search results.

new SearchPlacement(label: (string | null), imageUrl: (string | null), linkText: (string | null), linkUrl: (string | null), markup: (string | null))
Parameters
label ((string | null) = null)
imageUrl ((string | null) = null)
linkText ((string | null) = null)
linkUrl ((string | null) = null)
markup ((string | null) = null)
Instance Members
label
imageUrl
linkText
linkUrl
markup

ADD

Add a document to the index. (implies a delete of any existing documents with the same ID prior to adding)

ADD

Type: string

SearchDocument

An individual document in a search result.

new SearchDocument(fields: Map<string, Array<string>>, signal: (SignalData | null), children: Array<SearchDocument>)

Extends AbstractDocument

Parameters
fields (Map<string, Array<string>>)
signal ((SignalData | null) = null)
children (Array<SearchDocument> = [])
Instance Members
signal
children

SearchFacet

A particular facet from a query, including all of its values.

new SearchFacet(name: string, field: string, label: string, count: number, buckets: Array<SearchFacetBucket>, statistics: (SearchFacetStatistics | null))
Parameters
name (string)
field (string)
label (string)
count (number)
buckets (Array<SearchFacetBucket> = [])
statistics ((SearchFacetStatistics | null) = null)
Instance Members
buckets
name
field
label
count
statistics

DateFormat

Enumerated values for possible date formats used by the formatDate() and formatDateString() methods.

new DateFormat()

Extends Enum

Signals

Encapsulates the default Attivio search behavior.

new Signals(baseUri: string)
Parameters
baseUri (string) the base URI for the Attivio instance to call when searching (including the protocol, hostname or IP address, and port number, with no trailing slash)
Instance Members
addSignal(doc, type, weight)

QueryResponse

The results of executing a query on the Attivio index.

new QueryResponse()
Instance Members
totalTime
totalHits
documents
facets
feedback
placements

SimpleQueryRequest

An object that embodies the various parameters needed to make a query of the Attivio index.

new SimpleQueryRequest(q: string, wf: string, ql: ("simple" | "advanced"), l: string, r: number, flt: Array<string>, f: Array<string>, s: Array<string>, fds: Array<string>, un: (string | null), rlm: (string | null), ff: Array<FacetFilter>, rp: Map<string, Array<string>>)
Parameters
q (string = '*:*')
wf (string = 'search')
ql (("simple" | "advanced") = 'simple')
l (string = 'en')
r (number = 10)
flt (Array<string> = [])
f (Array<string> = [])
s (Array<string> = [])
fds (Array<string> = [])
un ((string | null) = null)
rlm ((string | null) = null)
ff (Array<FacetFilter> = [])
rp (Map<string, Array<string>> = new Map())
Instance Members
workflow
query
queryLanguage
locale
rows
filters
facets
sort
fields
username
realm
facetFilters
restParams

DELETE

Delete a document from the index.

DELETE

Type: string

ATTIVIO

The ISO-like format that the Attivio APIs expect.

ATTIVIO

Type: string

Encapsulates the default Attivio search behavior.

new Search(baseUri: string, searchEngineType: ("attivio" | "solr" | "elastic"), customOptions: any)
Parameters
baseUri (string) the base URI for the Attivio instance to call when searching (including the protocol, hostname or IP address, and port number, with no trailing slash)
searchEngineType (("attivio" | "solr" | "elastic"))
customOptions (any)
Instance Members
simpleSearch(query, queryLanguage, offset, count, updateResults)

SimplePermission

A simplified version of the AttivioPermission class used by the Attivio REST APIs.

new SimplePermission(principal: (SimplePrincipal | null), readable: boolean)
Parameters
principal ((SimplePrincipal | null) = null)
readable (boolean = true)

ISO_8601

the ISO-8601 format, e.g., '2017-09-07T10:29-05:00'

ISO_8601

Type: string

SHORT_DATE

a short date with just numbers, e.g., '09/07/2017'

SHORT_DATE

Type: string

MEDIUM_DATE

a date using the abbreviated month name, e.g., 'Sep. 8, 2017'

MEDIUM_DATE

Type: string

PARTIAL

Update a document, adding in fields, retaining values for fields not contained in update document.

The exact semantics are engine dependent as some may only work on real time fields while others may work on any field in the document.

PARTIAL

Type: string

LONG_DATE

a date including the day of the week and the full month name: e.g., 'Thursday, September 8 2017'

LONG_DATE

Type: string

SHORT_TIME

A simple time format, e.g, '10:29 AM'

SHORT_TIME

Type: string

LONG_TIME

A full time format, with seconds: e.g., '10:29:52 AM'

LONG_TIME

Type: string

PARTIAL_APPEND_VALUES

Update a document, uniquely appending values to multi-value fields.

NOTE: This operation will only affect multi-value fields. Any updates to single value fields will be ignored.

PARTIAL_APPEND_VALUES

Type: string

SHORT_MONTH

The month and year of the date: e.g., 'Sep. 2017'

SHORT_MONTH

Type: string

LONG_MONTH

The month and year of the date: e.g., 'September 2017'

LONG_MONTH

Type: string

SHORT_YEAR

The abbreviated year: e.g. '17

SHORT_YEAR

Type: string

LONG_YEAR

The full year: e.g. 2017

LONG_YEAR

Type: string

SHORT

The short date and the short time, combined: e.g., '09/07/2017 10:29 AM'

SHORT

Type: string

PARTIAL_REMOVE_VALUES

Update a document, removing matching values from multi-value fields.

Fields in this update act as a blacklist, filtering multi-value fields in the previously indexed document.

NOTE: This operation will only affect multi-value fields. Any updates to single value fields will be ignored.

PARTIAL_REMOVE_VALUES

Type: string

SimpleIngestDocument

A simplified version of the IngestDocument class used by the Attivio REST APIs.

new SimpleIngestDocument(id: string, fields: Map<string, Array<string>>, mode: DocumentMode, zone: (string | null), correlationId: (string | null), permissions: Array<SimplePermission>)

Extends AbstractDocument

Parameters
id (string)
fields (Map<string, Array<string>>)
mode (DocumentMode = DocumentMode.ADD)
zone ((string | null) = null)
correlationId ((string | null) = null)
permissions (Array<SimplePermission> = [])
Instance Members
id
zone
mode
permissions

MEDIUM

The medium date and the short time, combined: e.g., 'Sep. 8 2017 10:29 AM'

MEDIUM

Type: string

LONG

The long date and the long time, combined: e.g., 'Thursday, September 8 2017 10:29 AM'

LONG

Type: string

DAY_OF_MONTH

The month and day of the month with no time or year: e.g., 'March 4'

DAY_OF_MONTH

Type: string

HOUR

A simple hour, in 12-hour format with AM or PM: e.g., '2 days ago'

HOUR

Type: string

CREATE

Create a document in the index. (does not imply delete of document prior to add)

This document mode should only be used during an initial feed of the index or in situations where the same document will never be feed twice. If the same document is added with this mode twice, the document will occur in the index twice.

CREATE

Type: string

AGO

A distance 'ago' in time before now: e.g., '2 days ago'

AGO

Type: string