Creating a document class subscription for vector indexing

The Content Assistant can only answer questions about documents that are vector indexed. You can create a vector index for a document only when you enable vector indexing for the document class or the parent class of the document.

Before you begin

Before you enable vector indexing for a document class, make sure that you enable persistent text extraction for that class. For more information, see the topic Configuring text extraction for document classes.

About this task

By default, a document class is not enabled for vector indexing. You need to create a document class subscription for vector indexing. After you create the subscription, a vector index is automatically created for any new documents that are added to the object store, which belong to the subscribed document class. Documents that are vector indexed are available to the Content Assistant to generate LLM responses.

However, you need to run a custom sweep job to create a vector index for existing documents that were added to the object store before the subscription was created.

Procedure

  1. In the Administration Console for Content Platform Engine (ACCE), go to the object store where you want to enable vector indexing.
  2. Go to Data Design > Classes > Document and select a document class.
    You can select a document class that subscribes to the Gen AI vector indexing request event action.
  3. For the selected class, click Actions > New subscription.
  4. Enter a subscription name and click Next.
    For example, you can enter Document-Vector Index as the subscription name.
  5. Select the subscription behavior Scope value as Applies to all objects of this class and click Next.
    Leave other properties as default values.
  6. Select Checkin Event and Update Event as events that trigger the subscription and click Next.
  7. Select Gen AI Vector Indexing Request Event Action as the event action for the subscription and click Next.
  8. Specify the values for additional options.
    1. Set the initial state as Enable the subscription.
    2. Select Include subclasses if you want to enable vector indexing for all sub-classes of the parent class.
      Tip: If you want to enable vector indexing for the Document class along with subclasses, create the subscription for the Document base class and select Include sub-classes.
    3. Set Run synchronously as the subscription run mode.
    4. Leave other fields blank and click Next.
  9. Click Finish to create the subscription for vector indexing.
  10. Repeat the process for all document classes where you want to enable vector indexing.

What to do next

If you want to create a vector index for existing documents, see the topic Running a custom sweep job for vector indexing existing documents.