1.1.0The basis for ingest and search documents.
A single point of data in a time-based series.
A facet filter for a query
A query placement from a Business Center profile/campaign.
(string)
((string | null))
((string | null))
((string | null))
((string | null))
A geographic coordinate.
Details for a single value for a particular facet.
(any)
(string)
(number)
(string)
((string | null)
= null)
((string | null)
= null)
(Array<SearchFacetBucket>
= [])
(any)
The value of the bucket
Type: any
If present (generally for filter facet requests or range facets), the label to display as the facet bucket's value instead of the value field
Type: (string | null)
The filter that can be used to limit the original query to only show documents matching this value
Type: string
The minimum, or "from," value for the bucket's range (for range facets only)
Type: (string | null)
The maximum, or "to," value for the bucket's range (for range facets only)
Type: (string | null)
Any child buckets
Type: Array<SearchFacetBucket>
The range if this is a range facet
Type: any
Feedback information about the query and how it was processed.
Signal data needed for doing click tracking, etc., with a document.
(string
= '')
(number
= -1)
(string
= '')
(string
= '')
(string
= '')
(string
= '')
(number
= 0)
(string
= '')
(number
= 1)
(number
= 0)
(boolean
= true)
(string
= '')
(number
= 1)
Principal object used by the Attivio server.
"user" | "group"))(string)
(string)
(Array<SimplePrincipal>
= [])
(("user" | "group")
= 'user')
Any groups the principal belongs to (they should all have their type field set to 'group')
Type: Array<SimplePrincipal>
Whether this is a user or a group
Type:
("user" | "group")
The names of fields in the default Attivio schema that can be used to access values in a document.
The internal field that holds the document id.
The internal field used for populating/querying the zone for a document.
The virtual field used for requesting/sorting by the score for a document.
The virtual field used for sorting documents randomly
Field indicating the maximum number of times an IngestDocument will be retried for fault tolerance
The field that holds the title of the document; string.
The field that holds the document's primary language; string.
The field that holds the languages that are contained in the document in addition to primary language; string.
The field that holds the date.
The field that holds the source URI of the document; string.
The field where the primary raw text content for the document is placed.
The field for XML represented as DOM4J Document.
The field that contains the filepath of the document. Default: 'sourcepath'
The field that contains the filename of the document.
The field that contains the document type.
The field that contains the parent document type.
The field that holds the category of the document.
The field that contains the sentiment of the document.
The field that contains the concepts of the document.
The field that contains people mentioned in the document.
The field that contains organizations mentioned in the document.
The field that contains the MIME type. Value = 'mimetype'
The field that holds the parent MIME type, if any.
The field that holds the document content specified as a byte array.
The field that contains the URI of a document.
The field that contains the hostname of a document.
The field that contains the default document string encoding.
The field that will contain the explain map for scoring in a SearchDocument.
The field that will store a document's original size.
The field that will store the document id of the parent document.
The field that will store the document id of the parent document.
The field that will store the ID's of documents that are ancestors of a given document.
Name of the field that will store the IDs of containers (typically, folders) that are ancestors of a given document in a particular data source. Also includes the ID of the document itself and is primarily used for document deletions.
Name of the field that will store encoded position for geo search.
Name of the field that will store latitude information for geo search.
Name of the field that will store longitude information for geo search.
Name of the field that will store the name or path of the child document by which it is referred to in the parent document. For example, 'dir1/dir2/doc1.txt' would be the value for a ZIP archive entry 'dir1/dir2/doc1.txt'.
This field contains the name of all fields indexed for a document.
This is the field that will return the name of the join clause (if annotated) for child documents.
This field contains the engine name that the document came from. Primarily used in federation scenarios at response time to indicate where a document came from for front end presentation purposes.
This field holds the name of the connector type. Useful to know what connector was used to bring a doc into index.
This field holds internal document status values.
This field holds document conversion error strings.
This field holds document conversion error codes.
This field holds document conversion error codes.
This field holds the count of the number of children a particular document has.
This field holds the index of the child.
This field holds the commonly used table designation for a record for join-based applications.
This field holds all of the anchor text for the links that point to this page/document.
This field holds the number of inbound links that point to this page/document.
This field holds the a scaled factor of the number of inbound links that point to this page/document. This field is primarily used for relevancy weighting purposes.
This field holds a list of duplicate uris or doc ids of this page/document.
This field holds the SHA-256 checksum of this page/document.
Field for unparsed JSON text
Field for level of processing feedback
Field for message of processing feedback
Field for component of processing feedback
Field for error code of processing feedback
Field containing the list of static field names
Dynamic field containing any user-added tags on the document
Statistics about the values in a given facet. Only applies to numeric fields.
A placement generated by the Attivio Business Center that you can display along with search results.
((string | null)
= null)
((string | null)
= null)
((string | null)
= null)
((string | null)
= null)
((string | null)
= null)
A single comment for a SearchDocument.
Add a document to the index. (implies a delete of any existing documents with the same ID prior to adding)
Type: string
An individual document in a search result.
Extends AbstractDocument
((SignalData | null)
= null)
(Array<SearchDocument>
= [])
Signal data that is included if requested
Type: (SignalData | null)
An array of any child documents (e.g., as the result of performing a JOIN in the query).
Type: Array<SearchDocument>
A particular facet from a query, including all of its values.
(string)
(string)
(string)
(number)
(Array<SearchFacetBucket>
= [])
((SearchFacetStatistics | null)
= null)
The facet buckets (the various values for the facet that can be used to limit the query)
Type: Array<SearchFacetBucket>
The human-readable label for this facet, usually the name of the field being faceted on
Type: string
Statistics for the facet (only available for numeric fields)
Type: (SearchFacetStatistics | null)
Enumerated values for possible date formats used by the formatDate() and formatDateString() methods.
Extends Enum
The results of executing a query on the Attivio index.
The total amount of time, in milliseconds, it took to perform the query
Type: number
An array of documents matching the query (limited by the offset and rows parameters in the search request)
Type: Array<SearchDocument>
An array of facets applicable to the query
Type: Array<SearchFacet>
An array of feedback objects from performing the query
Type: Array<SearchFeedback>
An array of Attivio-Business-Center-generated placements for the query
Type: Array<SearchPlacement>
Encapsulates the default Attivio search behavior.
(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)
Add a signal for the given document. If the document has no signal information inside it, this method does nothing.
Add a signal for the given SignalData.
(SignalData)
An object that embodies the various parameters needed to make a query of the Attivio index.
"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>>)(string
= '*:*')
(string
= 'search')
(("simple" | "advanced")
= 'simple')
(string
= 'en')
(number
= 10)
((string | null)
= null)
((string | null)
= null)
(Array<FacetFilter>
= [])
Whether the query is in Simple Query Language or Advanced Query Language
Type:
("simple" | "advanced")
Any facet filters to apply to the query
Type: Array<FacetFilter>
Delete a document from the index.
Type: string
The ISO-like format that the Attivio APIs expect.
Type: string
Encapsulates the default Attivio search behavior.
(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)
(("attivio" | "solr" | "elastic"))
(any)
Perform a search against the Attivio index.
"simple" | "advanced"), offset: number, count: number, updateResults: function (response: (QueryResponse | null), error: (string | null)): void)(string)
the query to perform
(("simple" | "advanced"))
the language to use, either "simple" or "advanced"
(number)
the index of the first document to return
(number)
the number of documents to return (e.g. page size)
(function (response: (QueryResponse | null), error: (string | null)): void)
will be called when the search is complete with the results or an error
A simplified version of the AttivioPermission class used by the Attivio REST APIs.
((SimplePrincipal | null)
= null)
(boolean
= true)
the ISO-8601 format, e.g., '2017-09-07T10:29-05:00'
Type: string
a short date with just numbers, e.g., '09/07/2017'
Type: string
a date using the abbreviated month name, e.g., 'Sep 8, 2017'
Type: string
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.
Type: string
a date including the day of the week and the full month name: e.g., 'Thursday, September 8, 2017'
Type: string
A simple time format, e.g, '10:29 AM'
Type: string
A full time format, with seconds: e.g., '10:29:52 AM'
Type: string
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.
Type: string
The month and year of the date: e.g., 'Sep 2017'
Type: string
The month and year of the date: e.g., 'September 2017'
Type: string
The abbreviated 2-digit year: e.g. ’17
Type: string
The full year: e.g. 2017
Type: string
The short date and the short time, combined: e.g., '09/07/2017 10:29 AM'
Type: string
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.
Type: string
A simplified version of the IngestDocument class used by the Attivio REST APIs.
Extends AbstractDocument
(string)
(DocumentMode
= DocumentMode.ADD)
((string | null)
= null)
((string | null)
= null)
(Array<SimplePermission>
= [])
The medium date and the short time, combined: e.g., 'Sep 8, 2017 10:29 AM'
Type: string
The long date and the long time, combined: e.g., 'Thursday, September 8, 2017 10:29:52 AM'
Type: string
The month and day of the month with no time or year: e.g., 'March 4'
Type: string
A simple hour, in 12-hour format with AM or PM: e.g., '2 days ago'
Type: string
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.
Type: string
A distance 'ago' in time before now: e.g., '2 days ago'
Type: string