Activate Knowledge AI

Before using Knowledge AI, make sure that you complete the following steps:

1. Apply for a license
2. Allocate quotas
3. Activate feature flags
4. Familiarize yourself with how to monitor Knowledge AI metrics

Apply for a License

To use the Knowledge AI feature, you must obtain a license from Cognigy. This license allows you to use the feature for your organization and also places limits on how many Chunks you can use. If the quota is exceeded, you will not be able to create new Knowledge AI resources or edit existing ones.

A user with admin rights needs to add the license to your installation. If you are using a shared SaaS environment with version 4.78 or later, contact Cognigy technical support to add a quota for your organization.

Allocate Quotas

After adding the license, you need to allocate a quota for the number of Knowledge Chunks based on the license. You can allocate the quota to one organization or divide it among multiple organizations. If you have multiple organizations, ensure that you share the quota between them without exceeding your license quota.

Knowledge Chunks and Queries

Knowledge Chunks and Knowledge Queries are billable units:

• Number of Knowledge Chunks. Cognigy.AI determines the number of Chunks that can be consumed when creating Knowledge Sources. If the quota is exceeded, you will not be able to edit existing Knowledge Sources or create new ones.
• Number of Knowledge Queries. Cognigy.AI counts the number of Queries performed to retrieve relevant Knowledge Chunks. The number of Knowledge Queries is unlimited. However, you will be billed based on the Queries you have performed. The following Nodes impact the query counts:
  • Search, Extract, Output. Each execution of this Node increases the counter by one unit.
  • Copilot: Knowledge Tile Node. Each execution of this Node also increases the query count by one unit. The execution occurs when a suggested answer is provided or when a human agent retrieves information via the Search field.

Set Quotas

Only a user with admin rights for the management-ui can set quotas via the management-ui UI or API. If you use a shared SaaS environment, contact Cognigy technical support to configure quotas.

Set a Quota via UI

To set a quota using the management-ui, follow these steps:

1. Open the management-ui interface.
2. In the left-side menu, select Organisations.
3. On the Organisations page, select the organization from the list for which you want to set a quota.
4. In the upper-right corner of the Organisation Details page, click > Change Organisation Quotas.
5. In the Update Organisation Quotas window, enter the value in the Max knowledge chunks field.
6. Click Save.

Set a Quota via API

To set a quota using the management-ui API, follow these steps:

1. Open the Cognigy.AI API and navigate to the AUTHENTICATION > HTTP Basic.
2. Enter the login and password you use for the management-ui authorization, then click SET.

3. Select the organization to which you want to apply a quota:

   New OrganizationExisting Organization

   To set the quota for a new organization, use the API POST /management/v2.0/organisations request. Send the request with a JSON body. In the JSON body, specify a unique name for the new organization and the maximum number of Knowledge Chunks in the quotaMaxKnowledgeChunks parameter.

   POST /management/v2.0/organisations
   Content-Type: application/json
   
   {
     "name": "My Organization",
     "quotaMaxKnowledgeChunks": 1000
   }
   

   If the response is successful, the server returns a 200 status code with the organisation id and applied quota.

   To set the quota for the existing organization, use the API PATCH /management/v2.0/organisations/{organisationId} request. Send the request with the organisationId parameter in the path and a JSON body. In the JSON body, specify the maximum number of Chunks using the quotaMaxKnowledgeChunks parameter. You can find organisationId in the management-ui on the Organisations page in the ID column next to the organization name.

   PATCH /management/v2.0/organisations/{organisationId}
   Content-Type: application/json
   
   {
     "quotaMaxKnowledgeChunks": 1000
   }
   

   If the response is successful, the server returns a 200 status code with an empty body.

Activate Feature Flags

To activate the Knowledge AI feature flag, contact Cognigy technical support.

View Metrics

Familiarize yourself with the Admin Center page. On this page, you can monitor Knowledge AI metrics to manage the consumption of Knowledge AI resources effectively.

The Knowledge AI metrics include the following:

1. The number of Knowledge Queries performed within the selected time frame.
2. The total number of Knowledge Queries performed.
3. The number of Knowledge Chunks currently available in the organization.
4. The maximum number of Knowledge Chunks allocated to the organization. The specified value depends on the number set by the administrator for your organization. This value can be equal to the initial value provided by Cognigy within the license, or it can be less than the initial value if the license is divided among several organizations.