prompt_ai(ds: dataset, {
    "param": value,
    ...
}) -> (*outputs: column)

Use any of OpenAI’s models on a row-by-row basis. This step doesn’t feed the whole dataset into the model, so you won’t be able to perform operations that require more than one row at a time. It can be used to perform a variety of tasks. Keep in mind that OpenAI’s models are generative AI technologies, and thus can give incorrect responses. It comes with a predefined budget of 5 $USD, which will prevent the step from executing if it will cost over that budget. It is advised that you use a filter step first to test the prompt out on a few rows, then launch it on the whole dataset.

Keep in mind our budget is a rough estimate, if you’re concerned about cost you should set limits on OpenAI’s side. Your prompt will be configured by using two parameters: ‘prompt’ and ‘response_format’. prompt is a text field while response_format allows you to specify a JSON format for the model’s response, in the format of {[expected_column]: "description"}.

Both in the prompt and the response format descriptions you may refer to the row’s attributes by using ${attribute_name}. Check the examples and parameter documentation below for more information.

???+ info “API integration” To use this step your team needs to have the OpenAI integration configured in Graphext. The corresponding credentials are required to connect to a third-party API. You can configure API integrations following the INTEGRATIONS or ADD INTEGRATION link in the top-left corner of your Team’s page, selecting API keys, and then the name of the desired third-party service.

First, create an OpenAI account or sign in. Next, navigate to the API key page and “Create new secret key”, optionally naming the key. Make sure to save this somewhere safe and do not share it with anyone. Optionally, you can specify the organization the key belongs to. On OpenAI’s’ page, you can set general budgets for your api key and other settings that may interest you.

prompt_ai(ds: dataset, {
    "param": value,
    ...
}) -> (*outputs: column)
​
prompt
string

Main prompt for the API call. The main body of instructions you wish to perform.

​
integration
string

Associated integration.

​
response_format
object

Prompt instructions for each output column. Further prompt instructions for each output column.

​
force_format
object

Values allowed in each output column. If provided, values in each column will be restricted.

​
out_types
object

Types for the output column(s). Desired types for each output column. By default, they will all be categories.

​
model
object

Model Configuration. Configuration for OpenAI’s model.

​
budget
number
default:"5"

Budget. If present, the step will not execute if estimated input token cost exceeds this amount in USD. If max_out_tokens is not set, we will minimum of the cost. If it is set, we will give a ceiling. Actual cost may vary depending on a number of factors like your OpenAI plan. Check your plan before executing.

​
max_out_tokens
number

Maximum output tokens. If set, each individual response will add to at most this amount. Allows for a budget theorical ceiling to be calculated before executing.

​
batch_size
integer
default:"100"

Size of concurrent request at a time. Lowering this if you have very low rate limits in your plan might prevent empty responses.

Values must be in the following range:

1 ≤ batch_size ≤ 100
​
timeout
integer
default:"60"

Timeout for requests to OpenAI.

Values must be in the following range:

1 ≤ timeout < inf

Was this page helpful?

Suggest edits