{
"openapi": "3.1.0",
"info": {
"title": "LightningRod API",
"description": "Generate verified, grounded datasets at scale for LLM fine-tuning and evaluation",
"version": "1.0.0"
},
"paths": {
"/openai/chat/completions": {
"post": {
"tags": [
"OpenAI Compatible"
],
"summary": "Chat Completions",
"description": "OpenAI Compatible API Endpoint for Foresight Models.",
"operationId": "chat_completions_openai_chat_completions_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCompletionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChatCompletionResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/openai/models": {
"get": {
"tags": [
"OpenAI Compatible"
],
"summary": "List Models",
"description": "List available models.",
"operationId": "list_models_openai_models_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ModelListResponse"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/openai/completions": {
"post": {
"tags": [
"OpenAI Compatible"
],
"summary": "Completions",
"description": "OpenAI-compatible text completion endpoint.",
"operationId": "completions_openai_completions_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompletionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompletionResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/transform-jobs": {
"get": {
"tags": [
"Transform Jobs"
],
"summary": "List Transform Jobs",
"description": "List transform jobs for the authenticated organization",
"operationId": "list_transform_jobs_transform_jobs_get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 10,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/TransformJobStatus"
},
{
"type": "null"
}
],
"title": "Status"
}
},
{
"name": "configuration_id",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Configuration Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListTransformJobsResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Transform Jobs"
],
"summary": "Create Transform Job",
"description": "Create a new transform job",
"operationId": "create_transform_job_transform_jobs_post",
"security": [
{
"HTTPBearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTransformJobRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransformJob"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/transform-jobs/cost-estimation": {
"post": {
"tags": [
"Transform Jobs"
],
"summary": "Cost Estimation",
"description": "Estimate maximum cost for a transform job before execution",
"operationId": "cost_estimation_transform_jobs_cost_estimation_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateCostRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateCostResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/transform-jobs/{job_id}": {
"get": {
"tags": [
"Transform Jobs"
],
"summary": "Get Transform Job",
"description": "Get a transform job by ID",
"operationId": "get_transform_job_transform_jobs__job_id__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Job Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransformJob"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"delete": {
"tags": [
"Transform Jobs"
],
"summary": "Cancel Transform Job",
"description": "Cancel a running transform job",
"operationId": "cancel_transform_job_transform_jobs__job_id__delete",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Job Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"404": {
"description": "Transform job not found"
},
"400": {
"description": "Cannot cancel job with current status"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/transform-jobs/{job_id}/metrics": {
"get": {
"tags": [
"Transform Jobs"
],
"summary": "Get Transform Job Metrics",
"description": "Get pipeline metrics for a transform job",
"operationId": "get_transform_job_metrics_transform_jobs__job_id__metrics_get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Job Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PipelineMetricsResponse"
}
}
}
},
"404": {
"description": "Pipeline metrics not found"
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/datasets": {
"get": {
"tags": [
"Datasets"
],
"summary": "List Datasets",
"description": "List datasets for the authenticated organization",
"operationId": "list_datasets_datasets_get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 10,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListDatasetsResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Datasets"
],
"summary": "Create Dataset",
"description": "Create a new empty dataset",
"operationId": "create_dataset_datasets_post",
"security": [
{
"HTTPBearer": []
}
],
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDatasetResponse"
}
}
}
}
}
}
},
"/datasets/{dataset_id}": {
"get": {
"tags": [
"Datasets"
],
"summary": "Get Dataset",
"description": "Get dataset metadata including ID and row count",
"operationId": "get_dataset_datasets__dataset_id__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Dataset Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DatasetMetadata"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/datasets/{dataset_id}/samples": {
"get": {
"tags": [
"Datasets"
],
"summary": "Get Dataset Samples",
"description": "Get samples from a dataset with cursor-based pagination",
"operationId": "get_dataset_samples_datasets__dataset_id__samples_get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Dataset Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 5000,
"minimum": 1,
"default": 1000,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedSamplesResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"post": {
"tags": [
"Datasets"
],
"summary": "Upload Samples",
"description": "Upload samples to a dataset",
"operationId": "upload_samples_datasets__dataset_id__samples_post",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "dataset_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Dataset Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadSamplesRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UploadSamplesResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/files": {
"post": {
"tags": [
"Files"
],
"summary": "Create File Upload",
"description": "Get a signed upload URL for direct GCS upload",
"operationId": "create_file_upload_files_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFileUploadRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFileUploadResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/organizations/balance": {
"get": {
"tags": [
"Organizations"
],
"summary": "Get Balance",
"description": "Get the current credit balance for the organization",
"operationId": "get_balance_organizations_balance_get",
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BalanceResponse"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/training-jobs": {
"post": {
"tags": [
"Training Jobs"
],
"summary": "Create Training Job",
"description": "Create a new training job",
"operationId": "create_training_job_training_jobs_post",
"security": [
{
"HTTPBearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTrainingJobRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrainingJob"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Training Jobs"
],
"summary": "List Training Jobs",
"description": "List training jobs",
"operationId": "list_training_jobs_training_jobs_get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 10,
"title": "Limit"
}
},
{
"name": "status",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrainingJobListResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/training-jobs/cost-estimation": {
"post": {
"tags": [
"Training Jobs"
],
"summary": "Estimate Training Cost",
"description": "Estimate training cost before execution",
"operationId": "estimate_training_cost_training_jobs_cost_estimation_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateTrainingCostRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateTrainingCostResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
},
"security": [
{
"HTTPBearer": []
}
]
}
},
"/training-jobs/{job_id}": {
"get": {
"tags": [
"Training Jobs"
],
"summary": "Get Training Job",
"description": "Get a training job by ID",
"operationId": "get_training_job_training_jobs__job_id__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "job_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Job Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TrainingJob"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/evaluations": {
"post": {
"tags": [
"Evaluations"
],
"summary": "Create Eval Job",
"description": "Create a new evaluation job",
"operationId": "create_eval_job_evaluations_post",
"security": [
{
"HTTPBearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateEvalJobRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvalJob"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"Evaluations"
],
"summary": "List Eval Jobs",
"description": "List evaluation jobs",
"operationId": "list_eval_jobs_evaluations_get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "page",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1,
"title": "Page"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 10,
"title": "Limit"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvalJobListResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/evaluations/{eval_id}": {
"get": {
"tags": [
"Evaluations"
],
"summary": "Get Eval Job",
"description": "Get an evaluation job by ID",
"operationId": "get_eval_job_evaluations__eval_id__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "eval_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Eval Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvalJob"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/filesets/": {
"post": {
"tags": [
"FileSets"
],
"summary": "Create File Set",
"description": "Create a new FileSet for the organization.",
"operationId": "create_file_set_filesets__post",
"security": [
{
"HTTPBearer": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFileSetRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileSet"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"FileSets"
],
"summary": "List File Sets",
"description": "List all FileSets for the organization, optionally including public filesets.",
"operationId": "list_file_sets_filesets__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "include_public",
"in": "query",
"required": false,
"schema": {
"type": "boolean",
"description": "Include public filesets",
"default": false,
"title": "Include Public"
},
"description": "Include public filesets"
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFileSetsResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/filesets/{file_set_id}": {
"get": {
"tags": [
"FileSets"
],
"summary": "Get File Set",
"description": "Get a specific FileSet by ID.",
"operationId": "get_file_set_filesets__file_set_id__get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "file_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Set Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileSet"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/filesets/{file_set_id}/files": {
"post": {
"tags": [
"FileSets"
],
"summary": "Add File To Set",
"description": "Add a file to a FileSet by providing file information and metadata.",
"operationId": "add_file_to_set_filesets__file_set_id__files_post",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "file_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Set Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateFileSetFileRequest"
}
}
}
},
"responses": {
"201": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileSetFile"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
},
"get": {
"tags": [
"FileSets"
],
"summary": "List Files In Set",
"description": "List all files in a FileSet.",
"operationId": "list_files_in_set_filesets__file_set_id__files_get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "file_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Set Id"
}
},
{
"name": "limit",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 10,
"title": "Limit"
}
},
{
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListFileSetFilesResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/filesets/{file_set_id}/status": {
"get": {
"tags": [
"FileSets"
],
"summary": "Get File Set Status",
"description": "Get file status counts for a FileSet.",
"operationId": "get_file_set_status_filesets__file_set_id__status_get",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "file_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Set Id"
}
}
],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileStatusCountsResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
},
"/filesets/{file_set_id}/retry-failed": {
"post": {
"tags": [
"FileSets"
],
"summary": "Retry Failed Files",
"description": "Retry all failed files in a FileSet.",
"operationId": "retry_failed_files_filesets__file_set_id__retry_failed_post",
"security": [
{
"HTTPBearer": []
}
],
"parameters": [
{
"name": "file_set_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Set Id"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetryFailedFilesRequest",
"default": {
"max_retries": 3
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetryFailedFilesResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"BalanceResponse": {
"properties": {
"balance_dollars": {
"type": "number",
"title": "Balance Dollars"
}
},
"type": "object",
"required": [
"balance_dollars"
],
"title": "BalanceResponse"
},
"BigQuerySeedGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "BIGQUERY_SEED_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "BIGQUERY_SEED_GENERATOR"
},
"query": {
"type": "string",
"title": "Query",
"description": "BigQuery SQL query to execute"
},
"seed_text_column": {
"type": "string",
"title": "Seed Text Column",
"description": "Column name for Seed.seed_text",
"default": "text"
},
"date_column": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Date Column",
"description": "Column name for Seed.seed_creation_date"
},
"max_rows": {
"type": "integer",
"title": "Max Rows",
"description": "Total rows to fetch across all batches",
"default": 10000
}
},
"type": "object",
"required": [
"query"
],
"title": "BigQuerySeedGenerator"
},
"BinaryAnswerType": {
"properties": {
"answer_type": {
"type": "string",
"const": "BINARY",
"title": "Answer Type",
"default": "BINARY"
},
"answer_format_instruction": {
"type": "string",
"title": "Answer Format Instruction",
"description": "Instructions describing how the answer should be formatted and given.",
"default": "This is a binary yes/no question. You are estimating the probability that the answer is 'Yes'. Provide your confidence as a value between 0 (definitely No) and 1 (definitely Yes). Provide your probability estimate for Yes as a decimal between 0 and 1. Provide your answer between tags. Example: 0.75"
},
"labeler_instruction": {
"type": "string",
"title": "Labeler Instruction",
"description": "Instructions for the labeler.",
"default": "The answer should be ONLY '1', '0', or 'Undetermined'. '1' means yes, '0' means no, and 'Undetermined' means the answer is not clear. Do not include any other text or explanation."
},
"question_generation_instruction": {
"type": "string",
"title": "Question Generation Instruction",
"description": "Instructions for generating questions of this type.",
"default": "Generate questions that can be answered with Yes or No. Frame the question so it has exactly two possible outcomes: Yes or No. The question should start with words like 'Will', 'Is', 'Does', 'Has', 'Can', etc. A clear and unambiguous yes/no question, based on the provided seed_text."
},
"reward_function_type": {
"anyOf": [
{
"$ref": "#/components/schemas/RewardFunctionType"
},
{
"type": "null"
}
],
"default": "binary_brier"
}
},
"type": "object",
"title": "BinaryAnswerType"
},
"ChatCompletionRequest": {
"properties": {
"model": {
"type": "string",
"title": "Model",
"description": "ID of the model to use"
},
"messages": {
"items": {
"$ref": "#/components/schemas/ChatMessage"
},
"type": "array",
"title": "Messages",
"description": "A list of messages comprising the conversation so far"
},
"temperature": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Temperature",
"description": "Sampling temperature between 0 and 2"
},
"max_tokens": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Tokens",
"description": "Maximum number of tokens to generate"
},
"top_p": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Top P",
"description": "Nucleus sampling parameter"
},
"stream": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Stream",
"description": "Whether to stream back partial progress",
"default": false
},
"n": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "N",
"description": "Number of chat completion choices to generate",
"default": 1
},
"stop": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stop",
"description": "Up to 4 sequences where the API will stop generating"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed",
"description": "Deterministic sampling seed"
}
},
"type": "object",
"required": [
"model",
"messages"
],
"title": "ChatCompletionRequest",
"examples": [
{
"messages": [
{
"content": "Will Bitcoin increase by more than 10% over the next 3 months? Answer as a probability between 0 and 1 between tags.",
"role": "user"
}
],
"model": "LightningRodLabs/foresight-v3"
}
]
},
"ChatCompletionResponse": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "A unique identifier for the chat completion"
},
"object": {
"type": "string",
"const": "chat.completion",
"title": "Object",
"description": "The object type",
"default": "chat.completion"
},
"created": {
"type": "integer",
"title": "Created",
"description": "Unix timestamp of when the completion was created"
},
"model": {
"type": "string",
"title": "Model",
"description": "The model used for the chat completion"
},
"choices": {
"items": {
"$ref": "#/components/schemas/Choice"
},
"type": "array",
"title": "Choices",
"description": "A list of chat completion choices"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"type": "null"
}
],
"description": "Usage statistics for the completion request"
}
},
"type": "object",
"required": [
"id",
"created",
"model",
"choices"
],
"title": "ChatCompletionResponse"
},
"ChatMessage": {
"properties": {
"role": {
"type": "string",
"title": "Role",
"description": "The role of the message author (system, user, or assistant)"
},
"content": {
"type": "string",
"title": "Content",
"description": "The content of the message"
}
},
"type": "object",
"required": [
"role",
"content"
],
"title": "ChatMessage",
"examples": [
{
"content": "Will the S&P 500 close above 6000 by the end of 2025?",
"role": "user"
}
]
},
"Choice": {
"properties": {
"index": {
"type": "integer",
"title": "Index",
"description": "The index of this choice"
},
"message": {
"$ref": "#/components/schemas/ResponseMessage",
"description": "The message generated by the model"
},
"finish_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Finish Reason",
"description": "The reason the model stopped generating tokens"
}
},
"type": "object",
"required": [
"index",
"message"
],
"title": "Choice"
},
"CompletionChoice": {
"properties": {
"index": {
"type": "integer",
"title": "Index",
"description": "The index of this choice"
},
"text": {
"type": "string",
"title": "Text",
"description": "The generated text"
},
"finish_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Finish Reason",
"description": "The reason the model stopped generating tokens"
}
},
"type": "object",
"required": [
"index",
"text"
],
"title": "CompletionChoice"
},
"CompletionRequest": {
"properties": {
"model": {
"type": "string",
"title": "Model",
"description": "ID of the model to use"
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Prompt",
"description": "The prompt(s) to generate completions for"
},
"temperature": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Temperature",
"description": "Sampling temperature between 0 and 2"
},
"max_tokens": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Tokens",
"description": "Maximum number of tokens to generate"
},
"top_p": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Top P",
"description": "Nucleus sampling parameter"
},
"stream": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Stream",
"description": "Whether to stream back partial progress",
"default": false
},
"n": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "N",
"description": "Number of completions to generate",
"default": 1
},
"stop": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Stop",
"description": "Up to 4 sequences where the API will stop generating"
},
"seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Seed",
"description": "Deterministic sampling seed"
}
},
"type": "object",
"required": [
"model",
"prompt"
],
"title": "CompletionRequest"
},
"CompletionResponse": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "A unique identifier for the completion"
},
"object": {
"type": "string",
"const": "text_completion",
"title": "Object",
"description": "The object type",
"default": "text_completion"
},
"created": {
"type": "integer",
"title": "Created",
"description": "Unix timestamp of when the completion was created"
},
"model": {
"type": "string",
"title": "Model",
"description": "The model used for the completion"
},
"choices": {
"items": {
"$ref": "#/components/schemas/CompletionChoice"
},
"type": "array",
"title": "Choices",
"description": "A list of completion choices"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Usage"
},
{
"type": "null"
}
],
"description": "Usage statistics for the completion request"
}
},
"type": "object",
"required": [
"id",
"created",
"model",
"choices"
],
"title": "CompletionResponse"
},
"ContinuousAnswerType": {
"properties": {
"answer_type": {
"type": "string",
"const": "CONTINUOUS",
"title": "Answer Type",
"default": "CONTINUOUS"
},
"answer_format_instruction": {
"type": "string",
"title": "Answer Format Instruction",
"description": "Instructions describing how the answer should be formatted and given.",
"default": "This question expects a numeric value as the answer. Provide your best estimate as a single number. Include units if specified in the question. Provide your answer between tags. Example: 42.5"
},
"labeler_instruction": {
"type": "string",
"title": "Labeler Instruction",
"description": "Instructions for the labeler.",
"default": "The answer should be ONLY a single exact numeric value, not a range. For example: '42.5' or '1000', not '40-45' or 'between 900 and 1100', or 'Undetermined'. Do not include any other text or explanation."
},
"question_generation_instruction": {
"type": "string",
"title": "Question Generation Instruction",
"description": "Instructions for generating questions of this type.",
"default": "Generate questions that expect a numeric value as the answer. Specify the units if applicable (e.g., dollars, percent, count). A clear and unambiguous question, based on the provided seed_text, that expects a numeric value as the answer."
},
"reward_function_type": {
"anyOf": [
{
"$ref": "#/components/schemas/RewardFunctionType"
},
{
"type": "null"
}
],
"description": "Reward function type for scoring rollouts. None for answer types that don't support scoring."
}
},
"type": "object",
"title": "ContinuousAnswerType"
},
"CreateDatasetResponse": {
"properties": {
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "CreateDatasetResponse"
},
"CreateEvalJobRequest": {
"properties": {
"dataset": {
"$ref": "#/components/schemas/SampleDatasetConfig"
},
"model_id": {
"type": "string",
"title": "Model Id"
},
"benchmark_model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Benchmark Model Id"
},
"temperature": {
"type": "number",
"title": "Temperature",
"default": 0.0
}
},
"type": "object",
"required": [
"dataset",
"model_id"
],
"title": "CreateEvalJobRequest"
},
"CreateFileSetFileRequest": {
"properties": {
"file_id": {
"type": "string",
"title": "File Id",
"description": "ID of the file"
},
"file_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "File Date",
"description": "The date of the document content. Critical for forward-looking question generation pipelines - this date determines the temporal context for forecasting questions."
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "Optional file-level metadata"
},
"deduplication_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Deduplication Id",
"description": "Optional id used to deduplicate file additions to a FileSet"
},
"auto_extract_metadata": {
"type": "boolean",
"title": "Auto Extract Metadata",
"description": "If true and the FileSet has a metadata schema, automatically extract metadata from file content using LLM. User-provided metadata takes precedence over extracted values.",
"default": false
}
},
"type": "object",
"required": [
"file_id"
],
"title": "CreateFileSetFileRequest"
},
"CreateFileSetRequest": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Human-readable name for the FileSet"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Optional description of the FileSet's purpose"
},
"metadata_schema": {
"anyOf": [
{
"$ref": "#/components/schemas/FileSetMetadataSchemaInput"
},
{
"type": "null"
}
],
"description": "Optional schema for validating file metadata"
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateFileSetRequest"
},
"CreateFileUploadRequest": {
"properties": {
"filename": {
"type": "string",
"title": "Filename",
"description": "Original filename"
},
"size_bytes": {
"type": "integer",
"minimum": 1.0,
"title": "Size Bytes",
"description": "File size in bytes"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mime Type",
"description": "MIME type of the file"
}
},
"type": "object",
"required": [
"filename",
"size_bytes"
],
"title": "CreateFileUploadRequest"
},
"CreateFileUploadResponse": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"original_file_name": {
"type": "string",
"title": "Original File Name"
},
"cloud_storage_path": {
"type": "string",
"title": "Cloud Storage Path"
},
"upload_url": {
"type": "string",
"title": "Upload Url",
"description": "Signed GCS upload URL for direct upload"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mime Type"
},
"size_bytes": {
"type": "integer",
"title": "Size Bytes"
},
"metadata": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "File-level metadata"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"expires_at": {
"type": "string",
"format": "date-time",
"title": "Expires At",
"description": "When the upload URL expires"
}
},
"type": "object",
"required": [
"id",
"original_file_name",
"cloud_storage_path",
"upload_url",
"mime_type",
"size_bytes",
"created_at",
"expires_at"
],
"title": "CreateFileUploadResponse"
},
"CreateTrainingJobRequest": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"config": {
"$ref": "#/components/schemas/TrainingConfig"
}
},
"type": "object",
"required": [
"config"
],
"title": "CreateTrainingJobRequest"
},
"CreateTransformConfig": {
"oneOf": [
{
"$ref": "#/components/schemas/ForwardLookingQuestionGenerator"
},
{
"$ref": "#/components/schemas/FileSetQuerySeedGenerator"
},
{
"$ref": "#/components/schemas/FileSetSeedGenerator"
},
{
"$ref": "#/components/schemas/GdeltSeedGenerator"
},
{
"$ref": "#/components/schemas/NewsSeedGenerator"
},
{
"$ref": "#/components/schemas/QuestionAndLabelGenerator"
},
{
"$ref": "#/components/schemas/QuestionGenerator"
},
{
"$ref": "#/components/schemas/QuestionPipeline"
},
{
"$ref": "#/components/schemas/QuestionRenderer"
},
{
"$ref": "#/components/schemas/WebSearchLabeler"
}
],
"discriminator": {
"propertyName": "config_type",
"mapping": {
"FILESET_QUERY_SEED_GENERATOR": "#/components/schemas/FileSetQuerySeedGenerator",
"FILESET_SEED_GENERATOR": "#/components/schemas/FileSetSeedGenerator",
"FORWARD_LOOKING_QUESTION_GENERATOR": "#/components/schemas/ForwardLookingQuestionGenerator",
"GDELT_SEED_GENERATOR": "#/components/schemas/GdeltSeedGenerator",
"NEWS_SEED_GENERATOR": "#/components/schemas/NewsSeedGenerator",
"QUESTION_AND_LABEL_GENERATOR": "#/components/schemas/QuestionAndLabelGenerator",
"QUESTION_GENERATOR": "#/components/schemas/QuestionGenerator",
"QUESTION_PIPELINE": "#/components/schemas/QuestionPipeline",
"QUESTION_RENDERER": "#/components/schemas/QuestionRenderer",
"WEB_SEARCH_LABELER": "#/components/schemas/WebSearchLabeler"
}
}
},
"CreateTransformJobRequest": {
"properties": {
"config": {
"$ref": "#/components/schemas/CreateTransformConfig"
},
"input_dataset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Input Dataset Id"
},
"max_questions": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Questions"
},
"max_cost_dollars": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Max Cost Dollars"
},
"configuration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Configuration Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
}
},
"type": "object",
"required": [
"config"
],
"title": "CreateTransformJobRequest"
},
"DatasetMetadata": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"num_rows": {
"type": "integer",
"title": "Num Rows"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"num_rows",
"created_at",
"updated_at"
],
"title": "DatasetMetadata"
},
"EstimateCostRequest": {
"properties": {
"config": {
"$ref": "#/components/schemas/CreateTransformConfig"
},
"max_questions": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Questions"
}
},
"type": "object",
"required": [
"config"
],
"title": "EstimateCostRequest"
},
"EstimateCostResponse": {
"properties": {
"total_cost_dollars": {
"type": "number",
"title": "Total Cost Dollars"
},
"llm_cost_dollars": {
"type": "number",
"title": "Llm Cost Dollars"
},
"web_search_cost_dollars": {
"type": "number",
"title": "Web Search Cost Dollars"
},
"url_download_cost_dollars": {
"type": "number",
"title": "Url Download Cost Dollars"
},
"gemini_grounding_cost_dollars": {
"type": "number",
"title": "Gemini Grounding Cost Dollars",
"default": 0.0
},
"bigquery_cost_dollars": {
"type": "number",
"title": "Bigquery Cost Dollars",
"default": 0.0
},
"usage": {
"$ref": "#/components/schemas/UsageSummary"
},
"steps": {
"items": {
"$ref": "#/components/schemas/StepCostBreakdown"
},
"type": "array",
"title": "Steps"
}
},
"type": "object",
"required": [
"total_cost_dollars",
"llm_cost_dollars",
"web_search_cost_dollars",
"url_download_cost_dollars",
"usage",
"steps"
],
"title": "EstimateCostResponse"
},
"EstimateTrainingCostRequest": {
"properties": {
"config": {
"$ref": "#/components/schemas/TrainingConfig"
}
},
"type": "object",
"required": [
"config"
],
"title": "EstimateTrainingCostRequest"
},
"EstimateTrainingCostResponse": {
"properties": {
"total_cost_dollars": {
"type": "number",
"title": "Total Cost Dollars"
},
"prefill_tokens": {
"type": "integer",
"title": "Prefill Tokens"
},
"sample_tokens": {
"type": "integer",
"title": "Sample Tokens"
},
"train_tokens": {
"type": "integer",
"title": "Train Tokens"
},
"effective_steps": {
"type": "integer",
"title": "Effective Steps"
},
"notes": {
"type": "string",
"title": "Notes"
},
"warning_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Warning Message"
}
},
"type": "object",
"required": [
"total_cost_dollars",
"prefill_tokens",
"sample_tokens",
"train_tokens",
"effective_steps",
"notes"
],
"title": "EstimateTrainingCostResponse"
},
"EvalConfig": {
"properties": {
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"model_id": {
"type": "string",
"title": "Model Id"
},
"dataset": {
"$ref": "#/components/schemas/SampleDatasetConfig"
},
"benchmark_model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Benchmark Model Id"
},
"temperature": {
"type": "number",
"title": "Temperature",
"default": 0.0
},
"max_tokens": {
"type": "integer",
"title": "Max Tokens",
"default": 8192
},
"max_concurrent": {
"type": "integer",
"title": "Max Concurrent",
"default": 50
}
},
"type": "object",
"required": [
"organization_id",
"model_id",
"dataset"
],
"title": "EvalConfig"
},
"EvalJob": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"config": {
"$ref": "#/components/schemas/EvalConfig"
},
"cost_dollars": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cost Dollars"
},
"current_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Current Step"
},
"total_steps": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total Steps"
},
"status": {
"$ref": "#/components/schemas/EvalJobStatus"
},
"metrics": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metrics"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error Message"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"organization_id",
"config",
"status",
"created_at",
"updated_at"
],
"title": "EvalJob"
},
"EvalJobListResponse": {
"properties": {
"jobs": {
"items": {
"$ref": "#/components/schemas/EvalJob"
},
"type": "array",
"title": "Jobs"
},
"total_count": {
"type": "integer",
"title": "Total Count"
}
},
"type": "object",
"required": [
"jobs",
"total_count"
],
"title": "EvalJobListResponse"
},
"EvalJobStatus": {
"type": "string",
"enum": [
"STARTING",
"RUNNING",
"COMPLETED",
"FAILED"
],
"title": "EvalJobStatus"
},
"EventUsageSummary": {
"properties": {
"count": {
"type": "integer",
"title": "Count",
"default": 0
},
"amount": {
"type": "number",
"title": "Amount",
"default": 0.0
},
"cost": {
"type": "number",
"title": "Cost",
"default": 0.0
},
"cached_count": {
"type": "integer",
"title": "Cached Count",
"default": 0
}
},
"type": "object",
"title": "EventUsageSummary",
"description": "Usage for a single event type."
},
"FileSet": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"file_count": {
"type": "integer",
"title": "File Count"
},
"indexed_file_count": {
"type": "integer",
"title": "Indexed File Count"
},
"metadata_schema": {
"anyOf": [
{
"$ref": "#/components/schemas/FileSetMetadataSchema"
},
{
"type": "null"
}
]
},
"is_public": {
"type": "boolean",
"title": "Is Public",
"default": false
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"name",
"description",
"file_count",
"indexed_file_count",
"created_at",
"updated_at"
],
"title": "FileSet"
},
"FileSetContextGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "FILESET_CONTEXT_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "FILESET_CONTEXT_GENERATOR"
},
"file_set_id": {
"type": "string",
"title": "File Set Id",
"description": "FileSet ID to query for context"
},
"metadata_filter_keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "Metadata Filter Keys",
"description": "Keys from seed's file_metadata for dynamic filtering (e.g., ['ticker'])"
},
"metadata_filter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Metadata Filter",
"description": "Static AIP-160 metadata filter (combined with dynamic via AND)"
},
"system_instruction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "System Instruction",
"description": "Optional system instruction for the Gemini model"
},
"query_template": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Query Template",
"description": "Template with {question} placeholder; default: raw question text"
},
"temporal_constraint": {
"anyOf": [
{
"$ref": "#/components/schemas/TemporalConstraint"
},
{
"type": "null"
}
],
"description": "Filter documents by date relative to seed date. BEFORE (<=) for context without lookahead, AFTER (>) for future docs."
},
"date_metadata_key": {
"type": "string",
"title": "Date Metadata Key",
"description": "Gemini metadata key storing unix timestamp for temporal filtering",
"default": "file_date"
},
"model": {
"type": "string",
"title": "Model",
"description": "Gemini model to use for file search",
"default": "gemini-3-flash-preview"
}
},
"type": "object",
"required": [
"file_set_id"
],
"title": "FileSetContextGenerator",
"description": "Configuration for FileSet Context Generator transform."
},
"FileSetFile": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"original_file_name": {
"type": "string",
"title": "Original File Name"
},
"cloud_storage_path": {
"type": "string",
"title": "Cloud Storage Path"
},
"mime_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mime Type"
},
"size_bytes": {
"type": "integer",
"title": "Size Bytes"
},
"character_count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Character Count"
},
"metadata": {
"anyOf": [
{
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata"
},
"gemini_file_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Gemini File Id"
},
"file_created_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "File Created Date"
},
"status": {
"$ref": "#/components/schemas/FileSetFileStatus",
"default": "PENDING"
},
"status_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Status Message"
},
"retry_count": {
"type": "integer",
"title": "Retry Count",
"default": 0
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"original_file_name",
"cloud_storage_path",
"mime_type",
"size_bytes",
"character_count",
"metadata",
"gemini_file_id",
"file_created_date",
"created_at",
"updated_at"
],
"title": "FileSetFile"
},
"FileSetFileStatus": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"ACTIVE",
"FAILED"
],
"title": "FileSetFileStatus"
},
"FileSetMetadataSchema": {
"properties": {
"fields": {
"items": {
"$ref": "#/components/schemas/MetadataFieldDefinition"
},
"type": "array",
"title": "Fields",
"description": "List of metadata field definitions"
}
},
"type": "object",
"title": "FileSetMetadataSchema",
"description": "Schema definition for file metadata in a FileSet."
},
"FileSetMetadataSchemaInput": {
"properties": {
"fields": {
"items": {
"$ref": "#/components/schemas/MetadataFieldDefinitionInput"
},
"type": "array",
"title": "Fields",
"description": "List of metadata field definitions"
}
},
"type": "object",
"required": [
"fields"
],
"title": "FileSetMetadataSchemaInput",
"description": "Schema definition for file metadata in a FileSet (input/request version)."
},
"FileSetQuerySeedGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "FILESET_QUERY_SEED_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "FILESET_QUERY_SEED_GENERATOR"
},
"file_set_id": {
"type": "string",
"title": "File Set Id",
"description": "FileSet ID to query"
},
"prompts": {
"items": {
"type": "string"
},
"type": "array",
"title": "Prompts",
"description": "List of queries to run against the fileset"
},
"metadata_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Metadata Filters",
"description": "Optional list of AIP-160 metadata filters to select which documents to process. Documents matching ANY filter will be included. (e.g., [\"ticker='AAL'\", \"ticker='MSFT'\"])"
},
"system_instruction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "System Instruction",
"description": "Optional system instruction for the Gemini model"
}
},
"type": "object",
"required": [
"file_set_id",
"prompts"
],
"title": "FileSetQuerySeedGenerator",
"description": "Configuration for FileSet Query Seed Generator transform."
},
"FileSetRAGLabeler": {
"properties": {
"config_type": {
"type": "string",
"const": "FILESET_RAG_LABELER",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "FILESET_RAG_LABELER"
},
"file_set_id": {
"type": "string",
"title": "File Set Id",
"description": "FileSet ID to query for labeling"
},
"metadata_filter_keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "Metadata Filter Keys",
"description": "Keys from seed's file_metadata for dynamic filtering (e.g., ['ticker'])"
},
"metadata_filter": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Metadata Filter",
"description": "Static AIP-160 metadata filter (combined with dynamic via AND)"
},
"system_instruction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "System Instruction",
"description": "Optional system instruction for the Gemini RAG query"
},
"confidence_threshold": {
"type": "number",
"title": "Confidence Threshold",
"description": "Minimum confidence threshold for including questions",
"default": 0.9
},
"answer_type": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/BinaryAnswerType"
},
{
"$ref": "#/components/schemas/MultipleChoiceAnswerType"
},
{
"$ref": "#/components/schemas/ContinuousAnswerType"
},
{
"$ref": "#/components/schemas/FreeResponseAnswerType"
}
],
"discriminator": {
"propertyName": "answer_type",
"mapping": {
"BINARY": "#/components/schemas/BinaryAnswerType",
"CONTINUOUS": "#/components/schemas/ContinuousAnswerType",
"FREE_RESPONSE": "#/components/schemas/FreeResponseAnswerType",
"MULTIPLE_CHOICE": "#/components/schemas/MultipleChoiceAnswerType"
}
}
},
{
"type": "null"
}
],
"title": "Answer Type",
"description": "The type of answer expected, used to guide the labeler"
},
"temporal_constraint": {
"anyOf": [
{
"$ref": "#/components/schemas/TemporalConstraint"
},
{
"type": "null"
}
],
"description": "Filter documents by date relative to seed date. AFTER (>) for resolution docs, BEFORE (<=) for historical only."
},
"date_metadata_key": {
"type": "string",
"title": "Date Metadata Key",
"description": "Gemini metadata key storing unix timestamp for temporal filtering",
"default": "file_date"
},
"model": {
"type": "string",
"title": "Model",
"description": "Gemini model for RAG query",
"default": "gemini-3-flash-preview"
}
},
"type": "object",
"required": [
"file_set_id"
],
"title": "FileSetRAGLabeler",
"description": "Configuration for FileSet RAG Labeler transform."
},
"FileSetSeedGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "FILESET_SEED_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "FILESET_SEED_GENERATOR"
},
"file_set_id": {
"type": "string",
"title": "File Set Id",
"description": "FileSet ID to read files from"
},
"chunk_size": {
"type": "integer",
"minimum": 100.0,
"title": "Chunk Size",
"description": "Number of characters per chunk",
"default": 4000
},
"chunk_overlap": {
"type": "integer",
"minimum": 0.0,
"title": "Chunk Overlap",
"description": "Number of overlapping characters between consecutive chunks",
"default": 200
},
"metadata_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Metadata Filters",
"description": "Optional list of metadata filters to select which files to process. Files matching ANY filter will be included. (e.g., [\"ticker='AAL'\", \"ticker='MSFT'\"])"
}
},
"type": "object",
"required": [
"file_set_id"
],
"title": "FileSetSeedGenerator",
"description": "Configuration for FileSet Seed Generator transform."
},
"FileStatusCountsResponse": {
"properties": {
"pending": {
"type": "integer",
"title": "Pending",
"description": "Files awaiting processing",
"default": 0
},
"processing": {
"type": "integer",
"title": "Processing",
"description": "Files currently being processed",
"default": 0
},
"active": {
"type": "integer",
"title": "Active",
"description": "Successfully processed files",
"default": 0
},
"failed": {
"type": "integer",
"title": "Failed",
"description": "Files that failed processing",
"default": 0
}
},
"type": "object",
"title": "FileStatusCountsResponse"
},
"FilterCriteria": {
"properties": {
"rubric": {
"type": "string",
"title": "Rubric",
"description": "Scoring rubric/prompt for evaluating content"
},
"min_score": {
"type": "number",
"maximum": 1.0,
"minimum": 0.0,
"title": "Min Score",
"description": "Minimum score threshold",
"default": 0.5
},
"model_name": {
"type": "string",
"title": "Model Name",
"description": "Name of the model (in openrouter) to use for scoring",
"default": "google/gemini-3-flash-preview"
}
},
"type": "object",
"required": [
"rubric"
],
"title": "FilterCriteria",
"description": "Reusable filter criteria for LLM-based content scoring and filtering."
},
"ForwardLookingQuestion": {
"properties": {
"question_type": {
"type": "string",
"const": "FORWARD_LOOKING_QUESTION",
"title": "Question Type",
"default": "FORWARD_LOOKING_QUESTION"
},
"question_text": {
"type": "string",
"title": "Question Text"
},
"date_close": {
"type": "string",
"format": "date-time",
"title": "Date Close"
},
"event_date": {
"type": "string",
"format": "date-time",
"title": "Event Date"
},
"resolution_criteria": {
"type": "string",
"title": "Resolution Criteria"
},
"prediction_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Prediction Date"
}
},
"type": "object",
"required": [
"question_text",
"date_close",
"event_date",
"resolution_criteria"
],
"title": "ForwardLookingQuestion"
},
"ForwardLookingQuestionGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "FORWARD_LOOKING_QUESTION_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "FORWARD_LOOKING_QUESTION_GENERATOR"
},
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instructions",
"description": "Instructions for question generation. If not provided, uses sensible defaults."
},
"examples": {
"items": {
"type": "string"
},
"type": "array",
"title": "Examples",
"description": "Example questions to guide generation"
},
"bad_examples": {
"items": {
"type": "string"
},
"type": "array",
"title": "Bad Examples",
"description": "Examples of questions to avoid"
},
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/FilterCriteria"
},
{
"items": {
"$ref": "#/components/schemas/FilterCriteria"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "Optional filter criteria to apply after question generation"
},
"questions_per_seed": {
"type": "integer",
"title": "Questions Per Seed",
"description": "Number of questions to generate per seed",
"default": 1
},
"include_default_filter": {
"type": "boolean",
"title": "Include Default Filter",
"description": "Whether to include the default filter for generated questions",
"default": false
},
"answer_type": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/BinaryAnswerType"
},
{
"$ref": "#/components/schemas/MultipleChoiceAnswerType"
},
{
"$ref": "#/components/schemas/ContinuousAnswerType"
},
{
"$ref": "#/components/schemas/FreeResponseAnswerType"
}
],
"discriminator": {
"propertyName": "answer_type",
"mapping": {
"BINARY": "#/components/schemas/BinaryAnswerType",
"CONTINUOUS": "#/components/schemas/ContinuousAnswerType",
"FREE_RESPONSE": "#/components/schemas/FreeResponseAnswerType",
"MULTIPLE_CHOICE": "#/components/schemas/MultipleChoiceAnswerType"
}
}
},
{
"type": "null"
}
],
"title": "Answer Type",
"description": "The type of answer expected for generated questions"
}
},
"type": "object",
"title": "ForwardLookingQuestionGenerator"
},
"FreeResponseAnswerType": {
"properties": {
"answer_type": {
"type": "string",
"const": "FREE_RESPONSE",
"title": "Answer Type",
"default": "FREE_RESPONSE"
},
"answer_format_instruction": {
"type": "string",
"title": "Answer Format Instruction",
"description": "Instructions describing how the answer should be formatted and given.",
"default": "This question expects a free-form text response. Provide an answer that directly addresses what the question is asking. Provide your answer between tags. Example: The company announced a new product line."
},
"labeler_instruction": {
"type": "string",
"title": "Labeler Instruction",
"description": "Instructions for the labeler.",
"default": "Respond with the correct answer as a text description."
},
"question_generation_instruction": {
"type": "string",
"title": "Question Generation Instruction",
"description": "Instructions for generating questions of this type.",
"default": "Generate questions that expect a free-form text response. A clear and unambiguous question, based on the provided seed_text, that expects a free-form text response."
},
"reward_function_type": {
"anyOf": [
{
"$ref": "#/components/schemas/RewardFunctionType"
},
{
"type": "null"
}
],
"description": "Reward function type for scoring rollouts. None for answer types that don't support scoring."
}
},
"type": "object",
"title": "FreeResponseAnswerType"
},
"GdeltSeedGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "GDELT_SEED_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "GDELT_SEED_GENERATOR"
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "Start date for seed search"
},
"end_date": {
"type": "string",
"format": "date-time",
"title": "End Date",
"description": "End date for seed search"
},
"interval_duration_days": {
"type": "integer",
"title": "Interval Duration Days",
"description": "Duration of each interval in days",
"default": 7
},
"articles_per_interval": {
"type": "integer",
"title": "Articles Per Interval",
"description": "Number of articles to fetch per interval from BigQuery",
"default": 1000
}
},
"type": "object",
"required": [
"start_date",
"end_date"
],
"title": "GdeltSeedGenerator"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"JobUsage": {
"properties": {
"total": {
"anyOf": [
{
"$ref": "#/components/schemas/UsageSummary"
},
{
"type": "null"
}
]
},
"by_step": {
"anyOf": [
{
"additionalProperties": {
"$ref": "#/components/schemas/UsageSummary"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "By Step"
},
"max_cost_dollars": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Max Cost Dollars"
},
"current_cost_dollars": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Current Cost Dollars"
},
"estimated_cost_dollars": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Estimated Cost Dollars"
},
"pipeline_summary": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/PipelineStepSummary"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pipeline Summary"
}
},
"type": "object",
"title": "JobUsage",
"description": "Aggregated usage statistics for a transform job with step breakdown."
},
"LLMModelUsageSummary": {
"properties": {
"count": {
"type": "integer",
"title": "Count",
"default": 0
},
"input_tokens": {
"type": "integer",
"title": "Input Tokens",
"default": 0
},
"output_tokens": {
"type": "integer",
"title": "Output Tokens",
"default": 0
},
"cost": {
"type": "number",
"title": "Cost",
"default": 0.0
},
"cached_count": {
"type": "integer",
"title": "Cached Count",
"default": 0
}
},
"type": "object",
"title": "LLMModelUsageSummary",
"description": "Usage for a single LLM model."
},
"Label": {
"properties": {
"label": {
"type": "string",
"title": "Label"
},
"label_confidence": {
"type": "number",
"title": "Label Confidence"
},
"answer_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Answer Type"
},
"resolution_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Resolution Date"
},
"reasoning": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning"
},
"answer_sources": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Answer Sources"
}
},
"type": "object",
"required": [
"label",
"label_confidence"
],
"title": "Label"
},
"ListDatasetsResponse": {
"properties": {
"datasets": {
"items": {
"$ref": "#/components/schemas/DatasetMetadata"
},
"type": "array",
"title": "Datasets"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"has_more": {
"type": "boolean",
"title": "Has More"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"datasets",
"has_more",
"total"
],
"title": "ListDatasetsResponse"
},
"ListFileSetFilesResponse": {
"properties": {
"files": {
"items": {
"$ref": "#/components/schemas/FileSetFile"
},
"type": "array",
"title": "Files"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"has_more": {
"type": "boolean",
"title": "Has More"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"files",
"has_more",
"total"
],
"title": "ListFileSetFilesResponse"
},
"ListFileSetsResponse": {
"properties": {
"file_sets": {
"items": {
"$ref": "#/components/schemas/FileSet"
},
"type": "array",
"title": "File Sets"
}
},
"type": "object",
"required": [
"file_sets"
],
"title": "ListFileSetsResponse"
},
"ListTransformJobsResponse": {
"properties": {
"jobs": {
"items": {
"$ref": "#/components/schemas/TransformJob"
},
"type": "array",
"title": "Jobs"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"has_more": {
"type": "boolean",
"title": "Has More"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"jobs",
"has_more",
"total"
],
"title": "ListTransformJobsResponse"
},
"MetadataFieldDefinition": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name/key of the metadata field"
},
"field_type": {
"$ref": "#/components/schemas/MetadataFieldType",
"description": "The data type of the field. Boolean-like values should use \"string\" with canonical \"true\"/\"false\" values."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "Whether this field is required for all files",
"default": false
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Human-readable description of this field"
},
"extraction_hint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Extraction Hint",
"description": "Hint for LLM auto-extraction (e.g., 'the stock ticker symbol mentioned')"
}
},
"type": "object",
"required": [
"name",
"field_type"
],
"title": "MetadataFieldDefinition",
"description": "Definition of a metadata field for a FileSet."
},
"MetadataFieldDefinitionInput": {
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "The name/key of the metadata field"
},
"field_type": {
"$ref": "#/components/schemas/MetadataFieldType",
"description": "The data type of the field. Boolean-like values should use \"string\" with canonical \"true\"/\"false\" values."
},
"required": {
"type": "boolean",
"title": "Required",
"description": "Whether this field is required for all files"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Human-readable description of this field"
},
"extraction_hint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Extraction Hint",
"description": "Hint for LLM auto-extraction (e.g., 'the stock ticker symbol mentioned')"
}
},
"type": "object",
"required": [
"name",
"field_type",
"required"
],
"title": "MetadataFieldDefinitionInput",
"description": "Definition of a metadata field for a FileSet (input/request version)."
},
"MetadataFieldType": {
"type": "string",
"enum": [
"string",
"number"
],
"title": "MetadataFieldType"
},
"MockTransformConfig": {
"properties": {
"config_type": {
"type": "string",
"const": "MOCK",
"title": "Config Type",
"default": "MOCK"
},
"num_seeds": {
"type": "integer",
"title": "Num Seeds",
"description": "Number of mock seeds to generate (0 = not a seed generator)",
"default": 0
},
"seed_text_template": {
"type": "string",
"title": "Seed Text Template",
"description": "Template for seed text",
"default": "Mock seed content {index}"
},
"delay_seconds": {
"type": "number",
"title": "Delay Seconds",
"description": "Simulated processing time per item",
"default": 0.1
},
"delay_variance": {
"type": "number",
"title": "Delay Variance",
"description": "Random variance (+/- seconds)",
"default": 0.05
},
"error_rate": {
"type": "number",
"maximum": 1.0,
"minimum": 0.0,
"title": "Error Rate",
"description": "Probability of error (0.0-1.0)",
"default": 0.01
},
"error_message": {
"type": "string",
"title": "Error Message",
"description": "Error message when error_rate triggers",
"default": "Mock error"
},
"expansion_factor": {
"type": "integer",
"minimum": 1.0,
"title": "Expansion Factor",
"description": "Outputs per input (1:N expansion)",
"default": 1
},
"filter_rate": {
"type": "number",
"maximum": 1.0,
"minimum": 0.0,
"title": "Filter Rate",
"description": "Probability of marking invalid",
"default": 0.0
},
"add_question": {
"type": "boolean",
"title": "Add Question",
"description": "Add a mock question to samples",
"default": false
},
"question_template": {
"type": "string",
"title": "Question Template",
"description": "Template for question text",
"default": "Mock question {index}?"
},
"metadata_additions": {
"additionalProperties": true,
"type": "object",
"title": "Metadata Additions",
"description": "Added to sample.meta"
},
"estimated_input_tokens": {
"type": "integer",
"title": "Estimated Input Tokens",
"description": "Estimated input tokens per call",
"default": 0
},
"estimated_output_tokens": {
"type": "integer",
"title": "Estimated Output Tokens",
"description": "Estimated output tokens per call",
"default": 0
},
"estimated_model_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Estimated Model Name",
"description": "Model name for cost estimation"
},
"simulated_cost_per_call": {
"type": "number",
"title": "Simulated Cost Per Call",
"description": "Simulated cost per call in dollars (records usage event when > 0)",
"default": 0.0
},
"random_seed": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Random Seed",
"description": "Seed for deterministic behavior"
}
},
"type": "object",
"title": "MockTransformConfig"
},
"ModelConfig": {
"properties": {
"model_name": {
"type": "string",
"title": "Model Name",
"default": "meta-llama/llama-3.3-70b-instruct"
},
"model_source": {
"$ref": "#/components/schemas/ModelSourceType",
"default": "OPEN_ROUTER"
},
"temperature": {
"type": "number",
"title": "Temperature",
"default": 1.0
},
"max_tokens": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Tokens"
},
"ip_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ip Address"
},
"lora_base_model_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Lora Base Model Name"
},
"lora_repo_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Lora Repo Path"
},
"lora_checkpoint_path": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Lora Checkpoint Path"
},
"runpod_endpoint_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Runpod Endpoint Id"
},
"is_lightningrod_model": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Lightningrod Model"
},
"openrouter_provider": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Openrouter Provider"
},
"reasoning_effort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning Effort"
},
"is_reasoning_model": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Reasoning Model"
},
"disable_reasoning": {
"type": "boolean",
"title": "Disable Reasoning",
"default": false
},
"use_pipeline_key": {
"type": "boolean",
"title": "Use Pipeline Key",
"default": false
}
},
"type": "object",
"title": "ModelConfig"
},
"ModelListResponse": {
"properties": {
"object": {
"type": "string",
"const": "list",
"title": "Object",
"description": "The object type",
"default": "list"
},
"data": {
"items": {
"$ref": "#/components/schemas/ModelObject"
},
"type": "array",
"title": "Data",
"description": "A list of model objects"
}
},
"type": "object",
"required": [
"data"
],
"title": "ModelListResponse"
},
"ModelObject": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The model identifier"
},
"object": {
"type": "string",
"const": "model",
"title": "Object",
"description": "The object type",
"default": "model"
},
"created": {
"type": "integer",
"title": "Created",
"description": "Unix timestamp of when the model was created",
"default": 0
},
"owned_by": {
"type": "string",
"title": "Owned By",
"description": "The organization that owns the model",
"default": "lightningrodlabs"
},
"name": {
"type": "string",
"title": "Name",
"description": "Display name of the model",
"default": ""
},
"description": {
"type": "string",
"title": "Description",
"description": "Description of the model",
"default": ""
},
"context_length": {
"type": "integer",
"title": "Context Length",
"description": "Maximum context length in tokens",
"default": 0
},
"max_completion_tokens": {
"type": "integer",
"title": "Max Completion Tokens",
"description": "Maximum number of tokens to generate",
"default": 0
},
"pricing": {
"additionalProperties": true,
"type": "object",
"title": "Pricing",
"description": "Per-token pricing"
}
},
"type": "object",
"required": [
"id"
],
"title": "ModelObject"
},
"ModelSourceType": {
"type": "string",
"enum": [
"OPENAI",
"VLLM",
"DIRECT_COMPLETIONS",
"OPEN_ROUTER",
"HUGGINGFACE_ENDPOINTS",
"DEEPSEEK",
"DEEPINFRA",
"RUNPOD",
"SGLANG",
"TINKER",
"MODAL_LORA_VLLM"
],
"title": "ModelSourceType"
},
"MultipleChoiceAnswerType": {
"properties": {
"answer_type": {
"type": "string",
"const": "MULTIPLE_CHOICE",
"title": "Answer Type",
"default": "MULTIPLE_CHOICE"
},
"answer_format_instruction": {
"type": "string",
"title": "Answer Format Instruction",
"description": "Instructions describing how the answer should be formatted and given.",
"default": "This is a multiple choice question with answer options. The list of options will be provided in the question. You are estimating the probability for each option being the correct answer. Provide your confidence for each option as a value between 0 and 1, where the probabilities must sum to 1. Provide your answer as a JSON dictionary between tags, with keys like option_0, option_1, etc. corresponding to each option in order. Example: {\"option_0\": 0.3, \"option_1\": 0.4, \"option_2\": 0.2, \"option_3\": 0.1}"
},
"labeler_instruction": {
"type": "string",
"title": "Labeler Instruction",
"description": "Instructions for the labeler.",
"default": "The answer should be ONLY one of the following options: 'A', 'B', 'C', or 'D', or 'Undetermined'. Do not include any other text or explanation."
},
"question_generation_instruction": {
"type": "string",
"title": "Question Generation Instruction",
"description": "Instructions for generating questions of this type.",
"default": "Generate questions with multiple choice options (up to 10). Format the options on separate lines after the question:\nA) First option\nB) Second option\nC) Third option\n... and so on\n\nEach option should be distinct and mutually exclusive. A clear and unambiguous multiple-choice question, based on the provided seed_text. Include the options in the question text."
},
"reward_function_type": {
"anyOf": [
{
"$ref": "#/components/schemas/RewardFunctionType"
},
{
"type": "null"
}
],
"default": "multi_choice_log_score"
}
},
"type": "object",
"title": "MultipleChoiceAnswerType"
},
"NewsContext": {
"properties": {
"context_type": {
"type": "string",
"const": "NEWS_CONTEXT",
"title": "Context Type",
"default": "NEWS_CONTEXT"
},
"rendered_context": {
"type": "string",
"title": "Rendered Context"
},
"search_query": {
"type": "string",
"title": "Search Query"
}
},
"type": "object",
"required": [
"rendered_context",
"search_query"
],
"title": "NewsContext"
},
"NewsContextGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "NEWS_CONTEXT_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "NEWS_CONTEXT_GENERATOR"
},
"num_search_queries": {
"type": "integer",
"title": "Num Search Queries",
"description": "Number of search queries to generate per question",
"default": 5
},
"articles_per_query": {
"type": "integer",
"title": "Articles Per Query",
"description": "Number of news articles to return per search query",
"default": 3
},
"num_articles": {
"type": "integer",
"title": "Num Articles",
"description": "Maximum number of news articles to include in final output",
"default": 10
},
"relevance_threshold": {
"type": "integer",
"title": "Relevance Threshold",
"description": "Minimum relevance rating (1-6 scale) to include article",
"default": 2
},
"min_articles": {
"type": "integer",
"title": "Min Articles",
"description": "Minimum number of articles to ensure",
"default": 6
},
"time_delta_days": {
"type": "integer",
"title": "Time Delta Days",
"description": "Number of days to look back for news articles",
"default": 30
},
"enable_relevance_ranking": {
"type": "boolean",
"title": "Enable Relevance Ranking",
"description": "Whether to perform LLM-based relevance ranking",
"default": true
}
},
"type": "object",
"title": "NewsContextGenerator"
},
"NewsSeedGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "NEWS_SEED_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "NEWS_SEED_GENERATOR"
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "Start date for seed search"
},
"end_date": {
"type": "string",
"format": "date-time",
"title": "End Date",
"description": "End date for seed search"
},
"interval_duration_days": {
"type": "integer",
"title": "Interval Duration Days",
"description": "Duration of each interval in days",
"default": 7
},
"search_query": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "Search Query",
"description": "Search query for news articles. If multiple queries are provided, a separate search will be done for each query."
},
"articles_per_search": {
"type": "integer",
"title": "Articles Per Search",
"description": "Number of articles to fetch per search (max 100). Each query/domain combination is a separate search.",
"default": 10
},
"filter_criteria": {
"anyOf": [
{
"$ref": "#/components/schemas/FilterCriteria"
},
{
"items": {
"$ref": "#/components/schemas/FilterCriteria"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filter Criteria",
"description": "Optional criteria for filtering news snippets before scraping"
},
"source_domain": {
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Source Domain",
"description": "Optional URL source of the news articles, e.g. 'https://reuters.com/business', if multiple sources are provided, multiple searchers will be done for each interval"
}
},
"type": "object",
"required": [
"start_date",
"end_date",
"search_query"
],
"title": "NewsSeedGenerator"
},
"PaginatedSamplesResponse": {
"properties": {
"samples": {
"items": {
"$ref": "#/components/schemas/Sample"
},
"type": "array",
"title": "Samples"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
},
"has_more": {
"type": "boolean",
"title": "Has More"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"samples",
"has_more",
"total"
],
"title": "PaginatedSamplesResponse"
},
"PipelineMetricsResponse": {
"properties": {
"total_input_rows": {
"type": "integer",
"title": "Total Input Rows"
},
"total_output_rows": {
"type": "integer",
"title": "Total Output Rows"
},
"total_duration_seconds": {
"type": "number",
"title": "Total Duration Seconds"
},
"steps": {
"items": {
"$ref": "#/components/schemas/TransformStepMetricsResponse"
},
"type": "array",
"title": "Steps"
}
},
"type": "object",
"required": [
"total_input_rows",
"total_output_rows",
"total_duration_seconds",
"steps"
],
"title": "PipelineMetricsResponse"
},
"PipelineStepSummary": {
"properties": {
"step_index": {
"type": "integer",
"title": "Step Index"
},
"transform_name": {
"type": "string",
"title": "Transform Name"
},
"input_count": {
"type": "integer",
"title": "Input Count",
"default": 0
},
"output_count": {
"type": "integer",
"title": "Output Count",
"default": 0
},
"rejected_count": {
"type": "integer",
"title": "Rejected Count",
"default": 0
},
"error_count": {
"type": "integer",
"title": "Error Count",
"default": 0
},
"rejection_reasons": {
"additionalProperties": {
"type": "integer"
},
"type": "object",
"title": "Rejection Reasons",
"default": {}
}
},
"type": "object",
"required": [
"step_index",
"transform_name"
],
"title": "PipelineStepSummary",
"description": "Summary of a single pipeline step including rejection reasons."
},
"Question": {
"properties": {
"question_type": {
"type": "string",
"const": "QUESTION",
"title": "Question Type",
"default": "QUESTION"
},
"question_text": {
"type": "string",
"title": "Question Text"
}
},
"type": "object",
"required": [
"question_text"
],
"title": "Question"
},
"QuestionAndLabelGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "QUESTION_AND_LABEL_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "QUESTION_AND_LABEL_GENERATOR"
},
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instructions",
"description": "Instructions for question generation. If not provided, uses sensible defaults."
},
"examples": {
"items": {
"type": "string"
},
"type": "array",
"title": "Examples",
"description": "Example questions to guide generation"
},
"bad_examples": {
"items": {
"type": "string"
},
"type": "array",
"title": "Bad Examples",
"description": "Examples of questions to avoid"
},
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/FilterCriteria"
},
{
"items": {
"$ref": "#/components/schemas/FilterCriteria"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "Optional filter criteria to apply after question generation"
},
"questions_per_seed": {
"type": "integer",
"title": "Questions Per Seed",
"description": "Number of questions to generate per seed",
"default": 1
},
"include_default_filter": {
"type": "boolean",
"title": "Include Default Filter",
"description": "Whether to include the default filter for generated questions",
"default": false
},
"answer_type": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/BinaryAnswerType"
},
{
"$ref": "#/components/schemas/MultipleChoiceAnswerType"
},
{
"$ref": "#/components/schemas/ContinuousAnswerType"
},
{
"$ref": "#/components/schemas/FreeResponseAnswerType"
}
],
"discriminator": {
"propertyName": "answer_type",
"mapping": {
"BINARY": "#/components/schemas/BinaryAnswerType",
"CONTINUOUS": "#/components/schemas/ContinuousAnswerType",
"FREE_RESPONSE": "#/components/schemas/FreeResponseAnswerType",
"MULTIPLE_CHOICE": "#/components/schemas/MultipleChoiceAnswerType"
}
}
},
{
"type": "null"
}
],
"title": "Answer Type",
"description": "The type of answer expected for generated questions"
}
},
"type": "object",
"title": "QuestionAndLabelGenerator"
},
"QuestionGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "QUESTION_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "QUESTION_GENERATOR"
},
"instructions": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Instructions",
"description": "Instructions for question generation. If not provided, uses sensible defaults."
},
"examples": {
"items": {
"type": "string"
},
"type": "array",
"title": "Examples",
"description": "Example questions to guide generation"
},
"bad_examples": {
"items": {
"type": "string"
},
"type": "array",
"title": "Bad Examples",
"description": "Examples of questions to avoid"
},
"filter": {
"anyOf": [
{
"$ref": "#/components/schemas/FilterCriteria"
},
{
"items": {
"$ref": "#/components/schemas/FilterCriteria"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "Optional filter criteria to apply after question generation"
},
"questions_per_seed": {
"type": "integer",
"title": "Questions Per Seed",
"description": "Number of questions to generate per seed",
"default": 1
},
"include_default_filter": {
"type": "boolean",
"title": "Include Default Filter",
"description": "Whether to include the default filter for generated questions",
"default": false
},
"answer_type": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/BinaryAnswerType"
},
{
"$ref": "#/components/schemas/MultipleChoiceAnswerType"
},
{
"$ref": "#/components/schemas/ContinuousAnswerType"
},
{
"$ref": "#/components/schemas/FreeResponseAnswerType"
}
],
"discriminator": {
"propertyName": "answer_type",
"mapping": {
"BINARY": "#/components/schemas/BinaryAnswerType",
"CONTINUOUS": "#/components/schemas/ContinuousAnswerType",
"FREE_RESPONSE": "#/components/schemas/FreeResponseAnswerType",
"MULTIPLE_CHOICE": "#/components/schemas/MultipleChoiceAnswerType"
}
}
},
{
"type": "null"
}
],
"title": "Answer Type",
"description": "The type of answer expected for generated questions"
}
},
"type": "object",
"title": "QuestionGenerator"
},
"QuestionPipeline": {
"properties": {
"config_type": {
"type": "string",
"const": "QUESTION_PIPELINE",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "QUESTION_PIPELINE"
},
"seed_generator": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/BigQuerySeedGenerator"
},
{
"$ref": "#/components/schemas/NewsSeedGenerator"
},
{
"$ref": "#/components/schemas/GdeltSeedGenerator"
},
{
"$ref": "#/components/schemas/FileSetSeedGenerator"
},
{
"$ref": "#/components/schemas/FileSetQuerySeedGenerator"
},
{
"$ref": "#/components/schemas/MockTransformConfig"
}
],
"discriminator": {
"propertyName": "config_type",
"mapping": {
"BIGQUERY_SEED_GENERATOR": "#/components/schemas/BigQuerySeedGenerator",
"FILESET_QUERY_SEED_GENERATOR": "#/components/schemas/FileSetQuerySeedGenerator",
"FILESET_SEED_GENERATOR": "#/components/schemas/FileSetSeedGenerator",
"GDELT_SEED_GENERATOR": "#/components/schemas/GdeltSeedGenerator",
"MOCK": "#/components/schemas/MockTransformConfig",
"NEWS_SEED_GENERATOR": "#/components/schemas/NewsSeedGenerator"
}
}
},
{
"type": "null"
}
],
"title": "Seed Generator",
"description": "Configuration for seed generation"
},
"question_generator": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/QuestionGenerator"
},
{
"$ref": "#/components/schemas/ForwardLookingQuestionGenerator"
},
{
"$ref": "#/components/schemas/QuestionAndLabelGenerator"
},
{
"$ref": "#/components/schemas/TemplateQuestionGenerator"
},
{
"$ref": "#/components/schemas/MockTransformConfig"
}
],
"discriminator": {
"propertyName": "config_type",
"mapping": {
"FORWARD_LOOKING_QUESTION_GENERATOR": "#/components/schemas/ForwardLookingQuestionGenerator",
"MOCK": "#/components/schemas/MockTransformConfig",
"QUESTION_AND_LABEL_GENERATOR": "#/components/schemas/QuestionAndLabelGenerator",
"QUESTION_GENERATOR": "#/components/schemas/QuestionGenerator",
"TEMPLATE_QUESTION_GENERATOR": "#/components/schemas/TemplateQuestionGenerator"
}
}
},
{
"type": "null"
}
],
"title": "Question Generator",
"description": "Configuration for question generation"
},
"labeler": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/WebSearchLabeler"
},
{
"$ref": "#/components/schemas/FileSetRAGLabeler"
},
{
"$ref": "#/components/schemas/MockTransformConfig"
}
],
"discriminator": {
"propertyName": "config_type",
"mapping": {
"FILESET_RAG_LABELER": "#/components/schemas/FileSetRAGLabeler",
"MOCK": "#/components/schemas/MockTransformConfig",
"WEB_SEARCH_LABELER": "#/components/schemas/WebSearchLabeler"
}
}
},
{
"type": "null"
}
],
"title": "Labeler",
"description": "Configuration for labeling. Not needed when using QuestionAndLabelGenerator."
},
"context_generators": {
"anyOf": [
{
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/NewsContextGenerator"
},
{
"$ref": "#/components/schemas/FileSetContextGenerator"
},
{
"$ref": "#/components/schemas/MockTransformConfig"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Context Generators",
"description": "Optional list of context generators to run before rendering"
},
"renderer": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/QuestionRenderer"
},
{
"$ref": "#/components/schemas/MockTransformConfig"
}
],
"discriminator": {
"propertyName": "config_type",
"mapping": {
"MOCK": "#/components/schemas/MockTransformConfig",
"QUESTION_RENDERER": "#/components/schemas/QuestionRenderer"
}
}
},
{
"type": "null"
}
],
"title": "Renderer",
"description": "Optional configuration for rendering the final prompt"
},
"rollout_generator": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/RolloutGenerator"
},
{
"$ref": "#/components/schemas/MockTransformConfig"
}
],
"discriminator": {
"propertyName": "config_type",
"mapping": {
"MOCK": "#/components/schemas/MockTransformConfig",
"ROLLOUT_GENERATOR": "#/components/schemas/RolloutGenerator"
}
}
},
{
"type": "null"
}
],
"title": "Rollout Generator",
"description": "Optional configuration for generating rollouts from multiple models"
},
"scorer": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/RolloutScorer"
},
{
"$ref": "#/components/schemas/MockTransformConfig"
}
],
"discriminator": {
"propertyName": "config_type",
"mapping": {
"MOCK": "#/components/schemas/MockTransformConfig",
"ROLLOUT_SCORER": "#/components/schemas/RolloutScorer"
}
}
},
{
"type": "null"
}
],
"title": "Scorer",
"description": "Optional configuration for scoring rollouts against ground truth"
}
},
"type": "object",
"title": "QuestionPipeline"
},
"QuestionRenderer": {
"properties": {
"config_type": {
"type": "string",
"const": "QUESTION_RENDERER",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "QUESTION_RENDERER"
},
"template": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Template",
"description": "Custom template for rendering the prompt. If not provided, dynamically builds based on available content. Supports placeholders like {question_text}, {context}, {answer_instructions}."
},
"answer_type": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/BinaryAnswerType"
},
{
"$ref": "#/components/schemas/MultipleChoiceAnswerType"
},
{
"$ref": "#/components/schemas/ContinuousAnswerType"
},
{
"$ref": "#/components/schemas/FreeResponseAnswerType"
}
],
"discriminator": {
"propertyName": "answer_type",
"mapping": {
"BINARY": "#/components/schemas/BinaryAnswerType",
"CONTINUOUS": "#/components/schemas/ContinuousAnswerType",
"FREE_RESPONSE": "#/components/schemas/FreeResponseAnswerType",
"MULTIPLE_CHOICE": "#/components/schemas/MultipleChoiceAnswerType"
}
}
},
{
"type": "null"
}
],
"title": "Answer Type",
"description": "The type of answer expected, used to render answer instructions"
}
},
"type": "object",
"title": "QuestionRenderer"
},
"RAGContext": {
"properties": {
"context_type": {
"type": "string",
"const": "RAG_CONTEXT",
"title": "Context Type",
"default": "RAG_CONTEXT"
},
"rendered_context": {
"type": "string",
"title": "Rendered Context"
},
"document_id": {
"type": "string",
"title": "Document Id"
}
},
"type": "object",
"required": [
"rendered_context",
"document_id"
],
"title": "RAGContext"
},
"ResponseMessage": {
"properties": {
"role": {
"type": "string",
"title": "Role",
"description": "The role of the message author"
},
"content": {
"type": "string",
"title": "Content",
"description": "The content of the message"
}
},
"type": "object",
"required": [
"role",
"content"
],
"title": "ResponseMessage"
},
"RetryFailedFilesRequest": {
"properties": {
"max_retries": {
"type": "integer",
"maximum": 10.0,
"minimum": 1.0,
"title": "Max Retries",
"description": "Maximum retry attempts per file",
"default": 3
}
},
"type": "object",
"title": "RetryFailedFilesRequest"
},
"RetryFailedFilesResponse": {
"properties": {
"files_reset": {
"type": "integer",
"title": "Files Reset",
"description": "Number of files reset to PENDING status"
}
},
"type": "object",
"required": [
"files_reset"
],
"title": "RetryFailedFilesResponse"
},
"RewardFunctionType": {
"type": "string",
"enum": [
"binary_brier",
"binary_weighted_brier",
"binary_log_score",
"multi_choice_log_score",
"continuous_log_score",
"continuous_value_only_log_score",
"continuous_value_only_linear_score"
],
"title": "RewardFunctionType"
},
"Rollout": {
"properties": {
"model_name": {
"type": "string",
"title": "Model Name"
},
"content": {
"type": "string",
"title": "Content"
},
"parsed_output": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Parsed Output"
},
"reasoning": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reasoning"
},
"reward": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Reward"
}
},
"type": "object",
"required": [
"model_name",
"content"
],
"title": "Rollout",
"description": "A single model rollout/response."
},
"RolloutGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "ROLLOUT_GENERATOR",
"title": "Config Type",
"default": "ROLLOUT_GENERATOR"
},
"models": {
"items": {
"$ref": "#/components/schemas/ModelConfig"
},
"type": "array",
"title": "Models",
"description": "Model names or ModelConfig objects"
},
"prompt_template": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt Template",
"description": "Prompt template with {column} placeholders. If None, uses sample.prompt"
},
"input_columns": {
"items": {
"type": "string"
},
"type": "array",
"title": "Input Columns",
"description": "Columns to substitute into template (from meta)"
},
"output_schema": {
"anyOf": [
{},
{
"type": "null"
}
],
"title": "Output Schema",
"description": "Pydantic model for structured output"
}
},
"type": "object",
"required": [
"models"
],
"title": "RolloutGenerator"
},
"RolloutScorer": {
"properties": {
"config_type": {
"type": "string",
"const": "ROLLOUT_SCORER",
"title": "Config Type",
"default": "ROLLOUT_SCORER"
},
"answer_type": {
"oneOf": [
{
"$ref": "#/components/schemas/BinaryAnswerType"
},
{
"$ref": "#/components/schemas/MultipleChoiceAnswerType"
},
{
"$ref": "#/components/schemas/ContinuousAnswerType"
},
{
"$ref": "#/components/schemas/FreeResponseAnswerType"
}
],
"title": "Answer Type",
"description": "the answer type of the question",
"discriminator": {
"propertyName": "answer_type",
"mapping": {
"BINARY": "#/components/schemas/BinaryAnswerType",
"CONTINUOUS": "#/components/schemas/ContinuousAnswerType",
"FREE_RESPONSE": "#/components/schemas/FreeResponseAnswerType",
"MULTIPLE_CHOICE": "#/components/schemas/MultipleChoiceAnswerType"
}
}
},
"multiple_choice_options": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Multiple Choice Options"
},
"is_mutually_exclusive": {
"type": "boolean",
"title": "Is Mutually Exclusive",
"default": true
}
},
"type": "object",
"required": [
"answer_type"
],
"title": "RolloutScorer"
},
"Sample": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"seed": {
"anyOf": [
{
"$ref": "#/components/schemas/Seed"
},
{
"type": "null"
}
]
},
"question": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/ForwardLookingQuestion"
},
{
"$ref": "#/components/schemas/Question"
}
],
"discriminator": {
"propertyName": "question_type",
"mapping": {
"FORWARD_LOOKING_QUESTION": "#/components/schemas/ForwardLookingQuestion",
"QUESTION": "#/components/schemas/Question"
}
}
},
{
"type": "null"
}
],
"title": "Question"
},
"label": {
"anyOf": [
{
"$ref": "#/components/schemas/Label"
},
{
"type": "null"
}
]
},
"prompt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt"
},
"context": {
"anyOf": [
{
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/NewsContext"
},
{
"$ref": "#/components/schemas/RAGContext"
}
],
"discriminator": {
"propertyName": "context_type",
"mapping": {
"NEWS_CONTEXT": "#/components/schemas/NewsContext",
"RAG_CONTEXT": "#/components/schemas/RAGContext"
}
}
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Context"
},
"rollouts": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Rollout"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Rollouts"
},
"meta": {
"additionalProperties": true,
"type": "object",
"title": "Meta",
"default": {}
},
"is_valid": {
"type": "boolean",
"title": "Is Valid",
"default": true
}
},
"type": "object",
"title": "Sample"
},
"SampleDatasetConfig": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"sample_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Sample Ids"
},
"prompt_template": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Prompt Template"
}
},
"type": "object",
"required": [
"id",
"sample_ids"
],
"title": "SampleDatasetConfig"
},
"Seed": {
"properties": {
"seed_text": {
"type": "string",
"title": "Seed Text"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url"
},
"seed_creation_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Seed Creation Date"
},
"search_query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Search Query"
}
},
"type": "object",
"required": [
"seed_text"
],
"title": "Seed"
},
"StepCostBreakdown": {
"properties": {
"step_name": {
"type": "string",
"title": "Step Name"
},
"step_type": {
"$ref": "#/components/schemas/TransformType"
},
"total_cost_dollars": {
"type": "number",
"title": "Total Cost Dollars"
},
"usage": {
"$ref": "#/components/schemas/UsageSummary"
},
"output_count": {
"type": "integer",
"title": "Output Count"
},
"cost_per_output": {
"type": "number",
"title": "Cost Per Output"
}
},
"type": "object",
"required": [
"step_name",
"step_type",
"total_cost_dollars",
"usage",
"output_count",
"cost_per_output"
],
"title": "StepCostBreakdown"
},
"TemplateQuestionGenerator": {
"properties": {
"config_type": {
"type": "string",
"const": "TEMPLATE_QUESTION_GENERATOR",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "TEMPLATE_QUESTION_GENERATOR"
},
"question_template": {
"type": "string",
"title": "Question Template",
"description": "Template string with {field} placeholders. Supports {seed_text}, {seed}, and any key in {meta} (e.g. {meta.label})."
}
},
"type": "object",
"required": [
"question_template"
],
"title": "TemplateQuestionGenerator"
},
"TemporalConstraint": {
"type": "string",
"enum": [
"BEFORE",
"AFTER"
],
"title": "TemporalConstraint",
"description": "Temporal filtering direction relative to the seed document's date.\n\nUses the `file_date` metadata key (unix timestamp int) stored on each\nGemini document by fileset_file_processor.\n\nBEFORE: file_date <= seed_timestamp (context: no lookahead bias)\nAFTER: file_date > seed_timestamp (labels: find resolutions)"
},
"TrainingConfig": {
"properties": {
"dataset": {
"$ref": "#/components/schemas/SampleDatasetConfig",
"description": "Dataset config for loading training samples"
},
"base_model": {
"type": "string",
"title": "Base Model",
"description": "HuggingFace model ID for LoRA base (e.g. Qwen/Qwen3-8B)"
},
"training_steps": {
"type": "integer",
"title": "Training Steps",
"description": "Number of training loop iterations"
},
"batch_size": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Batch Size",
"description": "Rows per batch; used to slice train_rows each step"
},
"lora_rank": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Lora Rank",
"description": "LoRA adapter rank passed to create_lora_training_client_async"
},
"learning_rate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Learning Rate",
"description": "Step size for weight updates; higher values learn faster but may overshoot"
},
"adam_beta1": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Adam Beta1",
"description": "Exponential decay rate for first-moment estimates (moving average of gradients)"
},
"adam_beta2": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Adam Beta2",
"description": "Exponential decay rate for second-moment estimates (moving average of squared gradients)"
},
"num_rollouts": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Rollouts",
"description": "Samples per prompt for GRPO"
},
"max_response_length": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Response Length",
"description": "Max tokens for sampling"
},
"start_idx": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Start Idx",
"description": "Row index to skip at start; train_rows = train_rows[start_idx:]"
}
},
"type": "object",
"required": [
"dataset",
"base_model",
"training_steps"
],
"title": "TrainingConfig"
},
"TrainingJob": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"status": {
"$ref": "#/components/schemas/TrainingJobStatus"
},
"config": {
"$ref": "#/components/schemas/TrainingConfig"
},
"model_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Model Id"
},
"reward_history": {
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Reward History"
},
"current_step": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Current Step"
},
"total_steps": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Total Steps"
},
"cost_dollars": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Cost Dollars"
},
"dataset_hf_repo": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dataset Hf Repo"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error Message"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"organization_id",
"status",
"config",
"created_at",
"updated_at"
],
"title": "TrainingJob"
},
"TrainingJobListResponse": {
"properties": {
"jobs": {
"items": {
"$ref": "#/components/schemas/TrainingJob"
},
"type": "array",
"title": "Jobs"
},
"total_count": {
"type": "integer",
"title": "Total Count"
}
},
"type": "object",
"required": [
"jobs",
"total_count"
],
"title": "TrainingJobListResponse"
},
"TrainingJobStatus": {
"type": "string",
"enum": [
"STARTING",
"RUNNING",
"COMPLETED",
"FAILED"
],
"title": "TrainingJobStatus"
},
"TransformJob": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"organization_id": {
"type": "string",
"title": "Organization Id"
},
"configuration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Configuration Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"status": {
"$ref": "#/components/schemas/TransformJobStatus"
},
"error_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Error Message"
},
"warning_message": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Warning Message"
},
"modal_function_call_id": {
"type": "string",
"title": "Modal Function Call Id"
},
"modal_app_id": {
"type": "string",
"title": "Modal App Id"
},
"transform_config": {
"type": "string",
"title": "Transform Config"
},
"input_dataset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Input Dataset Id"
},
"output_dataset_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Output Dataset Id"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/JobUsage"
},
{
"type": "null"
}
]
},
"estimated_cost_dollars": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Estimated Cost Dollars"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"organization_id",
"status",
"modal_function_call_id",
"modal_app_id",
"transform_config",
"input_dataset_id",
"output_dataset_id",
"created_at",
"updated_at"
],
"title": "TransformJob"
},
"TransformJobStatus": {
"type": "string",
"enum": [
"RUNNING",
"COMPLETED",
"FAILED",
"CANCELLED"
],
"title": "TransformJobStatus"
},
"TransformStepMetricsResponse": {
"properties": {
"step_index": {
"type": "integer",
"title": "Step Index"
},
"transform_name": {
"type": "string",
"title": "Transform Name"
},
"input_rows": {
"type": "integer",
"title": "Input Rows"
},
"output_rows": {
"type": "integer",
"title": "Output Rows"
},
"rejected_count": {
"type": "integer",
"title": "Rejected Count"
},
"error_count": {
"type": "integer",
"title": "Error Count"
},
"duration_seconds": {
"type": "number",
"title": "Duration Seconds"
},
"progress": {
"type": "number",
"title": "Progress"
},
"summary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Summary"
}
},
"type": "object",
"required": [
"step_index",
"transform_name",
"input_rows",
"output_rows",
"rejected_count",
"error_count",
"duration_seconds",
"progress",
"summary"
],
"title": "TransformStepMetricsResponse"
},
"TransformType": {
"type": "string",
"enum": [
"NEWS_SEED_GENERATOR",
"GDELT_SEED_GENERATOR",
"QUESTION_GENERATOR",
"QUESTION_AND_LABEL_GENERATOR",
"QUESTION_FILTER",
"FORWARD_LOOKING_QUESTION_GENERATOR",
"QUESTION_QUALITY_SCORER",
"SCORE_FILTER",
"FILTER_CRITERIA",
"WEB_SEARCH_LABELER",
"NEWS_CONTEXT_GENERATOR",
"PIPELINE",
"QUESTION_PIPELINE",
"QUESTION_RENDERER",
"ROLLOUT_GENERATOR",
"BIGQUERY_SEED_GENERATOR",
"FILESET_SEED_GENERATOR",
"FILESET_QUERY_SEED_GENERATOR",
"TEMPLATE_QUESTION_GENERATOR",
"ROLLOUT_SCORER",
"FILESET_CONTEXT_GENERATOR",
"FILESET_RAG_LABELER",
"MOCK"
],
"title": "TransformType"
},
"UploadSamplesRequest": {
"properties": {
"samples": {
"items": {
"$ref": "#/components/schemas/Sample"
},
"type": "array",
"title": "Samples"
}
},
"type": "object",
"required": [
"samples"
],
"title": "UploadSamplesRequest"
},
"UploadSamplesResponse": {
"properties": {
"count": {
"type": "integer",
"title": "Count"
},
"total": {
"type": "integer",
"title": "Total"
}
},
"type": "object",
"required": [
"count",
"total"
],
"title": "UploadSamplesResponse"
},
"Usage": {
"properties": {
"prompt_tokens": {
"type": "integer",
"title": "Prompt Tokens",
"description": "Number of tokens in the prompt"
},
"completion_tokens": {
"type": "integer",
"title": "Completion Tokens",
"description": "Number of tokens in the completion"
},
"total_tokens": {
"type": "integer",
"title": "Total Tokens",
"description": "Total number of tokens used"
}
},
"type": "object",
"required": [
"prompt_tokens",
"completion_tokens",
"total_tokens"
],
"title": "Usage"
},
"UsageSummary": {
"properties": {
"events": {
"additionalProperties": {
"$ref": "#/components/schemas/EventUsageSummary"
},
"type": "object",
"title": "Events",
"default": {}
},
"llm_by_model": {
"additionalProperties": {
"$ref": "#/components/schemas/LLMModelUsageSummary"
},
"type": "object",
"title": "Llm By Model",
"default": {}
},
"total_cost": {
"type": "number",
"title": "Total Cost",
"default": 0.0
}
},
"type": "object",
"title": "UsageSummary",
"description": "Flexible usage statistics by event type and LLM model."
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"WebSearchLabeler": {
"properties": {
"config_type": {
"type": "string",
"const": "WEB_SEARCH_LABELER",
"title": "Config Type",
"description": "Type of transform configuration",
"default": "WEB_SEARCH_LABELER"
},
"confidence_threshold": {
"type": "number",
"title": "Confidence Threshold",
"description": "Minimum confidence threshold for including questions",
"default": 0.9
},
"answer_type": {
"anyOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/BinaryAnswerType"
},
{
"$ref": "#/components/schemas/MultipleChoiceAnswerType"
},
{
"$ref": "#/components/schemas/ContinuousAnswerType"
},
{
"$ref": "#/components/schemas/FreeResponseAnswerType"
}
],
"discriminator": {
"propertyName": "answer_type",
"mapping": {
"BINARY": "#/components/schemas/BinaryAnswerType",
"CONTINUOUS": "#/components/schemas/ContinuousAnswerType",
"FREE_RESPONSE": "#/components/schemas/FreeResponseAnswerType",
"MULTIPLE_CHOICE": "#/components/schemas/MultipleChoiceAnswerType"
}
}
},
{
"type": "null"
}
],
"title": "Answer Type",
"description": "The type of answer expected, used to guide the labeler"
},
"resolve_redirects": {
"type": "boolean",
"title": "Resolve Redirects",
"description": "Resolve redirect URLs to actual destinations",
"default": false
}
},
"type": "object",
"title": "WebSearchLabeler"
}
},
"securitySchemes": {
"HTTPBearer": {
"type": "http",
"scheme": "bearer"
}
}
},
"servers": [
{
"url": "/api/public/v1"
}
]
}