Analytics Conceptual Index (.NET)

A conceptual index is a type of index used by Relativity Analytics. It uses Latent Semantic Indexing (LSI) to discover concepts between documents. This indexing process is based solely on term co-occurrence. The language, concepts, and relationships are defined entirely by the contents of your documents and learned by the index. For general information about Analytics indexes, see Analytics indexes and on the RelativityOne Documentation site.

The Analytics Conceptual Index API supports programmatically managing conceptual indexes in Relativity Analytics. It includes the following features:

  • Supports CRUD operations on Analytics indexes.
  • Provides helper methods that simplify working with index jobs. You can use these methods to submit and cancel jobs, and to check on their statuses. These jobs can populate new data, build new indexes, and activate indexes for use.

As a sample use case, you might use this API in an application to programmatically operate on a conceptual index.

You can also use the Conceptual Index API through REST. For more information, see Analytics Conceptual Index (REST).

This page contains the following information:

The Relativity.Analytics.Conceptual.SDK contains this API. For compatibility and package installation instructions, see Download the SDKs and NuGet packages.

Fundamentals for the Conceptual Index API

Review the following information to learn about the methods, classes, and enumerations used by the Conceptual Index API.

Guidelines for using the Conceptual Index API

Review the following guidelines for working with the Conceptual Index API.

Common workflows

For Analytics indexes, common workflows include building new ones or incrementally updating existing ones.

Catch exceptions

When using any methods in the Conceptual Index API, catch the following exceptions:

  • PermissionException
  • ValidationException
  • Generic .NET Exception

Execute valid operations for the index state

Execute only valid operations for the state of an index. Only certain operations are valid for the current state of your index. See the following examples:

  • A call to cancel a running index job is only valid when a job is currently running for the index.
  • A call to build an index can't run on an index that hasn't been populated.
  • Note: To retrieve a list of valid operations, get the AnalyticsIndexStatus object. Examine the ConsoleButtons property on the returned object for a list of valid operations to call. You can also get additional information about the job from the StatusText and AdditionalStatusText properties. If you attempt to execute an invalid operation, you receive validation error. See Retrieve the status of a job.

Index states and job validation

When performing operations on an index, make sure the operation is applicable to its current state.

Monitor the analysis progress

After submitting an index job, monitor its progress by making calls to its status. See Retrieve the status of a job.

Create a conceptual index

Use the CreateAsync() method to add a new index to Relativity. Set the following properties on the ConceptualIndex object passed to the CreateAsync() method:

  • AnalyticsServer - an ArtifactRef object representing the Analytics server used to build the index. In RelativityOne environments, set the Artifact ID -1.
  • Name - the user-friendly name of the index.
  • Order - an integer representing the position of the index in drop-down menus. The default value is 0.
  • SearchableSet - an ArtifactRef object representing the saved search used to populate the searchable set.

When the operation succeeds, it returns the Artifact ID of the new index. Use the Artifact ID to submit the index for populating and building.

Retrieve a conceptual index

Use the ReadAsync() method to retrieve an index. Pass the Artifact IDs of the workspace and the index to this method. It returns a ConceptualIndex object. You can use this object to examine the index properties before submitting an index job, or updating or deleting the index.

Update a conceptual index

Use the UpdateAsync() method to modify an index. You can update multiple properties on a ConceptualIndex object. For a list of properties, see the ConceptualIndex class in Classes and enumerations.

Delete a conceptual index

Use the DeleteAsync() method to remove an index from Relativity. Pass the Artifact IDs of the workspace and the index to this method.

Helper methods for conceptual index jobs

Use the following helper methods for managing jobs related to conceptual indexes.

Submit a conceptual index job

Use the SubmitJobAsync() method to submit a job after creating the index. Pass the Artifact IDs for the workspace and index, and a job type to this method. For a list of job types, see Classes and enumerations.

Retrieve the status of a job

Use the GetStatusAsync() method to retrieve the status of an indexing job. Pass the Artifact IDs of the workspace and the index to this method. It returns an AnalyticsIndexStatus object.

Cancel a job

Use the CancelJobAsync() method to cancel an indexing job. Pass the Artifact IDs of the workspace and the index to this method.