diff --git a/docs/5. Integrations/Filesearch Using OpenAI Assistants.md b/docs/5. Integrations/Filesearch Using OpenAI Assistants.md index 0501156f8..e0e2a5c1e 100644 --- a/docs/5. Integrations/Filesearch Using OpenAI Assistants.md +++ b/docs/5. Integrations/Filesearch Using OpenAI Assistants.md @@ -4,7 +4,7 @@ 6 minutes read Level: Advanced - Last Updated: December 2025 + Last Updated: April 2026 @@ -27,42 +27,63 @@ Glific’s File Search using OpenAI Assistant enables users to upload documents --- -## How to Create an OpenAI Assistant in Glific +## How to Create an Assistant in Glific #### Step 1: Create a new AI Assistant Click on `AI Assistant` from the left sidebar, then select `Create Assistant` to generate a blank assistant. -Screenshot 2025-08-09 at 12 35 30 AM +Screenshot 2026-04-09 at 2 26 06 PM #### Step 2: Fill in the Assistant Details Define the following parameters: -- Choose the most relevant model from the first drop down. - Provide a name to the assistant. + +- Choose the model from the drop-down list. + +image + + - Provide a system prompt in the `Instructions` field. *[Click Here](https://glific.org/a-simple-guide-to-using-large-language-models/#prompt) to read more on prompt engineering.* -- Files (PDF, DOCX, etc.) can be uploaded by clicking on `Manage Files`. These files will be utilized by the assistant to generate responses. - *[Click Here](https://platform.openai.com/docs/assistants/tools/file-search/supported-files#supported-files) to know the supported file formats by the OpenAI APIs.* -- Set the `Temperature` (between 0 to 2). A higher value increases creativity/randomness. +- Files (.csv, .doc, .docx, .html, .java, .md, .pdf, .pptx, .txt) can be uploaded by clicking on `Manage Files`. +These files will be utilized by the assistant to generate responses and each file will take approx 15 secs to upload. + +- Set the `Temperature` (between 0 to 1). A higher value increases creativity/randomness. *Recommended: keep temperature at 0.* **Note:** The quality of the bot’s response depends on the prompt. Give appropriate prompts based on your use case. #### Step 3: Save Your Assistant -Once the files are added, click on `Add`. This completes the Assistant setup. -Click on the `Save` button after making any changes. -Screenshot 2025-08-09 at 12 43 48 AM + +- Click on the upload files button to add files. Remember that each file can be uploaded one by one. + +image + +- Once the files are added, click on `Save`. This will show the status of the Assistant setup. + - Ready — assistant is live and usable + - In Progress — a new version is being prepared + + +image #### Step 4: Copy the Assistant ID -Once created, copy the `Assistant ID` shown below the assistant name. -This ID will be used in the webhook nodes in the flow editor. -Screenshot 2025-08-09 at 12 46 25 AM +- Once created, copy the `Assistant ID` shown below the assistant name. + +- This ID will be used in the webhook nodes in the flow editor. + +Screenshot 2026-04-09 at 2 43 40 PM + +**Please Note:** Assistants created before 10 March 2026 that include a Knowledge Base will have a Clone button. This allows you to create a copy of the assistant, make edits, add a new files, and reuse it as needed. +Assistants created without a Knowledge Base will not have the Clone option available. +If you need to update such assistants, you may have to create a new one with the required Knowledge Base configuration. +image ## Using the OpenAI Assistant in Floweditor The following sections explain how to use an assistant to answer questions or create conversations.