braintrust 3.9.0 → 3.10.0

package/dev/dist/index.d.mts

@@ -1474,6 +1474,29 @@ declare const SavedFunctionId: z.ZodUnion<[z.ZodObject<{
     function_type?: "llm" | "scorer" | "task" | "tool" | "custom_view" | "preprocessor" | "facet" | "classifier" | "tag" | "parameters" | "sandbox" | undefined;
 }>]>;
 type SavedFunctionIdType = z.infer<typeof SavedFunctionId>;
+declare const DatasetSnapshot: z.ZodObject<{
+    id: z.ZodString;
+    dataset_id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodUnion<[z.ZodString, z.ZodNull]>;
+    xact_id: z.ZodString;
+    created: z.ZodUnion<[z.ZodString, z.ZodNull]>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    created: string | null;
+    name: string;
+    description: string | null;
+    dataset_id: string;
+    xact_id: string;
+}, {
+    id: string;
+    created: string | null;
+    name: string;
+    description: string | null;
+    dataset_id: string;
+    xact_id: string;
+}>;
+type DatasetSnapshotType = z.infer<typeof DatasetSnapshot>;
 declare const RepoInfo: z.ZodUnion<[z.ZodObject<{
     commit: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
     branch: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
@@ -4035,6 +4058,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             }>>;
+            disable_reconciliation: z.ZodOptional<z.ZodBoolean>;
             distance_threshold: z.ZodOptional<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
             type: "topic_map";
@@ -4053,6 +4077,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         }, {
             type: "topic_map";
@@ -4071,6 +4096,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         }>;
     }, "strip", z.ZodTypeAny, {
@@ -4092,6 +4118,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         };
         topic_map_id?: string | undefined;
@@ -4114,6 +4141,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         };
         topic_map_id?: string | undefined;
@@ -4155,6 +4183,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         };
         topic_map_id?: string | undefined;
@@ -4196,6 +4225,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         };
         topic_map_id?: string | undefined;
@@ -4276,6 +4306,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
         hierarchy_threshold?: number | undefined;
         naming_model?: string | undefined;
     }>>;
+    disable_reconciliation: z.ZodOptional<z.ZodBoolean>;
     distance_threshold: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     type: "topic_map";
@@ -4294,6 +4325,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
         hierarchy_threshold?: number | undefined;
         naming_model?: string | undefined;
     } | undefined;
+    disable_reconciliation?: boolean | undefined;
     distance_threshold?: number | undefined;
 }, {
     type: "topic_map";
@@ -4312,6 +4344,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
         hierarchy_threshold?: number | undefined;
         naming_model?: string | undefined;
     } | undefined;
