Text Indexes
Displays details of your text indexes.

Text Indexes

You can use the Text Indexes account page to manage your text indexes, rather than calling the APIs directly.

The Text Indexes account page displays a list of your text indexes. It shows the name, description, and flavor of each text index.

You can click the title of a text index to display more information. The page for the text index provides additional tabs that allow you to manage the text index without using the API pages. The following page describes some of the actions that you can perform in the Text Indexes page:


Create a Text Index

You can use the the text indexes page to create a new text index.

Note: Each text index flavor has a static resource unit cost, determined by the maximum index size and specialization. For more information about the resource unit costs for each flavor, see API and Resource Unit Consumption.

To create a new text index

  1. Click Create text index. The Create Text Index dialog box opens on the Name page.

  2. Type a name and description for your new text index.

  3. Click Next. The Flavor page opens.

  4. Select a flavor for the new text index. For more information about flavors, see Index Flavors.

  5. Click Next. The Flavor Attributes page opens.

  6. The flavor attributes page allows you to define fields for your text index. The exact attributes available depends on the flavor that you have selected. The following table describes the possible attributes.

    Attribute Description
    Index Fields Fields that you want Haven OnDemand to process for searching. See Index Field Types.
    Parametric Fields Fields that contain content for parametric (faceted) search and filtering. See Index Field Types.
    Expire Date Fields that contain an expiration date for the documents in the text index. See Index Field Types.
    Numeric Fields that contain numeric values that you want to search for regularly. See Index Field Types.
  7. Click Next. The Confirm page opens.

  8. Check the details for your new text index, and then click Create.

    Haven OnDemand creates the text index, and the Text Indexes page immediately displays the text index in the list.


Index a Document

You can add documents to a text index by using the Index Documents tab.

To index a document into a text index

  1. On the Text Indexes page, click the text index that you want to index into. The metadata subpage opens, displaying details for the text index.

  2. Click the Index Documents tab.

  3. Find the JSON file that you want to index in your file system and drag it to the gray box on the page.

    Note: The JSON file must be appropriate for indexing. See the Add to Text Index API.

    Haven OnDemand indexes the document and returns a status or error message.


Use Your Text Index

The text index pages allow you to query a text index, or to see what other APIs you can use with the text index. On the Text Indexes page, click a text index to display the tabs for the index.

The Query Index tab allows you to create a quick text query for your index. This page uses the Query Text Index API, but does not have all the functionality for the API. You can type a simple keyword, natural language, or Boolean search expression, and choose to sort the results by relevance or date (with the most recent document first). Click Search to run the query. For more query functionality, see the Query Text Index API page.

The APIs tab displays a list of the APIs that you can use, such as Find Related Concepts and Find Similar. The API list depends on the flavor of your index. For example, if you create a text index with the Categorization flavor, you can use the Categorize Document API.


Delete a Text Index

You can delete a text index from the Metadata tab for the text index. Deleting the text index removes all the content. You cannot retrieve a text index after you delete it.

To delete an existing text index

  1. On the Text Indexes page, click the text index that you want to delete. The metadata subpage opens, displaying the text index.

  2. Click Delete text index. A warning dialog box opens.

  3. Click Delete to delete the text index. Haven OnDemand runs a preparatory step, and then a further confirmation dialog box opens.

  4. Click Delete again to confirm that you want to delete the index.

    Haven OnDemand deletes the text index and removes any content that it contains.