Item Structures
These are the data structures that Salience uses. Each structure contains or can be loaded with important information in its member attributes. These structures are used to load license data, open a session with salience, and many other operations.
LexalyticsLicense
This structure has no accessible members
See also: lxaLoadLicense
ModelSmokeTestEntry
Attribute | Description |
---|---|
| The filesystem path to the model that was tested |
| Brief error message |
| Detailed error message |
| Internal ID of the document that produced the error |
| True classification for document or textual item, e.g. entity |
| Classification actually reported by the model for document or textual item |
| True offset into document for a textual item (in characters) |
| The offset actually reported for a textual item (in characters) |
| True length of a textual item (in characters) |
| The length actually reported of a textual item (in characters) |
See also: lxaRunModelSmokeTest
OCRCharacterAttribute
Attribute | Description |
---|---|
| Character offset of a suspect OCR'ed character in the original document text |
| Optional: Confidence of the correctness of this suspect OCR'ed character. Ranges from 0 to 1, with 1 being most confident. If not used, you should set this to -1. |
| Optional: Height of suspect character bounding box, in typographical points. If not used, you should set this to -1. |
| Optional: Width of suspect character bounding box, in typographical points. If not used, you should set this to -1. |
| Optional: Distance of left side of suspect character bounding box from left side of page, in typographical points. If not used, you should set this to -1. |
| Optional: Distance of top side of suspect character bounding box from top of page, in typographical points. If not used, you should set this to -1. |
| Optional: Page number of suspect character, counting from page number 0. If not used, you should set this to -1. |
See also: lxaCorrectOCRErrors
SalienceAttribute
Attribute | Description |
---|---|
| The text of the attribute |
| The count of occurrences of the attribute |
| The count of positive occurrences of the attribute, based on value of the Neutral Upper Bound option. |
| The count of negative occurrences of the attribute, based on value of the Neutral Lower Bound option. |
| The count of neutral occurrences of the attribute, based on value of the Neutral Upper Bound and Neutral Lower Bound options. |
| A SaliencePhraseList structure with details about the occurrences |
| A SaliencePhraseList structure with details about the positive occurrences of the attribute, based on value of the Neutral Upper Bound option. |
| A SaliencePhraseList structure with details about the negative occurrences of the attribute, based on value of the Neutral Lower Bound option. |
| A SaliencePhraseList structure with details about the neutral occurrences of the attribute, based on value of the Neutral Upper Bound and Neutral Lower Bound options. |
See also: lxaGetCollectionFacets
SalienceChunk
Attribute | Description |
---|---|
| A pointer to a list of SalienceWord structures that comprise the chunk |
| The number of SalienceWords in the chunk |
| A label describing the grammatical type of the chunk |
| A zero-based index indicating the sentence in which the chunk appears |
SalienceCollection
Attribute | Description |
---|---|
| Name of the collection |
| Size of the collection |
| A pointer to a list of SalienceCollectionDocument structures that comprise the collection |
See also: lxaPrepareCollection
SalienceCollectionDetails
Attribute | Description |
---|---|
| The number of documents added to the collection |
See also: lxaGetCollectionDetails
SalienceCollectionEntity
Attribute | Description |
---|---|
| Normalized form of the entity |
| Type of entity (Company, Person, Place, Product, etc.) |
| Descriptive label for the entity |
| Count of documents in which this entity occurs |
| Count of documents in which this entity occurs with positive sentiment, based on value of the Neutral Upper Bound option |
| Count of documents in which this entity occurs with negative sentiment, based on value of the Neutral Lower Bound option |
| Count of documents in which this entity occurs with neutral sentiment, based on value of the Neutral Lower Bound and Neutral Upper Bound options |
| A SaliencePhraseList of all mentions of this entity in the document |
See also: lxaGetCollectionEntities
SalienceDocument
Attribute | Description |
---|---|
| The number of SalienceSentences in the document |
| A pointer to a list of SalienceSentence structures that make up the document |
See also: lxaGetNamedEntityMarkup, lxaGetUserEntityMarkup, lxaGetPOSMarkup, lxaGetSentimentMarkup
SalienceDocumentDetails
Attribute | Description |
---|---|
| The number of SalienceSections that comprise the document |
| A pointer to a list of SalienceSections containing information about the sections within the document |
See also: lxaGetDocumentDetails
SalienceRelatedEntity
Attribute | Description |
---|---|
| Name of the relation between the parent entity and the related entity. |
| Related Entity |
SalienceEntity
Attribute | Description |
---|---|
| Normalized form of the entity |
| Type of entity (Company, Person, Place, Product, etc.) |
| Descriptive label for the entity |
| Sentiment related to the entity |
| A measure of how much evidence the sentiment score was based on (1 to 7) |
| Whether the entity passed any confidence queries |
| Whether the document is about this entity |
| A summary of the document related to this entity |
| A SalienceMentionList of all mentions of this entity in the document |
| A SalienceThemeList of themes related to this entity |
| A SalienceSentimentPhraseList of sentiment phrases related to this entity |
| A SalienceTopicList structure with details about topics that co-occur with entities |
| A SalienceRelatedEntityList structure with details about entities related to this entity, currently just used by metaentities. |
oAttributes | A SalienceEntityAttributeList structure with attributes defined for this entity, if any. |
See also: lxaGetNamedEntities, lxaGetUserDefinedEntities
SalienceEntityAttribute
Attribute | Description |
---|---|
| Attribute name |
| Attribute value |
SalienceFacet
Attribute | Description |
---|---|
| The text of the facet |
| The list of sub-facets. Note: At present the acSubFacetList is empty and reserved for future possible use. |
| The count of occurrences of the facet |
| The count of positive occurrences of the facet, based on value of the Neutral Upper Bound option |
| The count of negative occurrences of the facet, based on value of the Neutral Lower Bound option |
| The count of neutral occurrences of the facet, based on value of the Neutral Lower Bound and Neutral Upper Bound options |
| Pointer to a list of SalienceAttribute structures for the facet |
| Number of SalienceAttribute structures for the facet |
| A SaliencePhraseList structure with details about the occurrences |
| A SaliencePhraseList structure with details about the positive occurrences of the facet, based on value of the Neutral Upper Bound option. |
| A SaliencePhraseList structure with details about the negative occurrences of the facet, based on value of the Neutral Lower Bound option. |
| A SaliencePhraseList structure with details about the neutral occurrences of the facet, based on value of the Neutral Upper Bound and Neutral Lower Bound options. |
See also: lxaGetCollectionFacets
SalienceIntention
Attribute | Description |
---|---|
| The phrase expressing the intention. |
| The intention type, out of the set of defined intention types, that was detected. |
| The object of the intention, if detected. Otherwise, this structure member will be empty. |
| The expresser of the intention, if detected. Otherwise, this structure member will be empty. |
| A SalienceChunk containing positional information about the chunk identifying the object of the intention |
| A SalienceChunk containing positional information about the chunk identifying the expresser of the intention. This will be an empty structure containing zeroes if acWho has not been detected. |
| A SalienceChunk containing positional information about the chunk containing the intention |
SalienceMention
Attribute | Description |
---|---|
| A SaliencePhrase structure containing location of the mention in text |
| The type of mention (Named, Nominal, Pronominal) |
| How likely it is that this is actually a mention of the entity |
SalienceOpinion
Attribute | Description |
---|---|
| A SalienceEntity structure for the entity expressing the opinion |
| A SalienceEntity structure for the entity that is the subject of the opinion, if applicable |
| A SalienceTheme structure for the theme that is the subject of the opinion, if applicable |
| The text of the expressed opinion |
| The sentiment associated with the opinion |
| An indicator of whether the opinion is being expressed about an entity or a theme |
SalienceOption
Attribute | Description |
---|---|
| Integer code for the option being set, as defined in SalienceOptions |
| Use this member if the option requires a string value |
| Use this member if the option requires an integer value |
| Use this member if the option requires a float value |
See also: lxaSetSalienceOption
SaliencePhrase
Attribute | Description |
---|---|
| The text of the phrase |
| The zero-based index of the document in the collection |
| The zero-based index of the sentence |
| The zero-based index of the first token in the phrase |
| The length (in tokens) of the phrase |
| The byte offset in the original text that the phrase starts at |
| The length of the phrase in bytes |
| An indicator of whether this phrase has been negated |
| The token responsible for negation if nNegated = 1 |
| An indicator of whether the phrase is negated (1), modified (2), both (3), or neither (0). This is only relevant to phrases related to SalienceSentimentPhrases |
| The zero-based index of the document details section that this phrase occurs in |
| The zero-based index of the row if the phrase occurs in a list or table |
| The zero-based index of the column if the phrase occurs in a list or table |
SalienceRelation
Attribute | Description |
---|---|
| A SalienceEntityList structure with the entities involved in the relationship |
| Type of relationship, as defined in the relationship pattern |
| Measure of confidence in the relationship |
| Additional information associated with the relationship |
See also: lxaGetNamedEntityRelationships, lxaGetUserEntityRelationships
SalienceRow
Attribute | Description |
---|---|
| A count of the columns detected in this row |
| A SalienceTokenList of the tokens in this row |
SalienceSection
Attribute | Description |
---|---|
| The number of SalienceWords in the section |
| The number of SalienceSentences in the section |
| The number of objective SalienceSentences in the section |
| The number of subjective SalienceSentences in the section |
| The number of sentences that grammatically parse |
| A SalienceTokenList structure providing term frequency analysis. Note that the tokens for term frequency analysis do not include numbers, punctuation, conjunctions or determiners. |
| A SalienceTokenList structure providing tagged term frequency analysis |
| A SalienceTokenList structure providing bi-gram frequency analysis. Note that the bi-grams do not include numbers, punctuation, conjunctions or determiners. |
| A SalienceTokenList structure providing tagged bi-gram frequency analysis |
| A SalienceTokenList structure providing tri-gram frequency analysis. Note that the tri-grams do not include numbers, punctuation, conjunctions or determiners. |
| A SalienceTokenList structure providing tagged tri-gram frequency analysis |
| A SalienceTokenList structure providing quad-gram frequency analysis. Note that the quad-grams do not include numbers, punctuation, conjunctions or determiners. |
| A SalienceTokenList structure providing frequency analysis of negators |
| A SalienceTokenList structure providing frequency analysis of intensifiers |
| A pointer to a list of SalienceSentence structures that make up the document |
| The internal version of the document |
| A calculated fingerprint of the document (DEPRECATED) |
| If this section is a table or row, a SalienceRowList structure is provided for each row |
| The header for this section |
SalienceSentence
Attribute | Description |
---|---|
| A pointer to a list of SalienceWord structures that make up the sentence |
| A pointer to a list of SalienceChunk structures that make up the sentence |
| The number of SalienceWords in the sentence |
| The number of SalienceChunks in the sentence |
| An indicator specifying if the sentence is subjective (1) or objective (0) |
| An indicator specifying if the sentence conveys sentiment polarity (1) or not (0) |
| An indicator specifying if the sentence conveys an imperative or "call to action" statement (1) or not (0) |
| The text of the sentence |
| The rank of the sentence with relation to the summary. A call to retrieve the document summary must be made for this field to be initialized, otherwise this structure member contains the value -1. |
| Reserved for future use to provide sentence-level sentiment. Currently returns 0. |
SalienceSentimentModel
Attribute | Description |
---|---|
| Indicator of the sentiment category determined as best match (0=Positive, 1=Negative, 2=Mixed, 3=Neutral) |
| Model-based score associated with likelihood document is positive |
| Model-based score associated with likelihood document is negative |
| Model-based score associated with likelihood document is mixed |
| Model-based score associated with likelihood document is neutral |
| Name of the sentiment model used for scoring |
Note: Sum of model scores should equal 1, nBest
should match category of greatest model score.
SalienceSentimentPhrase
Attribute | Description |
---|---|
| A SaliencePhrase structure with details about the phrase |
| The sentiment weight for the phrase |
| An indicator specifying if the phrase is HSD-based or not |
| The path of the HSD file containing the phrase, if HSD-based |
| An indicator specifying if the phrase has been modified << 0: no modification, 1: negated, 2: intensified, 3: negated and intensified |
| A SaliencePhraseList with details about any relevant supporting phrases, such as a negating phrases or intensifying phrase |
SalienceSentimentResult
Attribute | Description |
---|---|
| Phrase-based sentiment score |
| A SalienceSentimentPhraseList structure containing details of phrase-based sentiment analysis |
| Pointer to a list of SalienceSentimentModel structures containing details of model-based sentiment analysis |
| Number of models for which model-based sentiment results are provided |
| DEPRECATED: A list of SalienceTopicList structures containing information about emotions detected in the content |
See also: lxaGetSentiment
SalienceSession
This structure has no accessible members
See also: lxaOpenSalienceSession
SalienceSessionStartup
Attribute | Description |
---|---|
| Character buffer filled with error message when needed |
| Integer flag indicating whether startup log should be created (1) or not (0) |
| Fully-qualified path to location where startup log can be written |
| Character buffer containing path to data directory for use |
| Character buffer containing path to user directory for use |
| A integer to set a pre-defined mode for Salience, which has the effect of setting specific option values for handling certain content. |
The mode member of the structure may be set to the following values:
SALIENCEMODE_DEFAULT
: Default mode for handling general content.
SALIENCEMODE_SHORTFORM
: Mode for handling short-form content such as Twitter.
See also: lxaOpenSalienceSession
SalienceSummaryResult
Attribute | Description |
---|---|
| Character buffer providing summary for the document via default method |
| A pointer to a SalienceDocument structure containing a pointer to a list of SalienceSentence structures for the sentences in the summary. The SalienceSentence structs will contain ranking for the sentence with respect to the summary. |
| Character buffer providing summary generated for the document via an alternate method |
| A pointer to a SalienceDocument structure containing a pointer to a list of SalienceSentence structures for the sentences in the alternate summary. The SalienceSentence structs will contain ranking for the sentence with respect to the alternate summary. |
See also: lxaGetSummary
SalienceTheme
Attribute | Description |
---|---|
| The text of the theme |
| The stemmed version of the theme |
| The normalized version of the theme |
| An indicator is this is a "meta-theme" (1) or not (0) |
| Documents: A measure of the strength of the theme within the document |
| Documents: The sentiment score for the theme |
| Documents: A measure (from 1 to 7) of the content on which the sentiment score for the theme is based |
| Documents: An indicator specifying if the theme is contained within the summary of the document |
| A summary of the document content relevant to the theme |
| A SaliencePhraseList structure with details about the theme occurrences |
| A SalienceTopicList structure with details about topics that co-occur with themes. |
| Reserved for future use. |
| A SaliencePhraseList structure with details about phrases associated with child mentions of the theme. |
| A SaliencePhraseList structure with details about phrases associated with related mentions of the theme. |
SalienceToken
Attribute | Description |
---|---|
| A single token (generally a word, but also includes punctuation and other individual textual items) |
| Number of occurrences of the token |
SalienceTopic
The SalienceTopic
structure is used as the return structure for multiple functions.
Query-defined topics
When returned for query-defined topics at the document level
Attribute | Description |
---|---|
| The query-defined topic label |
| Number of query terms that hit within the document content |
| 0 (not used) |
| The sentiment score for document content associated with the topic |
| A field for any additional information related to the topic |
| 0 (indicates query topic result) |
| Null (not used) |
| A SalienceEntityList containing information about entities specified in the query definition, if any. Otherwise, an empty list. |
| A SalienceSentimentPhraseList containing information about the phrases used in calculating this topic's sentiment score |
When returned for query-defined topics at the collection level
Attribute | Description |
---|---|
| The query-defined topic label |
| The number of documents within the collection that contain hits for the topic |
| 0 (not used) |
| An average of the sentiment values for topic hits within the collection |
| A field for any additional information related to the topic |
| 0 (indicates query topic result) |
| Null (not used) |
| A SalienceEntityList containing information about entities specified in the query definition, if any. Otherwise, an empty list. |
| Null (not used) |
Concept-defined topics
When returned for concept topics at the document level
Attribute | Description |
---|---|
| The concept topic label |
| 0 (not used) |
| Strength of the concept topic match to document content |
| Sentiment for content related to the topic within the document |
| A field for any additional information related to the topic |
| 1 (indicates concept topic result) |
| Null (not used) |
| Not used, this member will contain an empty SalienceEntityList |
| A SalienceSentimentPhraseList containing information about the phrases used in calculating this topic's sentiment score |
When returned for concept topics at the collection level
Attribute | Description |
---|---|
| The concept topic label |
| The number of documents within the collection that match the concept |
| 0 (not used) |
| An average of the sentiment values for topic hits within the collection |
| A field for any additional information related to the topic |
| 1 (indicates concept topic result) |
| Null (not used) |
| Not used, this member will contain an empty SalienceEntityList |
| Null (not used) |
Categories
Document categories are determined via the Wikipedia category information contained within the Concept Matrix. Document categories are only available at the document level.
Attribute | Description |
---|---|
| The category label |
| 0 (not used) |
| Strength of the category match to document content |
| 0 (not used) |
| Not used |
| An integer indicating the type of category result: 2=category node, 3=category leaf, 4=category explain info |
| A pointer to a SalienceTopicList containing information about child categories |
| Not used, this member will contain an empty SalienceEntityList |
| A SalienceSentimentPhraseList containing information about the phrases used in calculating this topic's sentiment score |
Classification
Document classification results are determined via the API call lxaGetDocumentClasses. Document classification is only available at the document level.
Attribute | Description |
---|---|
| The classification label |
| 0 (not used) |
| This provides an indication of the strength of the match for the classification |
| 0 (not used) |
| Not used |
| Not used |
| Not used |
| Not used |
| Null (not used) |
SalienceWord
Attribute | Description |
---|---|
| The token associated with the word |
| The part-of-speech tag associated with the token, see Supported POS tags |
| The stemmed version of the word |
| An indicator specifying if sentiment for the word has been inverted |
| Sentiment for word, filled in when returned for sentiment and entity markup |
| Indicator of source of sentiment; from hand-scored dictionary, or stopword |
| Entity type for word if it is part of an entity, returned for entity markup |
| Identifiers of which markup applies to the word |
| Secondary identifier of which markup applies to the word |
| An indicator specifying if the word is post-fixed (followed by a space) |
Updated 4 months ago