+    disable_reconciliation?: boolean | undefined;
     distance_threshold?: number | undefined;
 }>, z.ZodUnknown>]>;
 declare const PromptData: z.ZodObject<{
@@ -10684,6 +10717,31 @@ type InferParameters<T extends EvalParameters> = {
 };
 
 declare const RESET_CONTEXT_MANAGER_STATE: unique symbol;
+declare const datasetRestorePreviewResultSchema: z.ZodObject<{
+    rows_to_restore: z.ZodNumber;
+    rows_to_delete: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    rows_to_restore: number;
+    rows_to_delete: number;
+}, {
+    rows_to_restore: number;
+    rows_to_delete: number;
+}>;
+type DatasetRestorePreviewResult = z.infer<typeof datasetRestorePreviewResultSchema>;
+declare const datasetRestoreResultSchema: z.ZodObject<{
+    xact_id: z.ZodNullable<z.ZodString>;
+    rows_restored: z.ZodNumber;
+    rows_deleted: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    xact_id: string | null;
+    rows_restored: number;
+    rows_deleted: number;
+}, {
+    xact_id: string | null;
+    rows_restored: number;
+    rows_deleted: number;
+}>;
+type DatasetRestoreResult = z.infer<typeof datasetRestoreResultSchema>;
 declare const parametersRowSchema: z.ZodObject<{
     id: z.ZodString;
     _xact_id: z.ZodString;
@@ -11257,6 +11315,20 @@ declare class HTTPBackgroundLogger implements BackgroundLogger {
     disable(): void;
     enforceQueueSizeLimit(enforce: boolean): void;
 }
+type DatasetSnapshotNameLookup = {
+    snapshotName: string;
+    xactId?: never;
+};
+type DatasetSnapshotXactLookup = {
+    snapshotName?: never;
+    xactId: string;
+};
+type DatasetSnapshotLookup = DatasetSnapshotNameLookup | DatasetSnapshotXactLookup;
+type DatasetPinState = {
+    lazyPinnedVersion?: LazyValue<string | undefined>;
+    pinnedEnvironment?: string;
+    pinnedSnapshotName?: string;
+};
 type AsyncFlushArg<IsAsyncFlush> = {
     asyncFlush?: IsAsyncFlush;
 };
@@ -11344,6 +11416,9 @@ declare class ObjectFetcher<RecordType> implements AsyncIterable<WithTransaction
     constructor(objectType: "dataset" | "experiment" | "project_logs" | "playground_logs", pinnedVersion: string | undefined, mutateRecord?: ((r: any) => WithTransactionId<RecordType>) | undefined, _internal_btql?: Record<string, unknown> | undefined);
     get id(): Promise<string>;
     protected getState(): Promise<BraintrustState>;
+    protected getPinnedVersion(): string | undefined;
+    protected setPinnedVersion(pinnedVersion: string | undefined): void;
+    protected getInternalBtql(): Record<string, unknown> | undefined;
     private fetchRecordsFromApi;
     /**
      * Fetch all records from the object.
@@ -11509,12 +11584,25 @@ declare class Dataset<IsLegacyDataset extends boolean = typeof DEFAULT_IS_LEGACY
     private readonly lazyMetadata;
     private readonly __braintrust_dataset_marker;
     private newRecords;
-    constructor(state: BraintrustState, lazyMetadata: LazyValue<ProjectDatasetMetadata>, pinnedVersion?: string, legacy?: IsLegacyDataset, _internal_btql?: Record<string, unknown>);
+    private lazyPinnedVersion?;
+    private pinnedEnvironment?;
+    private pinnedSnapshotName?;
+    constructor(state: BraintrustState, lazyMetadata: LazyValue<ProjectDatasetMetadata>, pinnedVersion?: string, legacy?: IsLegacyDataset, _internal_btql?: Record<string, unknown>, pinState?: DatasetPinState);
     get id(): Promise<string>;
     get name(): Promise<string>;
     get project(): Promise<ObjectMetadata>;
     get loggingState(): BraintrustState;
+    toEvalData(): Promise<{
+        dataset_id: string;
+        dataset_version?: string;
+        dataset_environment?: string;
+        dataset_snapshot_name?: string;
+        _internal_btql?: Record<string, unknown>;
+    }>;
     protected getState(): Promise<BraintrustState>;
+    version(options?: {
+        batchSize?: number;
+    }): Promise<string | undefined>;
     private validateEvent;
     private createArgs;
     /**
@@ -11562,6 +11650,24 @@ declare class Dataset<IsLegacyDataset extends boolean = typeof DEFAULT_IS_LEGACY
         readonly metadata?: Record<string, unknown>;
     }): string;
     delete(id: string): string;
+    createSnapshot({ name, description, update, }: {
+        readonly name: string;
+        readonly description?: string;
+        readonly update?: boolean;
+    }): Promise<DatasetSnapshotType>;
+    listSnapshots(): Promise<DatasetSnapshotType[]>;
+    getSnapshot(lookup: DatasetSnapshotLookup): Promise<DatasetSnapshotType | undefined>;
+    updateSnapshot(snapshotId: string, { name, description, }: {
+        readonly name?: string;
+        readonly description?: string | null;
+    }): Promise<DatasetSnapshotType>;
+    deleteSnapshot(snapshotId: string): Promise<DatasetSnapshotType>;
+    restorePreview({ version, }: {
+        readonly version: string;
+    }): Promise<DatasetRestorePreviewResult>;
+    restore({ version, }: {
+        readonly version: string;
+    }): Promise<DatasetRestoreResult>;
     /**
      * Summarize the dataset, including high level metrics about its size and other metadata.
      * @param summarizeData Whether to summarize the data. If false, only the metadata will be returned.

package/dev/dist/index.d.ts

@@ -1474,6 +1474,29 @@ declare const SavedFunctionId: z.ZodUnion<[z.ZodObject<{
     function_type?: "llm" | "scorer" | "task" | "tool" | "custom_view" | "preprocessor" | "facet" | "classifier" | "tag" | "parameters" | "sandbox" | undefined;
 }>]>;
 type SavedFunctionIdType = z.infer<typeof SavedFunctionId>;
+declare const DatasetSnapshot: z.ZodObject<{
+    id: z.ZodString;
+    dataset_id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodUnion<[z.ZodString, z.ZodNull]>;
+    xact_id: z.ZodString;
+    created: z.ZodUnion<[z.ZodString, z.ZodNull]>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    created: string | null;
+    name: string;
+    description: string | null;
+    dataset_id: string;
+    xact_id: string;
+}, {
+    id: string;
+    created: string | null;
+    name: string;
+    description: string | null;
+    dataset_id: string;
+    xact_id: string;
+}>;
+type DatasetSnapshotType = z.infer<typeof DatasetSnapshot>;
 declare const RepoInfo: z.ZodUnion<[z.ZodObject<{
     commit: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
     branch: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNull]>>;
@@ -4035,6 +4058,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             }>>;
+            disable_reconciliation: z.ZodOptional<z.ZodBoolean>;
             distance_threshold: z.ZodOptional<z.ZodNumber>;
         }, "strip", z.ZodTypeAny, {
             type: "topic_map";
@@ -4053,6 +4077,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         }, {
             type: "topic_map";
@@ -4071,6 +4096,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         }>;
     }, "strip", z.ZodTypeAny, {
@@ -4092,6 +4118,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         };
         topic_map_id?: string | undefined;
@@ -4114,6 +4141,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         };
         topic_map_id?: string | undefined;
@@ -4155,6 +4183,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         };
         topic_map_id?: string | undefined;
@@ -4196,6 +4225,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
                 hierarchy_threshold?: number | undefined;
                 naming_model?: string | undefined;
             } | undefined;
+            disable_reconciliation?: boolean | undefined;
             distance_threshold?: number | undefined;
         };
         topic_map_id?: string | undefined;
@@ -4276,6 +4306,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
         hierarchy_threshold?: number | undefined;
         naming_model?: string | undefined;
     }>>;
+    disable_reconciliation: z.ZodOptional<z.ZodBoolean>;
     distance_threshold: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     type: "topic_map";
@@ -4294,6 +4325,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
         hierarchy_threshold?: number | undefined;
         naming_model?: string | undefined;
     } | undefined;
+    disable_reconciliation?: boolean | undefined;
     distance_threshold?: number | undefined;
 }, {
     type: "topic_map";
@@ -4312,6 +4344,7 @@ declare const FunctionData: z.ZodUnion<[z.ZodObject<{
         hierarchy_threshold?: number | undefined;
         naming_model?: string | undefined;
     } | undefined;
+    disable_reconciliation?: boolean | undefined;
     distance_threshold?: number | undefined;
 }>, z.ZodUnknown>]>;
 declare const PromptData: z.ZodObject<{
@@ -10684,6 +10717,31 @@ type InferParameters<T extends EvalParameters> = {
 };
 
 declare const RESET_CONTEXT_MANAGER_STATE: unique symbol;
+declare const datasetRestorePreviewResultSchema: z.ZodObject<{
+    rows_to_restore: z.ZodNumber;
+    rows_to_delete: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    rows_to_restore: number;
+    rows_to_delete: number;
+}, {
+    rows_to_restore: number;
+    rows_to_delete: number;
+}>;
+type DatasetRestorePreviewResult = z.infer<typeof datasetRestorePreviewResultSchema>;
+declare const datasetRestoreResultSchema: z.ZodObject<{
+    xact_id: z.ZodNullable<z.ZodString>;
+    rows_restored: z.ZodNumber;
+    rows_deleted: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    xact_id: string | null;
+    rows_restored: number;
+    rows_deleted: number;
+}, {
+    xact_id: string | null;
+    rows_restored: number;
+    rows_deleted: number;
+}>;
+type DatasetRestoreResult = z.infer<typeof datasetRestoreResultSchema>;
 declare const parametersRowSchema: z.ZodObject<{
     id: z.ZodString;
     _xact_id: z.ZodString;
@@ -11257,6 +11315,20 @@ declare class HTTPBackgroundLogger implements BackgroundLogger {
     disable(): void;
     enforceQueueSizeLimit(enforce: boolean): void;
 }
+type DatasetSnapshotNameLookup = {
+    snapshotName: string;
+    xactId?: never;
+};
+type DatasetSnapshotXactLookup = {
+    snapshotName?: never;
+    xactId: string;
+};
+type DatasetSnapshotLookup = DatasetSnapshotNameLookup | DatasetSnapshotXactLookup;
+type DatasetPinState = {
+    lazyPinnedVersion?: LazyValue<string | undefined>;
+    pinnedEnvironment?: string;
+    pinnedSnapshotName?: string;
+};
 type AsyncFlushArg<IsAsyncFlush> = {
     asyncFlush?: IsAsyncFlush;
 };
@@ -11344,6 +11416,9 @@ declare class ObjectFetcher<RecordType> implements AsyncIterable<WithTransaction
     constructor(objectType: "dataset" | "experiment" | "project_logs" | "playground_logs", pinnedVersion: string | undefined, mutateRecord?: ((r: any) => WithTransactionId<RecordType>) | undefined, _internal_btql?: Record<string, unknown> | undefined);
     get id(): Promise<string>;
     protected getState(): Promise<BraintrustState>;
+    protected getPinnedVersion(): string | undefined;
+    protected setPinnedVersion(pinnedVersion: string | undefined): void;
+    protected getInternalBtql(): Record<string, unknown> | undefined;
     private fetchRecordsFromApi;
     /**
      * Fetch all records from the object.
@@ -11509,12 +11584,25 @@ declare class Dataset<IsLegacyDataset extends boolean = typeof DEFAULT_IS_LEGACY
     private readonly lazyMetadata;
     private readonly __braintrust_dataset_marker;
     private newRecords;
-    constructor(state: BraintrustState, lazyMetadata: LazyValue<ProjectDatasetMetadata>, pinnedVersion?: string, legacy?: IsLegacyDataset, _internal_btql?: Record<string, unknown>);
+    private lazyPinnedVersion?;
+    private pinnedEnvironment?;
+    private pinnedSnapshotName?;
+    constructor(state: BraintrustState, lazyMetadata: LazyValue<ProjectDatasetMetadata>, pinnedVersion?: string, legacy?: IsLegacyDataset, _internal_btql?: Record<string, unknown>, pinState?: DatasetPinState);
     get id(): Promise<string>;
     get name(): Promise<string>;
     get project(): Promise<ObjectMetadata>;
     get loggingState(): BraintrustState;
+    toEvalData(): Promise<{
+        dataset_id: string;
+        dataset_version?: string;
+        dataset_environment?: string;
+        dataset_snapshot_name?: string;
+        _internal_btql?: Record<string, unknown>;
+    }>;
     protected getState(): Promise<BraintrustState>;
+    version(options?: {
+        batchSize?: number;
+    }): Promise<string | undefined>;
     private validateEvent;
     private createArgs;
     /**
@@ -11562,6 +11650,24 @@ declare class Dataset<IsLegacyDataset extends boolean = typeof DEFAULT_IS_LEGACY
         readonly metadata?: Record<string, unknown>;
     }): string;
     delete(id: string): string;
+    createSnapshot({ name, description, update, }: {
+        readonly name: string;
+        readonly description?: string;
+        readonly update?: boolean;
+    }): Promise<DatasetSnapshotType>;
+    listSnapshots(): Promise<DatasetSnapshotType[]>;
+    getSnapshot(lookup: DatasetSnapshotLookup): Promise<DatasetSnapshotType | undefined>;
+    updateSnapshot(snapshotId: string, { name, description, }: {
+        readonly name?: string;
+        readonly description?: string | null;
+    }): Promise<DatasetSnapshotType>;
+    deleteSnapshot(snapshotId: string): Promise<DatasetSnapshotType>;
+    restorePreview({ version, }: {
+        readonly version: string;
+    }): Promise<DatasetRestorePreviewResult>;
+    restore({ version, }: {
+        readonly version: string;
+    }): Promise<DatasetRestoreResult>;
     /**
      * Summarize the dataset, including high level metrics about its size and other metadata.
      * @param summarizeData Whether to summarize the data. If false, only the metadata will be returned.