› Workflow › Business processes › Design a basic process › Add an activity › Activity types › AI Knowledge Base activities › Search knowledge base activity › Configure a Search knowledge base activity

Configure a Search knowledge base activity

Use the following procedure to configure a Search knowledge base activity.

The Search knowledge base activity is available only to Enterprise tier customers. For users on the Standard and Advanced tiers, this feature is restricted and indicated by a lock icon.

  1. Add an activity to the map. See Add an activity.

    By default, the Configuration tab is open in the properties panel of the activity.

  2. Enter a Name for the activity.
  3. On the Type list, select AI Knowledge Base > Search knowledge base.
  4. On the AI Knowledge Base provider list, select the knowledge base provider configured. See Integrate TotalAgility with AI Knowledge Base.

    If using the Tungsten knowledge base provider, you must have the required licenses to search the documents in the knowledge base.

  5. On the Index list, select an index.
  6. On the Input list, enter a plain text or select a process or server variable.
  7. Under Index fields, you can add identifiers to a document and modify or delete existing identifiers. You can add multiple identifiers, however, the same identifier type cannot be used more than once.

    To add an identifier

    1. Click .

    2. In the Name box, click the down arrow to expand the list, and select one of the following identifiers: Job ID,Case ID, or Case Ref. (Default: None)

    3. In the Value box, click the down arrow and select a server or process string variable.

      If you select a nullableString for any identifier, no value is stored for it, but you can pass any value through nullablestring.

    To edit an identifier Select the identifier and click and modify the required fields.
    To delete an identifier Select the identifier and click .

  8. To override the maximum number of documents configured when configuring the AI knowledge base integration, select Override max number of matches. (Default: Clear)
  9. For Max number of matches, specify the maximum number of documents to override. (Default: 5)

    This property is available only if "Override max number of matches" is selected.

  10. To add a response profile that can be used at runtime because you may want your responses to take a specific word count or style, select Use response profile and on the Response profile list, provide an inline value, such as "Summarize the response in 20 words or less." or select a process variable or server variable.
  11. Optional. Select the check box for Use seed (default: Clear) and on the Seed list, provide an inline value or select a numeric variable. (Default: 0 and Maximum: 32,767). The seed value increases the likelihood of obtaining more consistent results from the AI provider across repeated requests, though not guaranteed.
  12. To include case data for analysis when using AI knowledge base, select Include case data.

    The "Include case data" option is not available when using a Custom LLM provider.

    1. For Case identifier, select a variable (global variable, form variable, or form control) or provide an inline value for Case ref or Case ID.
    2. A list of case data is displayed. By default, Key Case Details, History (full), Variables, and Notes options are selected. You can select the items from the list as needed.

    At runtime, the case details are included in the information available to search and also included in the response.

  13. On the Response list, select a Data object variable.

    The data model will be created as part of the installation or upgrade and will be available for use.

  14. Save the process.

    When the activity is executed, the prompt is processed and the response returned with the data object is populated accordingly and includes all of the data returned as part of the chat control search.