Analytics Conceptual Index (REST)

The request payload must include a valid JSON representation of the index object.

The following properties are required:

• AnalyticsServer - the Analytics server used to build the index.
• Name - the user-friendly name of the index.
• IndexTypeIdentifier - the type of index, such as Conceptual (LSI-based) or Classification (SVM-based) index.
• Order - an integer representing the position of the index in drop-down menus. The default value is 0.
• SearchableSet - the saved search to populate the searchable set.

The following properties are optional:

• ConceptStopWords - words to suppress from the index. You can add or remove stop words from the list. Separate each word with a hard return. The default values are derived from the [EDDSDBO].[ContentAnalystDefaultNoiseWords] table.
• ContinueIndexStepsToCompletion - a Boolean value indicating whether to automatically complete all steps necessary to activate an Analytics index after starting a step.
• Dimensions - the number of dimensions of the concept space in which documents are mapped when the index is built. More dimensions increase the conceptual values applied to documents and refine the relationships between documents.
• EmailNotificationRecipients - the list of email recipients notified during index population and build.
• EnableEmailHeaderFilter - removes common header fields (such as To, From, and Date) and reply-indicator lines. It doesn't remove content from the Subject line. Use this filter to ensure that the headers in the concept space don't overshadow the authored content. The default value is false.
• OptimizeTrainingSet - a Boolean value indicating whether to select only conceptually relevant documents from the training set saved search. To improve index quality, this property automatically excludes documents that are very large, very small, or contain many numbers when this property is set to true. The default value is false.
• RemoveDocumentsThatErroredDuringPopulation - removes documents from being populated when they have errored in a previous population.
• RemoveEngSignaturesAndFooters - a Boolean value indicating whether to remove signatures and footers in English language emails from the text stored in the Analytics index. By default, this property is set to true for new indexes and false for existing ones. Setting this property to true enables the email header filter, disables the Go Words and OCR filters, and removes documents greater than 30 MB from the searchable set. The default value is false.
• RepeatedContentFilters - repeated content filters associated with the index.
• TrainingSet - the saved search used to populate the training set.

For both the TrainingSet and SearchableSet fields, the Artifact ID for the SavedSearchRef object can be set to 0 to use the built-in search for all documents in a workspace, or -1 for the default training set and default searchable. Setting this value to 0 can negatively impact on system performance.

The following exceptions may occur:

• ValidationException – An exception representing the case where an invalid or malformed request is made. For example, this exception occurs when an invalid value is specified for an index property.
• PermissionException – An exception representing the case where the user doesn't have permission to perform an attempted action. For example, this exception occurs when a user doesn't have access to a workspace, a searchable or training set, or to perform index operations.

The response returns an index object with the following properties:

• ArtifactID - the Artifact ID of the index.
• Guids - the GUIDs for this index.
• AnalyticsServer - the Analytics server used to build the index.
• ConceptStopWords - words to suppress from the index. You can add or remove stop words from the list. Separate each word with a hard return. The default values are derived from the [EDDSDBO].[ContentAnalystDefaultNoiseWords] table.
• Dimensions - the number of dimensions of the concept space in which documents are mapped when the index is built. More dimensions increase the conceptual values applied to documents and refine the relationships between documents.
• EmailNotificationRecipients - the list of email recipients notified during index population and build.
• Name - the user-friendly name of the index.
• OptimizeTrainingSet - a Boolean value indicating whether to select only conceptually relevant documents from the training set saved search. To improve index quality, this property automatically excludes documents that are very large, very small, or contain many numbers when this property is set to true. The default value is false.
• Order - an integer representing the position of the index in drop-down menus. The default value is 0.
• RemoveEngSignaturesAndFooters - a Boolean value indicating whether to remove signatures and footers in English language emails from the text stored in the Analytics index. By default, this property is set to true for new indexes and false for existing ones. Setting this property to true enables the email header filter, disables the Go Words and OCR filters, and removes documents greater than 30 MB from the searchable set. The default value is false.
• EnableEmailHeaderFilter - removes common header fields (such as To, From, and Date) and reply-indicator lines. It doesn't remove content from the Subject line. Use this filter to ensure that the headers in the concept space don't overshadow the authored content. The default value is false.
• RepeatedContentFilters - repeated content filters associated with the index.
• SearchableSet - the saved search to populate the searchable set. This value is a SavedSearchRef object.
• TrainingSet - the saved search used to populate the training set. This value is a SavedSearchRef object.
• Active - indicates whether the search provider associated with the index has been activated.
• RemoveDocumentsThatErroredDuringPopulation - removes documents from being populated when they have errored in a previous population.
• ContinueIndexStepsToCompletion - a Boolean value indicating whether to automatically complete all steps necessary to activate an Analytics index after starting a step.
• LastErrorMessage - the last error message to occur on the index.
• IndexLastUsedOn - the time when this index was last used.

