Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Motivation & Goal

In certain scenarios, you may need your "assistant" to execute a particular task without retrieving any information from your knowledge base. Examples of these scenarios include:

  • Translating text

  • Python code generation

  • Creating Jira tickets

For the assistant to carry out these tasks effectively, it must receive an instruction, commonly referred to as a "system message".

Structure and Logic of an Assistant

An assistant as described above uses a single component: the Chat with GPT "module". Every user input activates this singular module. The module's capabilities are outlined within the system message, where you specify the tasks for the assistant to execute and the desired format for its responses.

Example of a system message for a Python code generation assistant:

You are an expert in generating Python code. The user input will be an instruction that needs to be translated into code.

Always add an explanation to the code section in your answer.

Note about chat history:

The module Chat with GPT takes into account the last 2 user-assistant interactions.

Step-by-step: How do you set up this assistant?

1. Create new space

Click on the “+” to create a new space

image-20240403-130618.png

2. Name and description

Define the name and description ( section "About" ) of the assistant. In addition, you can display a text to the user to mention that the answers are generated with AI.

image-20240403-131021.png

3. Configure AI Assistant

Add the module “Chat with GPT”.

image-20240403-131128.png

4. Update System Message

Click on the pencil icon to replace the standard system message with the message intended for your specific use case. You can further exchange here the GPT model used and the temperature.

  • Available GPT-models and their names can be found here: https://unique-ch.atlassian.net/wiki/spaces/PUB/pages/445775966/Assistant+module+settings#Available-GPT-models

  • Temperature is a setting within OpenAI's ChatGPT that controls the level of creativity and originality of the outputs. This setting ranges from 0 to 1. At a temperature of 0, the replies are highly predictable, bordering on deterministic (implying that a particular prompt will typically elicit the same answer).
    Conversely, a temperature of 1 allows for a broad spectrum of variation in the responses.

  • The tool definition can be left unchanged. (Does not need to be blanked out as shown in the picture below).

image-20240403-130405.png

5. Suggested Prompts (optional)

Add a few suggested prompts that are displayed to the user when starting a chat

image-20240403-131842.png

6. Members

Define which user will have access to this assistant by adding them to the list

image-20240403-131953.png

7. Publish Assistant

Publish your assistant by pressing the Publish button. Your assistant will now be visible in the chat interface.

image-20240403-132026.png

Note:

This module is not looking at any document uploaded into a chat or the knowledge centre, meaning that no RAG is done. Thus, do not activate the toggle Upload in Chat

Required and optional modules

The following modules are required/optional for this assistant:

Required

Optional

Chat with GPT

Example AI Assistant Configuration:

Save the following example in a TXT file and then upload it into a new space as an AI Assistant configuration:

{
  "temperature": 0.5,
  "languageModel": "AZURE_GPT_35_TURBO_0613",
  "systemPromptExternalKnowledge": "As an expert in Jira ticket creation, your objective is to meticulously translate user input into a structured and actionable Jira issue. Ensure that you capture all relevant details and articulate the requirements clearly to facilitate efficient tracking and resolution by the development team."
}

  • No labels