Articles in this section

Moving From OpenAI to Displayr AI

  • Updated
Follow

Starting July 1, 2025, Displayr moved from supporting individual OpenAI API keys to using a single AI solution fully hosted and managed by Displayr.

This means you are not able to use your own OpenAI API key as you have previously, and may need to manually update any AI widgets or outputs that currently use your OpenAI API key to use Displayr AI instead. 

If you have AI-based outputs or variables created after February 2025 and do not see an orange warning in the object inspector that states the feature will stop working, then you do not need to make any changes. These outputs will automatically migrate to the new Displayr AI-based solution.  

If you created the outputs or variables prior to February 2025 or see an orange warning that states the feature has been deprecated, they will remain usable until June 30, 2026, after which point they will stop working, and you will need to migrate them to the newer method. You can do this migration at any time. 

Migration steps will vary based on what type of AI output or variable you're migrating. Please use the list below to find your output or variable and the migration instructions.

Please note that while the instructions below will help you replicate the deprecated tools, due to the non-deterministic nature of AI, the new results may not match exactly. 

Basic Prompt

Basic Prompt has been replaced by the Custom AI Calculation tool. To replicate the Basic Prompt, set up a Custom AI Calculation using the steps outlined here and start with this prompt and customize it as needed: 

I am going to give you a prompt. When you provide your reply, 
please don't provide any formating symbols such as rich text formatting, 
markdown, or HTML.
<prompt>

Custom

Custom has been replaced by the Custom AI Calculation tool. To replicate the Custom tool, set up a Custom AI Calculation using the steps outlined here. 

Data Analysis

Data Analysis has been replaced by the Custom AI Calculation tool. To replicate the Data Analysis tool, set up a Custom AI Calculation using the steps outlined here. 

In the Input Options section, update the Number of inputs to at least 1 to add one variable or variable set. Select Variable or Variable Set in the Input Type field, and repeat that for all the variables you want to use. Then start with the prompt below. 

I want you to play the role of an expert data analyst. Please form the following process:
1. Organize the provided data in a format that Python can process.
2. Convert the data into a pandas DataFrame.
3. Write Python code to execute the instructions.
4. Execute the instructions in Python.

Show results and key conclusions that can be drawn from the results. However, do not return the input data but you can provide a summary of the dataset if appropriate. Do not show any instructions or commentary about how you reached your conclusions. Just provide raw HTML output and do not mention anything about Python.

The data is shown below, an a CSV format, with variable names in the first row: {Variables}

The instructions are:
<prompt>

Image

The Image tool is no longer supported. It is no longer possible to use AI to generate AI images in Displayr; however, you can insert external images. See How to Add an Image to Your Document.

Interpret

Interpret has been replaced by the Summarize tool. To replicate the Interpret tool, set up a Summarize tool using the steps outlined here. Then start with the prompt below. 

I want you to play the role of an expert interpreter.
Just give me the interpretation. Don't tell me what you did.
Return the results as plain text, with no special formatting characters.

The instructions are to:
<prompt>

The information to be interpreted is:
{Tables}
{Calculations}

QScript

QScript has been replaced by the Custom AI Calculation tool. To replicate the QScript tool, set up a Custom AI Calculation using the steps outlined here. Then start with the prompt below. 

I want you to play the role of an expert JavaScript programmer.
I'm going to give you a request. Once you have received the request,
I want you to return the answer as follows:

1. Create simple code, written in Displayr's QScript.
2. Included detailed comments, so that a less technical person can work out what is going on.
3. Just create the code. Don't show any output, examples, or introductory or explanatory text.
4. Format the code as straight text. That is, don't use any markdown or any other formatting.
5. Indent the code using spaces, not tabs. Each indent level should be four characters.
6. Show new lines using the return character, rather than by using '\n'.

The instructions are:
<prompt>

R Code

The R Code tool has been replaced by the AI R Code Writer built directly into the coding interface. To learn more, see AI R Code Writer.

Summary

Summary has been replaced by the Summarize tool. To replicate the Summary tool, set up a Summarize tool using the steps outlined here, and select only a text output and call it "Text." Then start with the prompt below. 

Play the role of an expert summarizer.
The instructions are to:
<prompt>

The information to be summarized is:
Just give me the interpretation. Don't tell me what you did.
Return the results as plain text, with no special formatting characters.

The instructions are to:
<prompt>

The information to be summarized is:
{Text}

Variables > Clean Text Data

Clean Text Data has been replaced by the Poor Text Data tool. You can learn more about how to use it here. 

Variables > Custom Numeric

Variables > Custom Numeric has been replaced by Custom Code > AI > Numeric. To create the variable, select the variable(s) you want to use as inputs for the custom variable in the Data Sources pane, hover where you want to add the new variable to the data set, and click + > Custom Code > AI > Numeric. Customize the default prompt as desired. 

Variables > Custom Text

Variables > Custom Text has been replaced by Custom Code > AI > Text. To create the variable, select the variable(s) you want to use as inputs for the custom variable in the Data Sources pane, hover where you want to add the new variable to the data set, and click + > Custom Code > AI > Text. Customize the default prompt as desired. 

Variables > Sentiment

Variables > Sentiment has been replaced by Numeric Transformations > Sentiment. To run the analysis, select the Text variable you want to analyze in the Data Sources pane, hover where you want to add the new sentiment variable to the data set, and click + > Numeric Transformations > Sentiment. 

 

Related articles