The following exceptions may occur:

• NotFoundException – An exception representing the case where an item isn't available or doesn't exist. For example, this exception occurs when reading or deleting an index that doesn't exist.
• PermissionException – An exception representing the case where the user doesn't have permission to perform an attempted action. For example, this exception occurs when a user doesn't have access to a workspace, a searchable or training set, or to perform index operations.

The following exceptions may occur:

• ValidationException – An exception representing the case where an invalid or malformed request is made. For example, this exception occurs when an invalid value is specified for an index property.
• PermissionException – An exception representing the case where the user doesn't have permission to perform an attempted action. For example, this exception occurs when a user doesn't have access to a workspace, a searchable or training set, or to perform index operations.

The following exceptions may occur:

• DeletionDependencyException - An exception representing the case where an object deletion fails because it's referenced by dependencies. For example, this exception occurs when attempting to delete an index that's being used.
• NotFoundException – An exception representing the case where an item isn't available or doesn't exist. For example, this exception occurs when reading or deleting an index that doesn't exist.
• PermissionException – An exception representing the case where the user doesn't have permission to perform an attempted action. For example, this exception occurs when a user doesn't have access to a workspace, a searchable or training set, or to perform index operations.

The request payload must include a valid JSON representations of the index job type. Valid values include:

• FullPopulation - runs a full index population.
• IncrementalPopulation - runs an incremental population.
• RetryErrors - retries errors that occurred during population.
• RemoveDocumentsInError - removes documents in error.
• BuildIndex - runs a full index build.
• Activate - activates the index for querying.
• Deactivate - disables queries on the index.

The following exceptions may occur:

• NotFoundException – An exception representing the case where an item isn't available or doesn't exist. For example, this exception occurs when reading or deleting an index that doesn't exist.
• PermissionException – An exception representing the case where the user doesn't have permission to perform an attempted action. For example, this exception occurs when a user doesn't have access to a workspace, a searchable or training set, or to perform index operations.
• ValidationException – An exception representing the case where an invalid or malformed request is made. For example, this exception occurs when an invalid value is specified for an index property.

The response returns an index status object with the following properties:

• Active - indicates whether the index is active and can be queried.
• ConsoleButtons - a list of console buttons and links with their current states. The states can be used to determine which job steps can be run for the index. See AnalyticsIndexJobType enumeration in Fundamentals for the Conceptual Index API.
• CurrentStep - the current job step when a multi-step job is in progress.
• DocLevelErrorsExist - indicates whether documents in the training set are in error.
• LastErrorMessage - the last error that occurred on this index.
• OverallTimeElapsed - the total time of the current job when one exists.
• PercentageComplete - the completed percentage of the current job step when one exists.
• PercentDenominator - the denominator value used to generate the percentage of the current job step when one exists.
• PercentNumerator - the numerator value used to generate the percentage of the current job step when one exists.
• SearchableSetCount - the count of items in the searchable set when an index is new or active in its final state.
• SecondaryPercentageComplete - the completed percentage of a stage of a job step when one exists.
• SecondaryStatusText - additional status text.
• StatusText - the main status text of the index.
• StepTimeElapsed - the elapsed time of the current job step when one exists.
• TotalSteps - the total number of job steps when a multi-step job is in progress.
• TrainingSetCount - the count of items in the training set when the index is new or active in its final state.

The following exceptions may occur:

• NotFoundException – An exception representing the case where an item isn't available or doesn't exist. For example, this exception occurs when reading or deleting an index that doesn't exist.
• PermissionException – An exception representing the case where the user doesn't have permission to perform an attempted action. For example, this exception occurs when a user doesn't have access to a workspace, a searchable or training set, or to perform index operations.

The following exceptions may occur:

• DeletionDependencyException - An exception representing the case where an object deletion fails because it's referenced by dependencies. For example, this exception occurs when attempting to delete an index that's being used.
• NotFoundException – An exception representing the case where an item isn't available or doesn't exist. For example, this exception occurs when reading or deleting an index that doesn't exist.
• PermissionException – An exception representing the case where the user doesn't have permission to perform an attempted action. For example, this exception occurs when a user doesn't have access to a workspace, a searchable or training set, or to perform index operations.