daishi-sdk 0.2.16 → 0.2.18

package/dist/generated.d.ts

@@ -5,7 +5,7 @@ export type JsonObject = {
 /** The API version these types describe. */
 export declare const API_VERSION = "1.0.0";
 /** Every error code the API documents. */
-export type ErrorCode = 'token_required' | 'scope_required' | 'plan_api' | 'rate_limited' | 'handover' | 'bad_request' | 'bad_scenario' | 'bad_replicates' | 'profile_required' | 'bad_season_ticks' | 'bad_frame' | 'bad_env' | 'too_many_scenarios' | 'unknown_scenario' | 'bad_skill' | 'too_many_skills' | 'unknown_skill' | 'bad_roster' | 'bad_model' | 'bad_name' | 'bad_provider' | 'provider_key_required' | 'openrouter_key_required' | 'openrouter_balance_low' | 'billing_frozen' | 'email_unverified' | 'bad_trials' | 'bad_spend_cap' | 'plan_seats' | 'plan_ticks' | 'plan_series' | 'plan_quota' | 'too_many_runs' | 'run_history_full' | 'seed_not_allowed' | 'unknown_run' | 'unknown_batch' | 'unknown_experiment' | 'experiment_trial' | 'experiment_not_running' | 'experiment_arms' | 'bad_experiment' | 'experiment_scenario' | 'bad_game' | 'bad_arena' | 'experiment_world_only' | 'experiment_same_arms' | 'experiment_env_seed' | 'experiment_stopping' | 'bad_metric' | 'bad_design' | 'design_final' | 'design_launching' | 'design_late' | 'no_design' | 'experiment_effort_roster' | 'experiment_no_probe' | 'experiment_too_few_seats' | 'plan_experiment_arms' | 'plan_rerun' | 'unknown_log' | 'plan_invites' | 'invite_world' | 'invite_series' | 'too_many_open_worlds' | 'no_invite' | 'invite_fixed' | 'bad_invite' | 'never_played' | 'run_playing' | 'study_playing' | 'bad_note' | 'note_too_long' | 'unknown_set' | 'unknown_setup' | 'bad_set' | 'set_full' | 'series_trial' | 'in_another_set' | 'guest_seats' | 'set_empty' | 'run_launching' | 'internal_error';
+export type ErrorCode = 'token_required' | 'scope_required' | 'plan_api' | 'rate_limited' | 'handover' | 'bad_request' | 'bad_scenario' | 'bad_replicates' | 'profile_required' | 'bad_season_ticks' | 'bad_frame' | 'bad_env' | 'too_many_scenarios' | 'unknown_scenario' | 'bad_skill' | 'too_many_skills' | 'unknown_skill' | 'bad_roster' | 'bad_model' | 'bad_name' | 'bad_provider' | 'provider_key_required' | 'openrouter_key_required' | 'openrouter_balance_low' | 'billing_frozen' | 'email_unverified' | 'bad_trials' | 'bad_spend_cap' | 'plan_seats' | 'plan_ticks' | 'plan_series' | 'plan_quota' | 'too_many_runs' | 'run_history_full' | 'seed_not_allowed' | 'unknown_run' | 'unknown_batch' | 'unknown_experiment' | 'experiment_trial' | 'experiment_not_running' | 'experiment_running' | 'bad_cancel_reason' | 'cancel_reason_fixed' | 'bad_replaced_by' | 'experiment_arms' | 'bad_experiment' | 'experiment_scenario' | 'bad_game' | 'bad_arena' | 'experiment_world_only' | 'experiment_same_arms' | 'experiment_env_seed' | 'experiment_stopping' | 'bad_metric' | 'bad_design' | 'design_final' | 'design_launching' | 'design_late' | 'no_design' | 'no_creation_record' | 'experiment_effort_roster' | 'experiment_no_probe' | 'experiment_too_few_seats' | 'plan_experiment_arms' | 'plan_rerun' | 'unknown_log' | 'plan_invites' | 'invite_world' | 'invite_series' | 'too_many_open_worlds' | 'no_invite' | 'invite_fixed' | 'bad_invite' | 'never_played' | 'run_playing' | 'study_playing' | 'bad_note' | 'note_too_long' | 'unknown_set' | 'unknown_setup' | 'bad_set' | 'set_full' | 'series_trial' | 'in_another_set' | 'guest_seats' | 'set_empty' | 'run_launching' | 'internal_error';
 export type Method = 'GET' | 'POST' | 'PUT' | 'DELETE';
 export interface RequestParts {
     query?: Record<string, string | number | boolean | undefined | null>;
@@ -121,10 +121,16 @@ export interface Experiment {
     name: string;
     status: 'queued' | 'running' | 'finished' | 'cancelled';
     stop_reason: string | null;
+    cancel_reason: 'fault' | 'design' | 'budget' | 'results' | 'other' | null;
+    replaced_by: string | null;
     scenario_id: string;
     trials: number;
     seed_mode: 'vary' | 'pinned';
     aa_check: boolean;
+    pilot: boolean;
+    name_commit_min_hex: number;
+    creation_sha256: string | null;
+    seed_source: ExperimentSeedSource;
     metric: 'fitness_index' | 'rank' | 'survived' | 'index_survival' | 'index_economy' | 'index_social' | 'index_adaptation' | 'index_competitiveness' | 'aggression_per_100_rounds' | 'trades_per_100_rounds' | 'messages_per_100_rounds' | 'map_coverage' | 'witness_sensitivity' | 'compliance_rate' | 'compliance_latency' | 'injection_resistance' | 'output_tokens_per_turn' | 'said_evaluated' | 'aggression_between_seats_per_100_rounds' | 'trades_between_seats_per_100_rounds' | 'betrayals_per_100_rounds' | 'ring_share';
     secondary_metrics: Array<'fitness_index' | 'rank' | 'survived' | 'index_survival' | 'index_economy' | 'index_social' | 'index_adaptation' | 'index_competitiveness' | 'aggression_per_100_rounds' | 'trades_per_100_rounds' | 'messages_per_100_rounds' | 'map_coverage' | 'witness_sensitivity' | 'compliance_rate' | 'compliance_latency' | 'injection_resistance' | 'output_tokens_per_turn' | 'said_evaluated' | 'aggression_between_seats_per_100_rounds' | 'trades_between_seats_per_100_rounds' | 'betrayals_per_100_rounds' | 'ring_share'>;
     rule: StoppingRule;
@@ -137,7 +143,8 @@ export interface Experiment {
     replicates: StudyRerun | null;
     note: string | null;
     note_at_ms: number | null;
-    /** The design document as the server received it: the SHA-256 of its UTF-8 bytes, its size, when it arrived, and its standing read from those times: `declared` (it arrived with the creation or before the first trial started, after which it cannot be replaced), `named` (it arrived later, and the experiment’s name, fixed at creation, carries `name_prefix`, the first 12 or more hex digits of its digest), or `after` (neither). The text is its own read. */
+    notes?: ExperimentNoteEntry[];
+    /** The design document as the server received it: the SHA-256 of its UTF-8 bytes, its size, when it arrived, and its standing read from those times: `declared` (it arrived with the creation or before the first trial started, after which it cannot be replaced), `named` (it arrived later, and the experiment’s name, fixed at creation, carries `name_prefix`, at least `name_commit_min_hex` hex digits of its digest: 32 on an experiment created since the rule rose, 12 before), or `after` (neither). The text is its own read. */
     design: ExperimentDesign | null;
 }
 /** A paired experiment scored now: each arm, every pair, the comparisons against the control, and the decision. */
@@ -146,6 +153,8 @@ export interface ExperimentReport {
     name: string;
     status: 'queued' | 'running' | 'finished' | 'cancelled';
     stop_reason: string | null;
+    cancel_reason: 'fault' | 'design' | 'budget' | 'results' | 'other' | null;
+    replaced_by: string | null;
     created_at_ms: number;
     started_at_ms: number | null;
     ended_at_ms: number | null;
@@ -153,6 +162,10 @@ export interface ExperimentReport {
     trials: number;
     seed_mode: 'vary' | 'pinned';
     aa_check: boolean;
+    pilot: boolean;
+    name_commit_min_hex: number;
+    creation_sha256: string | null;
+    seed_source: ExperimentSeedSource;
     metric: 'fitness_index' | 'rank' | 'survived' | 'index_survival' | 'index_economy' | 'index_social' | 'index_adaptation' | 'index_competitiveness' | 'aggression_per_100_rounds' | 'trades_per_100_rounds' | 'messages_per_100_rounds' | 'map_coverage' | 'witness_sensitivity' | 'compliance_rate' | 'compliance_latency' | 'injection_resistance' | 'output_tokens_per_turn' | 'said_evaluated' | 'aggression_between_seats_per_100_rounds' | 'trades_between_seats_per_100_rounds' | 'betrayals_per_100_rounds' | 'ring_share';
     analysis_scale: 'metric' | 'negative_rank' | 'log';
     rule: StoppingRule;
@@ -169,7 +182,8 @@ export interface ExperimentReport {
     cost: Cost;
     note: string | null;
     note_at_ms: number | null;
-    /** The design document as the server received it: the SHA-256 of its UTF-8 bytes, its size, when it arrived, and its standing read from those times: `declared` (it arrived with the creation or before the first trial started, after which it cannot be replaced), `named` (it arrived later, and the experiment’s name, fixed at creation, carries `name_prefix`, the first 12 or more hex digits of its digest), or `after` (neither). The text is its own read. */
+    notes?: ExperimentNoteEntry[];
+    /** The design document as the server received it: the SHA-256 of its UTF-8 bytes, its size, when it arrived, and its standing read from those times: `declared` (it arrived with the creation or before the first trial started, after which it cannot be replaced), `named` (it arrived later, and the experiment’s name, fixed at creation, carries `name_prefix`, at least `name_commit_min_hex` hex digits of its digest: 32 on an experiment created since the rule rose, 12 before), or `after` (neither). The text is its own read. */
     design: ExperimentDesign | null;
 }
 /** A run set: several of the account’s finished runs, standalone runs and whole series batches, published on its profile as one card, each filed under a setup the owner named. The card prints per setup the design’s standing, the harness versions, the models, the settings that differ between the setups, the seats’ own text, built-in skills and custom instructions (word for word when `show_seat_text` is on, else each text’s hash tag and size; a seat carrying one of the account’s own skills shows its tag and size only) and the counts of what the seats did; no score, no verdict, no per-model row, and the set’s runs leave the profile’s per-model table. `profile_url` and `study_url` are where the card is once published and the account has a handle, null otherwise. */
@@ -267,6 +281,8 @@ export interface ExperimentBody {
     target_half_width?: number;
     /** true declares an A/A check: every arm plays the control’s configuration on purpose, so the report measures the noise between identical arms (labels may still differ). Without it, an arm identical to the control is refused (experiment_same_arms); with it, an arm that differs is refused (bad_experiment). The report and the list carry it as aa_check, and the verdict says that any difference is noise. Default false. */
     aa_check?: boolean;
+    /** true declares a pilot: a dry run whose result is not to be read as a finding, said here and never after, so a result cannot be relabelled a pilot once seen. The record, the study’s card and, on Daishi’s own account, the declared-studies ledger carry it as pilot. Default false. */
+    pilot?: boolean;
     /** The id (exp_...) of one of your own experiments whose observed spread sizes this design’s detectable_gap until five of its own pairs are in: it must have played the same scenario, declared this body’s metric as its metric or a secondary outcome, and have five or more pairs with a value in both arms that did not all come out alike; the standard deviation of its paired differences on that metric (arm minus control, on the analysis scale) is the spread. An A/A check is the natural source, and the receipt says whether the one named was one (detectable_gap.reference.aa_check); any other qualifying experiment is taken, its spread then holding whatever effect it carried. The estimate and the report print the gap with source: "reference" and reference naming the experiment, its name, its pairs and the spread read off it; once this experiment has five pairs of its own, its own spread takes over as it always does. Anything else (another account’s experiment, another scenario, a metric it did not declare, fewer than five such pairs) answers bad_experiment. Default none: the prior where one exists, else no gap until five pairs. */
     spread_from?: string;
     /** Where to POST the signed experiment.ended notice: https, a public host, no credentials, at most 512 characters. Omitted: the account’s webhook setting, if any. */
@@ -386,15 +402,31 @@ export interface GetExperimentResponse {
     experiment: ExperimentReport;
     runs: Run[][];
 }
+export interface CancelExperimentBody {
+    /** Why you are stopping it, in your own word: fault (a seat, a route, a key or the platform failed, and the trials played are not usable), design (a flaw in the design or the arms), budget (spend or time), results (what the trials so far showed), or other. Kept on the record as cancel_reason. */
+    reason: 'fault' | 'design' | 'budget' | 'results' | 'other';
+    /** The id (exp_...) of your experiment that replaces this one, if any. It must be yours and not this one. */
+    replaced_by?: string;
+}
 export interface CancelExperimentResponse {
     ok: boolean;
     experiment: Experiment;
 }
-export interface SetExperimentNoteBody {
-    /** The note, counted after trimming. "" or null: no note. */
-    note: string | null;
+export interface SetExperimentStopReasonBody {
+    /** The reason, as a cancel takes it; only on an experiment that ended cancelled and carries none yet. */
+    reason?: 'fault' | 'design' | 'budget' | 'results' | 'other';
+    /** The id (exp_...) of your experiment that replaced this one; null clears it. */
+    replaced_by?: string | null;
 }
-export interface SetExperimentNoteResponse {
+export interface SetExperimentStopReasonResponse {
+    ok: boolean;
+    experiment: Experiment;
+}
+export interface AddExperimentNoteBody {
+    /** The entry to add, counted after trimming; an empty one is refused, since there is nothing to clear. */
+    note: string;
+}
+export interface AddExperimentNoteResponse {
     ok: boolean;
     experiment: Experiment;
 }
@@ -414,8 +446,16 @@ export interface GetExperimentDesignResponse {
     standing: 'declared' | 'named' | 'after';
     name_prefix: string | null;
     witnesses: DesignWitness[];
+    versions: ExperimentDesignVersion[];
     text: string;
 }
+export interface GetExperimentCreationResponse {
+    experiment_id: string;
+    created_at_ms: number;
+    sha256: string;
+    record: string;
+    witnesses: DesignWitness[];
+}
 export interface CancelResponse {
     ok: boolean;
     run: Run;
@@ -435,7 +475,7 @@ export interface UnpublishRunResponse {
     profile_url: string | null;
 }
 export interface PublishExperimentBody {
-    /** The study’s note, your declared result. Omitted: the experiment keeps the note it has. "" or null: no note. */
+    /** An entry added to the study’s note first: your declared result, in your words. Omitted, "" or null: nothing added; entries are never removed. */
     note?: string | null;
 }
 export interface PublishExperimentResponse {
@@ -708,6 +748,34 @@ export interface Cost {
     total_usd: number;
     agent_turns: number;
 }
+export interface ExperimentSeedSource {
+    kind: 'beacon' | 'server';
+    beacon: Beacon | null;
+    anchor: Anchor | null;
+    drawn_at_ms: number | null;
+    fallback: Fallback | null;
+    derivation: string | null;
+}
+export interface Beacon {
+    name: 'drand';
+    chain: string;
+    label: string;
+    world_draw: 'vary' | 'pinned' | 'none';
+    round: number | null;
+    round_at_ms: number | null;
+    randomness: string | null;
+    url: string | null;
+}
+export interface Anchor {
+    what: 'design' | 'creation';
+    sha256: string;
+    at_ms: number;
+    clock: 'rfc3161' | 'daishi';
+}
+export interface Fallback {
+    reason: string;
+    at_ms: number;
+}
 export interface StoppingRule {
     kind: 'fixed' | 'anytime';
     alpha: number;
@@ -729,7 +797,12 @@ export interface StudyRerun {
     exact: boolean;
     differences: string[];
 }
-/** The design document as the server received it: the SHA-256 of its UTF-8 bytes, its size, when it arrived, and its standing read from those times: `declared` (it arrived with the creation or before the first trial started, after which it cannot be replaced), `named` (it arrived later, and the experiment’s name, fixed at creation, carries `name_prefix`, the first 12 or more hex digits of its digest), or `after` (neither). The text is its own read. */
+export interface ExperimentNoteEntry {
+    seq: number;
+    text: string;
+    at_ms: number;
+}
+/** The design document as the server received it: the SHA-256 of its UTF-8 bytes, its size, when it arrived, and its standing read from those times: `declared` (it arrived with the creation or before the first trial started, after which it cannot be replaced), `named` (it arrived later, and the experiment’s name, fixed at creation, carries `name_prefix`, at least `name_commit_min_hex` hex digits of its digest: 32 on an experiment created since the rule rose, 12 before), or `after` (neither). The text is its own read. */
 export interface ExperimentDesign {
     sha256: string;
     bytes: number;
@@ -988,6 +1061,13 @@ export interface DesignWitness {
     created_at_ms: number;
     proof_format: 'tsr' | 'ots';
 }
+export interface ExperimentDesignVersion {
+    version: number;
+    sha256: string;
+    bytes: number;
+    at_ms: number;
+    witnesses: DesignWitness[];
+}
 export interface Study {
     kind: 'experiment' | 'series';
     id: string;
@@ -1254,19 +1334,27 @@ export declare abstract class Operations {
     /**
      * Cancel an experiment.
      *
-     * Stop a queued or running experiment: every unfinished trial of every arm, then the record.
+     * Stop a queued or running experiment: every unfinished trial of every arm, then the record, with your reason on it.
      *
      * @see https://daishi.ai/docs/developer/rest#ep-cancel-experiment
      */
-    cancelExperiment(id: string): Promise<CancelExperimentResponse>;
+    cancelExperiment(id: string, body: CancelExperimentBody): Promise<CancelExperimentResponse>;
     /**
-     * Set an experiment’s note.
+     * Say why an ended experiment stopped.
      *
-     * Write or clear your note on one of your experiments: its declared result, in your words.
+     * On an experiment that has ended: give the reason, once, where none was asked, or name the experiment that replaced it.
      *
-     * @see https://daishi.ai/docs/developer/rest#ep-set-experiment-note
+     * @see https://daishi.ai/docs/developer/rest#ep-set-experiment-stop-reason
      */
-    setExperimentNote(id: string, body: SetExperimentNoteBody): Promise<SetExperimentNoteResponse>;
+    setExperimentStopReason(id: string, body: SetExperimentStopReasonBody): Promise<SetExperimentStopReasonResponse>;
+    /**
+     * Add to an experiment’s note.
+     *
+     * Add a dated entry to your note on one of your experiments: its declared result, in your words, then what you add later.
+     *
+     * @see https://daishi.ai/docs/developer/rest#ep-add-experiment-note
+     */
+    addExperimentNote(id: string, body: AddExperimentNoteBody): Promise<AddExperimentNoteResponse>;
     /**
      * Attach an experiment’s design.
      *
@@ -1283,6 +1371,14 @@ export declare abstract class Operations {
      * @see https://daishi.ai/docs/developer/rest#ep-get-experiment-design
      */
     getExperimentDesign(id: string): Promise<GetExperimentDesignResponse>;
+    /**
+     * Get an experiment’s creation record.
+     *
+     * The record the outside witnesses were handed the moment one of your experiments was created, with its digest and their proofs.
+     *
+     * @see https://daishi.ai/docs/developer/rest#ep-get-experiment-creation
+     */
+    getExperimentCreation(id: string): Promise<GetExperimentCreationResponse>;
     /**
      * Cancel a run.
      *

package/dist/generated.js

@@ -307,21 +307,31 @@ export class Operations {
     /**
      * Cancel an experiment.
      *
-     * Stop a queued or running experiment: every unfinished trial of every arm, then the record.
+     * Stop a queued or running experiment: every unfinished trial of every arm, then the record, with your reason on it.
      *
      * @see https://daishi.ai/docs/developer/rest#ep-cancel-experiment
      */
-    cancelExperiment(id) {
-        return this.request('POST', `/experiments/${encodeURIComponent(id)}/cancel`);
+    cancelExperiment(id, body) {
+        return this.request('POST', `/experiments/${encodeURIComponent(id)}/cancel`, { body });
     }
     /**
-     * Set an experiment’s note.
+     * Say why an ended experiment stopped.
      *
-     * Write or clear your note on one of your experiments: its declared result, in your words.
+     * On an experiment that has ended: give the reason, once, where none was asked, or name the experiment that replaced it.
      *
-     * @see https://daishi.ai/docs/developer/rest#ep-set-experiment-note
+     * @see https://daishi.ai/docs/developer/rest#ep-set-experiment-stop-reason
      */
-    setExperimentNote(id, body) {
+    setExperimentStopReason(id, body) {
+        return this.request('POST', `/experiments/${encodeURIComponent(id)}/stop-reason`, { body });
+    }
+    /**
+     * Add to an experiment’s note.
+     *
+     * Add a dated entry to your note on one of your experiments: its declared result, in your words, then what you add later.
+     *
+     * @see https://daishi.ai/docs/developer/rest#ep-add-experiment-note
+     */
+    addExperimentNote(id, body) {
         return this.request('POST', `/experiments/${encodeURIComponent(id)}/note`, { body });
     }
     /**
@@ -344,6 +354,16 @@ export class Operations {
     getExperimentDesign(id) {
         return this.request('GET', `/experiments/${encodeURIComponent(id)}/design`);
     }
+    /**
+     * Get an experiment’s creation record.
+     *
+     * The record the outside witnesses were handed the moment one of your experiments was created, with its digest and their proofs.
+     *
+     * @see https://daishi.ai/docs/developer/rest#ep-get-experiment-creation
+     */
+    getExperimentCreation(id) {
+        return this.request('GET', `/experiments/${encodeURIComponent(id)}/creation`);
+    }
     /**
      * Cancel a run.
      *

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Operations, type ErrorCode, type GetBatchResponse, type GetExperimentResponse, type GetRunResponse, type Method, type RequestParts } from './generated.js';
 export * from './generated.js';
-export declare const VERSION = "0.2.16";
+export declare const VERSION = "0.2.18";
 export declare const DEFAULT_BASE_URL = "https://daishi.ai/api/v1";
 export interface DaishiOptions {
     /** A Studio access token (`dsk_...`). Default: the `DAISHI_TOKEN` environment variable. */

package/dist/index.js

@@ -1,6 +1,6 @@
 import { Operations } from './generated.js';
 export * from './generated.js';
-export const VERSION = '0.2.16';
+export const VERSION = '0.2.18';
 export const DEFAULT_BASE_URL = 'https://daishi.ai/api/v1';
 /** A refusal from the API, or a transport failure after the retries ran out. */
 export class DaishiError extends Error {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "daishi-sdk",
-  "version": "0.2.16",
+  "version": "0.2.18",
   "description": "Typed client for the Daishi Studio API: scenarios, runs, series batches and paired experiments, with retries and waiting helpers.",
   "keywords": [
     "daishi",