ppi_mean
Estimate a population mean by combining gold-standard labels with model predictions on labeled and unlabeled data, returning a confidence interval.
Instructions
Prediction-powered estimate of a population mean.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| y | Yes | Gold-standard (human) outcomes on the labeled sample. | |
| tune | No | Use the PPI++ power-tuning weight ``lambda in [0, 1]``. ``False`` fixes ``lambda = 1`` (the original PPI estimator). | |
| yhat | Yes | Model predictions on the *same* labeled rows. | |
| alpha | No | CI level (1 - alpha confidence). | |
| detail | No | Payload depth: 'minimal' (~150 tokens) for sub-step calls where only the point estimate is needed; 'standard' (~1K tokens) for diagnostics + coefficient table; 'agent' (~2K tokens, default) adds violations / next_steps / suggested_functions so the LLM can plan its next call without another round-trip. | agent |
| as_handle | No | If true, cache the fitted result on the server and return result_id + result_uri alongside the JSON payload so a subsequent tools/call can chain without re-running. | |
| data_path | No | Absolute path or URL to a data file. Supported: .csv / .tsv / .txt (delimited), .parquet / .pq, .feather / .arrow, .xlsx / .xls, .dta (Stata), .json / .jsonl. Schemes: file://, s3://, gs://, https://. | |
| result_id | No | Optional handle to a previously-fitted result (returned by an earlier call when as_handle=true). Tools that operate on a fitted object accept this in place of re-supplying data_path + columns. | |
| data_columns | No | Optional column projection. Parquet/Feather/Stata loaders honour this for fast partial reads. | |
| data_sample_n | No | Optional uniform random subsample size (seed=0, deterministic) — useful on huge panels. | |
| yhat_unlabeled | Yes | Model predictions on the unlabeled rows. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||