Add custom index fields

Add index fields to determine how information is indexed, searched, and retrieved within your knowledge base integration, providing greater control over data organization and access.

Configure variable types and define attributes for custom index fields.

  1. In the New AI Knowledge Base configuration dialog box, select for Indexes.

    The Add Index dialog box is displayed.

  2. Select for Index fields.
  3. Enter a Display name.
  4. The ID is displayed with the same name as the display name. Change the ID as needed.

    An index field ID must contain only upper or lowercase letters, digits, or underscores. It cannot start with a number and is limited to 1-100 characters.

  5. On the Type list, select a variable type. The following variable types are available:

    • String
    • Bool
    • Int32
    • Int64
    • Double
    • Date
    • String collection

    Based on the selected variable type, the relevant attributes are displayed.

  6. To enable vector-based search, select Vectorized. (Default: Clear)

    When a field is vectorized, two fields are created, one for the value and another for the vector representation. Use vectorized fields for semantic or similarity searches. A vectorized field must be set as searchable and retrievable so it can be used in Generative AI chat control and AI knowledge base activities.

  7. You must select one or more of the following attributes:

    • Searchable: Allows the field to be included in text search queries.

    • Retrievable: Makes the field available in search results.

    • Filterable: Enables filtering on this field's value in search or query operations.

    • The Filterable option is available for all variable types. It is selected by default and cannot be cleared.

    • The Searchable and Retrievable options are available only for "String" and "Collection of Strings" variable types.

    • On upgrading TotalAgility, all existing filter fields are automatically converted to the String variable type.

  8. Select Add.

    The configured index field is added. Configure more fields as needed.

  9. Select OK.

    Once you save the AI knowledge base configuration, all specified indexes are created automatically in Azure AI Search. Any existing indexes are validated to ensure they contain the same internal fields as required by TotalAgility. When configuring the Add or Delete knowledge base activities, the configured index fields become available to map to the correct variable type, and the activity is executed successfully at runtime.