Skip to main content

Agents

There are 3 types of agents that can be created: Chat, Content Creator and Business Analyst

Agents can be created and or edited from the following menu: Settings > Agent > Create Agent

More about Agents

The required details for creating an agent are:

  • Name
  • Mode
    • Retriever: Chat agent enhanced by your documents and functions
    • Coder: Coding assistant for developers and data scientists enhanced by your programming documentation
    • Casual: Everyday chatbot for general purpose
  • Topics (Under Knowledge settings) - required only if retriever mode is selected

When retriever mode is selected the user has the ability to turn on Advanced reasoning to force the agent to explain its reasoning step by step. When retriever or coder mode is selected the user has the ability to turn on Knowledge Settings to allow the agent to use the documentation to answer questions.

`Chat with agents modal settings.`

Knowledge Settings

In the Knowledge Settings, you assign the topics to the agent and set the configuration of the agent and the knowledge hub. By default, new agents will not have any topics assigned to them. You will need to assign topics to the agent in order for it to be able to answer questions.

  • Topics: The topics that the agent will be able to answer questions about.
  • Max history (1-10): How many of the previous conversation will the agent remember to use for context.
  • Keywords for knowledge base query: Search through the documentation with the keywords of the question or the full question. ToothFairyAI recommends to use keywords for larger documents sets and full question for smaller documents sets.
  • Max keywords (1-10): Max number of keywords to use for the knowledge base query.
  • TopK: Max number of results to return from the knowledge base query.
  • Doc TopK (1-10): Max number of documents to extract from the initial knowledge base query by document id. Use this setting to reduce document bias in case especially of conflicting information.
  • Min retrieval accuracy: Minimum confidence level for the knowledge base query to return results.
  • Recency importance (0-3): How important is the recency of the document in the knowledge base query. This setting is used to give more weight to the most recent documents.

ToothFairyAI's AI Inner Knowledge validation

ToothFairyAI's validation system, will only allow answers from AI Inner Knowledge that are verified. This feature is not how the other AI systems operate. Other systems will use their own reasoning model which does not have these strict fact checking measures in place like what ToothFairyAI does.

The AI Inner Knowledge answers generated by ToothFairyAI are checked by an algorithmic mathematical logic pattern. This pattern references answers based on what knowledge / documentation is available for the questions asked to it. This is done by converting question texts into 1024 dimension metrics which are then used to compared against an agents selected topics.

The recommended percentage of confidence level used by ToothFairyAI for providing an answer is 60%. This ensures that the output from an agent is accurate to the users questions. However the user can set the minimum retrieval accuracy to a higher percentage if they require a higher level of confidence in the answers provided by the agent.

Functions settings

Only available for Chat agents

Functions allow agents to consume APIs and DBs as a data source. Moreover, depending on the type, the function can provide suggestions or generate static responses for greater controllability of the agent's responses including via referencing entire web pages within the chat message. Functions are automatically enabled for retriever agents while for casual and coder agents, the functionality is not available. See Settings > Functions for more details.

Agent Character

Only available for Chat agents

The Agent Character are the input fields about the agent purpose, goals and what it should and should not talk about.

  • Agent role: This is to set the purpose of the agent. Any additional istruction for the agent should be added here.
  • Default answer: If a response cannot be found, this will be the response that is provided.
  • Goals: This is how the agent will fullfil its role.
  • Inhibition passage: Subjects that you do not want the agent to talk about.
  • Pertinance passage: Subjects to force the agent to focus on.

Advanced Settings

  • Short term memory: Enables conversation summarisation for context used at each step of the conversation.
  • Multilingual: Enables the multi-language capability for the agent to reply in over 120 languages, however this can impact performance so turn on only if necessary.
  • Show docs refs: When a response is generated, there will be references to the documentation used to provide the answer.
  • Temperature (0.1-1): Determines how creative the response will be, higher meaning most creative. Reduce this number to the lowest value to reduce hallucinations
  • Max output tokens (50-1200): Determines the number of tokes (characters set) in the response. The larger the number the longer and more detailed the responsed can be. If the number is set too low some answers might get truncated.
  • Plain text output: Removes any form of styling from the responses.
  • Show response time: Displays the time from the first word to the end of the last word in the response.
  • Show detected language: This setting will display the language that what used in the response.
  • Allow feedback: This option allows the user to thumb up or down a response to show if the generated response is correct or not.
  • Use charts: If requested the agent can generate charts, tables and mind maps.
  • Use NER: This setting will allow the agent to used named entities in the response. - this feature is available only in retriever mode.
  • Use images: This setting will allow the agent to retrieve images and display them in the response. - this feature is available only in retriever mode.
  • Content moderation: When enabled, the agent will filter out any profanity from the response by responding back to the user with the moderation rule applied when necessary.
  • Restrict access: When enabled, the agent will only be accessible to the users specified in the user access settings and the admins of the workspace. When this mode is enabled the agent will not be accessible to the public through the web-widget and all chats will be private by default.

Web Widget

Only available for Chat agents

  • Splash Logo: A logo you would like displayed in the widget.
  • First chat message: The initial message displayed when the chat is started.
  • Show splash message: When ticked, the first chat message is displayed as splash message in the middle of the chat.
  • Input placeholder: Text displayed in the user input field.
  • Loading placeholder: Text displayed when the agent is retrieving the answer.
  • Disclaimer: A statement that explains rules, limits, or warnings.
  • Icons colour in light mode: The global icon colour in light mode.
  • Icons colour in dark mode: The global icon colour in dark mode.
  • Splash background colour in light mode: The background colour of the top bar where the logo is displayed in light mode.
  • Splash background colour in dark mode: The background colour of the top bar where the logo is displayed in dark mode.
  • Favicon url: The url of the favicon to be displayed in the browser tab. The favicon should be a square image and must be in .ico or .png format.
  • Initial questions: A list of questions that the agent can answer when the chat is started. The user can create up to three questions separated by a semicolon.
  • Go to widget: The url of the page where the user can directly interact with the agent. Available only when the agent is Block external usage is ticked off.
  • Block external usage: Blocks the widget from public access.
Note

Chat agents by default are provided with both the public url of the agent if enabled and the code to embed the agent into any web-page as a chat widget.