Skip to contents

Run row-wise text analysis with a prompt template

Source: R/text_analysis.R
run_text_analysis.Rd

This function applies a prompt template to each row of a text dataset and extracts structured responses with ellmer. It is designed for dataset-first workflows such as sentiment, emotion, offensiveness, or moral-foundation annotation across many short texts.

Usage

run_text_analysis(
  data,
  text_col = "text",
  prompt,
  response_type,
  id_col = NULL,
  n_simulations = 1,
  temperature = 0,
  seed = 42,
  model = "gemini-2.5-flash-lite",
  integration = getOption("nalanda.integration"),
  virtual_key = getOption("nalanda.virtual_key"),
  base_url = getOption("nalanda.base_url"),
  excerpt_chars = 200,
  max_active = 10,
  rpm = 500
)

Arguments

data

A data frame with at least one text column.

text_col

Name of the column containing the text to analyze.

prompt

Character scalar prompt template. It may reference any columns in data using {column_name} placeholders.

response_type

An ellmer structured type specification, for example ellmer::type_object(score = ellmer::type_number()).

id_col

Optional column name identifying each text row. When omitted, a sequential text_id is created.

n_simulations

Integer. Number of repeated runs per row.

temperature

Numeric. Sampling temperature passed to the backend.

seed

Integer. Random seed for reproducibility.

model

Character. Model name for the chat backend.

integration

Optional Portkey/gateway route slug. Use a route returned by ellmer::models_portkey(base_url = "https://ai-gateway.apps.cloud.rt.nyu.edu/v1/") when working with the NYU gateway.

virtual_key

Optional legacy virtual key.

base_url

Character. Base URL for API calls.

excerpt_chars

Integer. Number of text characters to retain in stored prompt previews.

max_active

Integer. Maximum number of concurrent requests passed to ellmer::parallel_chat_structured().

rpm

Integer. Requests-per-minute cap passed to ellmer::parallel_chat_structured().

Value

A tibble containing the original row metadata, simulation index, structured response fields, and stored prompt previews.