Analytics Conceptual Index (REST)

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, see Analytics indexes and on the RelativityOne Documentation site.

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

  • Supports CRUD operations on Analytics indexes.
  • Provides helper endpoints that simplify working with index jobs. You can use these endpoints 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 the Conceptual Index service in an application to programmatically operate on a conceptual index.

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

This page contains the following information:

Guidelines for using the Conceptual Index service

Review the following guidelines for working with the Conceptual Index service. For additional information, see Analytics Conceptual Index (.NET).

URLs

The URLs for REST endpoints contain path parameters that you need to set before making a call:

  • Set {versionNumber} to the version of the API, using the format lowercase v and the version number, such as v1.
  • Set other path parameters in the URLs to the Artifact ID of a given entity, such as {workspaceID} to the Artifact ID of a workspace.
  • Note: To indicate the admin-level context, set the {workspaceID} path parameter to -1.

For example, you can use the following URL to retrieve a conceptual index:

<host>/Relativity.REST/API/conceptual-analytics/{versionNumber}/workspaces/{workspaceID}/indexes/{indexID}

Set the path parameters as follows:

  • {versionNumber} to the version of the service, such as v1.
  • {workspaceID} to the Artifact ID of the workspace that contains the index.
  • {indexID} to the Artifact ID of a specific index.

Postman sample file

You can use the Postman sample file to become familiar with making calls to endpoints on the Agent Manager service. To download the sample file, click Conceptual Index Postman file.

To get started with Postman, complete these steps:

  1. Obtain access to a Relativity environment. You need a username and password to make calls to your environment.
  2. Install Postman.
  3. Import the Postman sample file for the service. For more information, see Working with data files on the Postman web site.
  4. Select an endpoint. Update the URL with the domain for your Relativity environment and any other variables.
  5. In the Authorization tab, set the Type to Basic Auth, enter your Relativity credentials, and click Update Request.
  6. See the following sections on this page for more information on setting required fields for a request.
  7. Click Send to make a request.

Create a conceptual index

To create an index, send a POST request to a URL with the following format:

<host>/Relativity.REST/API/conceptual-analytics/{versionNumber}/workspaces/{workspaceID}/indexes

When the index is successfully created, the response returns the status code of 200.

Retrieve a conceptual index

To read an index, send a GET request to a URL with the following format:

<host>/Relativity.REST/API/conceptual-analytics/{versionNumber}/workspaces/{workspaceID}/indexes/{index artifact ID}

The body of the request is empty.

Update a conceptual index

To update an index, send a PUT request to a URL with the following format:

<host>/Relativity.REST/API/conceptual-analytics/{versionNumber}/workspaces/{workspaceID}/indexes/{index artifact ID}

The request for an update operation contains the same fields as those for a create request. See the field descriptions for the request in Create a conceptual index.

When the index is successfully updated, the response returns the status code of 201.

Delete a conceptual index

To delete an index, send a DELETE request to a URL with the following format:

<host>/Relativity.REST/API/conceptual-analytics/{versionNumber}/workspaces/{workspaceID}/indexes/{indexID}

The body of the request is empty.

When the index is successfully deleted, the response returns the status code of 200.

Helper endpoints for conceptual index jobs

Use the following endpoints for managing jobs related to conceptual indexes.

Submit a conceptual index job

To submit an index job, send a POST request to a URL with the following format:

<host>/Relativity.REST/API/conceptual-analytics/{versionNumber}/workspaces/{workspaceID}/indexes/{indexID}/job

When the job is successfully submitted, the response returns the status code of 200.

Retrieve the status of a job

To retrieve the status of an index, send a GET request to a URL with the following format:

<host>/Relativity.REST/API/conceptual-analytics/{versionNumber}/workspaces/{workspaceID}/indexes/{indexID}/status

The body of the request is empty.

Cancel a job

To cancel a running index job, send a DELETE request to a URL with the following format:

<host>/Relativity.REST/API/conceptual-analytics/{versionNumber}/workspaces/{workspaceID}/indexes/{indexID}/job

The body of the request is empty.

When the job is successfully canceled, the response returns the status code of 200.

Additional Resources

DevHelp Community GitHub Release Notes NuGet

Share knowledge with the Relativity developer community.

Access tools and resources to build an application.

Review the most recent product release notes.

Create .NET Apps faster with NuGet.