import {z} from 'zod' export type CreateApiWorkspacesWorkspaceIdStudiesStudyIdRunArgs = {study_id: string, workspace_id: string}; export type CreateApiWorkspacesWorkspaceIdStudiesStudyIdRunOptions = {baseUrl: string, HTTPBearer?: string | undefined, fetch?: typeof fetch | undefined}; export const provenanceEntry = z.object({field: z.string().max(500), source: z.enum(["assumed", "user_provided", "probed_confirmed"])}); export const researchObjective = z.object({id: z.string().max(500), objective: z.string().max(2000), why_it_matters: z.string().max(2000)}); export const textStimulus = z.object({kind: z.literal("text"), id: z.string().max(500).nullable().optional(), label: z.string().max(500), value: z.string().max(2000)}); export const imageStimulus = z.object({kind: z.literal("image"), id: z.string().max(500).nullable().optional(), label: z.string().max(500), asset_id: z.string()}); export const scaleSpec = z.object({min: z.number().int(), max: z.number().int(), min_label: z.string().max(500), max_label: z.string().max(500)}); export const surveyQuestion = z.object({id: z.string().max(500), text: z.string().max(500), type: z.enum(["multiple_choice", "scale", "open_ended"]), options: z.array(z.string().max(500)).nullable().optional(), allow_multiple: z.boolean().optional(), scale: scaleSpec.nullable().optional(), feeds: z.array(z.string().max(500)), stimulus: z.string().max(500).nullable().optional(), rationale: z.string().max(2000)}); export const qualitativeQuestion = z.object({id: z.string().max(500), text: z.string().max(500), feeds: z.array(z.string().max(500)), stimulus: z.string().max(500).nullable().optional()}); export const openItem = z.object({section: z.enum(["frame", "survey_questions", "qualitative_questions"]), question: z.string().max(500)}); export const brief = z.object({title: z.string().max(500).nullable().optional(), business_problem: z.string().max(2000), action_standard: z.string().max(2000).nullable().optional(), context: z.string().max(2000), assumptions: z.array(z.string().max(2000)), provenance: z.array(provenanceEntry), research_objectives: z.array(researchObjective), stimuli: z.array(z.discriminatedUnion("kind", [textStimulus, imageStimulus])), stimulus_gap: z.string().max(2000).nullable().optional(), survey_questions: z.array(surveyQuestion), qualitative_questions: z.array(qualitativeQuestion), open_items: z.array(openItem)}); export const auditIssue = z.object({code: z.enum(["problem_missing", "problem_assumed", "coverage_gap", "unknown_feed", "unknown_stimulus", "unused_stimulus", "duplicate_stimulus_asset", "unfed_instrument", "mc_options", "mc_other", "scale_anchors", "status_premature", "population_missing", "objective_soft_cap", "survey_length", "qual_length", "duplicate_id", "open_items_out_of_order"]), severity: z.enum(["error", "warning"]), message: z.string(), path: z.string().nullable().optional()}); export const studySamplePlan = z.object({planned_personas: z.number().int(), population_size: z.number().int(), question_count: z.number().int()}); export const studyQuestionProgress = z.object({question_id: z.string(), response_count: z.number().int(), failure_count: z.number().int()}); export const studyResultAggregate = z.object({response_count: z.number().int(), average_number: z.number().nullable().optional(), numeric_percentiles: z.array(z.record(z.string(), z.unknown())).optional(), number_distribution: z.array(z.record(z.string(), z.unknown())).optional(), choice_counts: z.array(z.record(z.string(), z.unknown())).optional()}); export const studyResultExample = z.object({persona: z.string(), text: z.string()}); export const studyResultTheme = z.object({title: z.string(), summary: z.string(), count: z.number().int(), share: z.number(), example_answers: z.array(studyResultExample).optional()}); export const studyResultVerbatim = z.object({persona: z.string(), answer: z.string(), theme: z.number().int().nullable().optional()}); export const studyQuestionResult = z.object({id: z.string(), text: z.string(), type: z.enum(["multiple_choice", "scale", "open_ended", "qualitative"]), response_count: z.number().int(), failure_count: z.number().int(), aggregate: studyResultAggregate.nullable().optional(), rationales: z.array(z.string()).optional(), themes: z.array(studyResultTheme).optional(), verbatims: z.array(studyResultVerbatim).optional(), verbatims_omitted: z.string().nullable().optional()}); export const stimulusAssetInfo = z.object({url: z.string(), width: z.number().int(), height: z.number().int()}); export const studyDetail = z.object({id: z.string(), status: z.enum(["approved", "running", "reporting", "completed", "failed", "canceled"]), title: z.string().nullable(), brief: brief, issues: z.array(auditIssue), next_step: z.string(), approved_at: z.string().nullable(), created_at: z.string(), updated_at: z.string(), sample_plan: studySamplePlan.nullable().optional(), started_at: z.string().nullable().optional(), completed_at: z.string().nullable().optional(), expected_response_count: z.number().int().nullable().optional(), response_count: z.number().int().nullable().optional(), failure_count: z.number().int().nullable().optional(), question_progress: z.array(studyQuestionProgress).nullable().optional(), results: z.array(studyQuestionResult).nullable().optional(), report_markdown: z.string().nullable().optional(), failure_reason: z.enum(["below_success_gate", "canceled", "stranded", "internal_error"]).nullable().optional(), population_id: z.string().nullable().optional(), population_name: z.string().nullable().optional(), cohort_filter: z.record(z.string(), z.array(z.string())).nullable().optional(), can_run: z.boolean(), can_cancel: z.boolean(), can_delete: z.boolean(), stimulus_assets: z.record(z.string(), stimulusAssetInfo).nullable().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Run Study * * POST /workspaces/{workspace_id}/studies/{study_id}/run */ export const createApiWorkspacesWorkspaceIdStudiesStudyIdRun = async (args: CreateApiWorkspacesWorkspaceIdStudiesStudyIdRunArgs, options: CreateApiWorkspacesWorkspaceIdStudiesStudyIdRunOptions) => { const {baseUrl, fetch: fetchFn = fetch, HTTPBearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (HTTPBearer !== undefined) headers.set('authorization', `Bearer ${HTTPBearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/workspaces/${encodeURIComponent(String(args.workspace_id))}/studies/${encodeURIComponent(String(args.study_id))}/run${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(studyDetail, await res.json()) };