braintrust 0.0.172 → 0.0.174

package/dist/browser.d.mts

@@ -1,5 +1,5 @@
 import { LogFeedbackFullArgs, ExperimentEvent, BackgroundLogEvent, ExperimentLogFullArgs, ExperimentLogPartialArgs, IdField, SpanType, SpanComponentsV3, DEFAULT_IS_LEGACY_DATASET, TRANSACTION_ID_FIELD, TransactionId, SpanObjectTypeV3, DatasetRecord } from '@braintrust/core';
-import { GitMetadataSettings, AttachmentReference, RepoInfo, PromptData, OpenAIMessage, Tools, AnyModelParam, Message, Prompt as Prompt$1, PromptSessionEvent, StreamingMode } from '@braintrust/core/typespecs';
+import { GitMetadataSettings, AttachmentReference, AttachmentStatus, RepoInfo, PromptData, OpenAIMessage, Tools, AnyModelParam, Message, Prompt as Prompt$1, PromptSessionEvent, StreamingMode } from '@braintrust/core/typespecs';
 import { z } from 'zod';
 
 interface IsoAsyncLocalStorage<T> {
@@ -16,6 +16,8 @@ declare class LazyValue<T> {
     get hasComputed(): boolean;
 }
 
+/// <reference lib="dom" />
+
 type SetCurrentArg = {
     setCurrent?: boolean;
 };
@@ -312,17 +314,19 @@ declare class Attachment {
     /**
      * Construct an attachment.
      *
-     * @param data A string representing the path of the file on disk, or a
+     * @param param A parameter object with:
+     *
+     * `data`: A string representing the path of the file on disk, or a
      * `Blob`/`ArrayBuffer` with the file's contents. The caller is responsible
      * for ensuring the file/blob/buffer is not modified until upload is complete.
      *
-     * @param filename The desired name of the file in Braintrust after uploading.
+     * `filename`: The desired name of the file in Braintrust after uploading.
      * This parameter is for visualization purposes only and has no effect on
      * attachment storage.
      *
-     * @param contentType The MIME type of the file.
+     * `contentType`: The MIME type of the file.
      *
-     * @param state (Optional) For internal use.
+     * `state`: (Optional) For internal use.
      */
     constructor({ data, filename, contentType, state }: AttachmentParams);
     /**
@@ -350,6 +354,39 @@ declare class Attachment {
     private initUploader;
     private initData;
 }
+/**
+ * A readonly alternative to `Attachment`, which can be used for fetching
+ * already-uploaded Attachments.
+ */
+declare class ReadonlyAttachment {
+    /**
+     * Attachment metadata.
+     */
+    readonly reference: AttachmentReference;
+    private readonly _data;
+    private readonly state?;
+    /**
+     * Construct a ReadonlyAttachment.
+     *
+     * @param reference The `AttachmentReference` that should be read by the
+     * `ReadonlyAttachment` object.
+     * @param state (Optional) For internal use.
+     * @returns The new `ReadonlyAttachment` object.
+     */
+    constructor(reference: AttachmentReference, state?: BraintrustState);
+    /**
+     * The attachment contents. This is a lazy value that will read the attachment
+     * contents from the object store on first access.
+     */
+    data(): Promise<Blob>;
+    /**
+     * Fetch the attachment upload status. This will re-fetch the status each time
+     * in case it changes over time.
+     */
+    status(): Promise<AttachmentStatus>;
+    private initDownloader;
+    private fetchMetadata;
+}
 /**
  * Update a span using the output of `span.export()`. It is important that you only resume updating
  * to a span once the original span has been fully written and flushed, since otherwise updates to
@@ -1601,6 +1638,8 @@ type braintrust_PromiseUnless<B, R> = PromiseUnless<B, R>;
 type braintrust_Prompt<HasId extends boolean = true, HasVersion extends boolean = true> = Prompt<HasId, HasVersion>;
 declare const braintrust_Prompt: typeof Prompt;
 type braintrust_PromptRowWithId<HasId extends boolean = true, HasVersion extends boolean = true> = PromptRowWithId<HasId, HasVersion>;
+type braintrust_ReadonlyAttachment = ReadonlyAttachment;
+declare const braintrust_ReadonlyAttachment: typeof ReadonlyAttachment;
 type braintrust_ReadonlyExperiment = ReadonlyExperiment;
 declare const braintrust_ReadonlyExperiment: typeof ReadonlyExperiment;
 type braintrust_ScoreSummary = ScoreSummary;
@@ -1652,7 +1691,7 @@ declare const braintrust_wrapOpenAI: typeof wrapOpenAI;
 declare const braintrust_wrapOpenAIv4: typeof wrapOpenAIv4;
 declare const braintrust_wrapTraced: typeof wrapTraced;
 declare namespace braintrust {
-  export { type braintrust_AnyDataset as AnyDataset, braintrust_Attachment as Attachment, type braintrust_AttachmentParams as AttachmentParams, type braintrust_BackgroundLoggerOpts as BackgroundLoggerOpts, type braintrust_BaseMetadata as BaseMetadata, braintrust_BraintrustState as BraintrustState, braintrust_BraintrustStream as BraintrustStream, type braintrust_BraintrustStreamChunk as BraintrustStreamChunk, type braintrust_ChatPrompt as ChatPrompt, type braintrust_CompiledPrompt as CompiledPrompt, type braintrust_CompiledPromptParams as CompiledPromptParams, type braintrust_CompletionPrompt as CompletionPrompt, type braintrust_DataSummary as DataSummary, braintrust_Dataset as Dataset, type braintrust_DatasetSummary as DatasetSummary, type braintrust_DefaultMetadataType as DefaultMetadataType, type braintrust_DefaultPromptArgs as DefaultPromptArgs, type braintrust_EndSpanArgs as EndSpanArgs, type braintrust_EvalCase as EvalCase, braintrust_Experiment as Experiment, type braintrust_ExperimentSummary as ExperimentSummary, type braintrust_Exportable as Exportable, braintrust_FailedHTTPResponse as FailedHTTPResponse, type braintrust_FullInitOptions as FullInitOptions, type braintrust_FullLoginOptions as FullLoginOptions, type braintrust_InitOptions as InitOptions, type braintrust_InvokeFunctionArgs as InvokeFunctionArgs, type braintrust_InvokeReturn as InvokeReturn, braintrust_LEGACY_CACHED_HEADER as LEGACY_CACHED_HEADER, type braintrust_LogOptions as LogOptions, braintrust_Logger as Logger, type braintrust_LoginOptions as LoginOptions, type braintrust_MetricSummary as MetricSummary, braintrust_NOOP_SPAN as NOOP_SPAN, braintrust_NoopSpan as NoopSpan, type braintrust_ObjectMetadata as ObjectMetadata, type braintrust_PromiseUnless as PromiseUnless, braintrust_Prompt as Prompt, type braintrust_PromptRowWithId as PromptRowWithId, braintrust_ReadonlyExperiment as ReadonlyExperiment, type braintrust_ScoreSummary as ScoreSummary, type braintrust_SerializedBraintrustState as SerializedBraintrustState, type braintrust_SetCurrentArg as SetCurrentArg, type braintrust_Span as Span, braintrust_SpanImpl as SpanImpl, type braintrust_StartSpanArgs as StartSpanArgs, type braintrust_WithTransactionId as WithTransactionId, braintrust_X_CACHED_HEADER as X_CACHED_HEADER, braintrust__exportsForTestingOnly as _exportsForTestingOnly, braintrust__internalGetGlobalState as _internalGetGlobalState, braintrust__internalSetInitialState as _internalSetInitialState, braintrust_braintrustStreamChunkSchema as braintrustStreamChunkSchema, braintrust_createFinalValuePassThroughStream as createFinalValuePassThroughStream, braintrust_currentExperiment as currentExperiment, braintrust_currentLogger as currentLogger, braintrust_currentSpan as currentSpan, braintrust_devNullWritableStream as devNullWritableStream, braintrust_flush as flush, braintrust_getSpanParentObject as getSpanParentObject, braintrust_init as init, braintrust_initDataset as initDataset, braintrust_initExperiment as initExperiment, braintrust_initLogger as initLogger, braintrust_invoke as invoke, braintrust_loadPrompt as loadPrompt, braintrust_log as log, braintrust_logError as logError, braintrust_login as login, braintrust_loginToState as loginToState, braintrust_newId as newId, braintrust_parseCachedHeader as parseCachedHeader, braintrust_permalink as permalink, braintrust_renderMessage as renderMessage, braintrust_setFetch as setFetch, braintrust_spanComponentsToObjectId as spanComponentsToObjectId, braintrust_startSpan as startSpan, braintrust_summarize as summarize, braintrust_traceable as traceable, braintrust_traced as traced, braintrust_updateSpan as updateSpan, braintrust_withCurrent as withCurrent, braintrust_withDataset as withDataset, braintrust_withExperiment as withExperiment, braintrust_withLogger as withLogger, braintrust_wrapOpenAI as wrapOpenAI, braintrust_wrapOpenAIv4 as wrapOpenAIv4, braintrust_wrapTraced as wrapTraced };
+  export { type braintrust_AnyDataset as AnyDataset, braintrust_Attachment as Attachment, type braintrust_AttachmentParams as AttachmentParams, type braintrust_BackgroundLoggerOpts as BackgroundLoggerOpts, type braintrust_BaseMetadata as BaseMetadata, braintrust_BraintrustState as BraintrustState, braintrust_BraintrustStream as BraintrustStream, type braintrust_BraintrustStreamChunk as BraintrustStreamChunk, type braintrust_ChatPrompt as ChatPrompt, type braintrust_CompiledPrompt as CompiledPrompt, type braintrust_CompiledPromptParams as CompiledPromptParams, type braintrust_CompletionPrompt as CompletionPrompt, type braintrust_DataSummary as DataSummary, braintrust_Dataset as Dataset, type braintrust_DatasetSummary as DatasetSummary, type braintrust_DefaultMetadataType as DefaultMetadataType, type braintrust_DefaultPromptArgs as DefaultPromptArgs, type braintrust_EndSpanArgs as EndSpanArgs, type braintrust_EvalCase as EvalCase, braintrust_Experiment as Experiment, type braintrust_ExperimentSummary as ExperimentSummary, type braintrust_Exportable as Exportable, braintrust_FailedHTTPResponse as FailedHTTPResponse, type braintrust_FullInitOptions as FullInitOptions, type braintrust_FullLoginOptions as FullLoginOptions, type braintrust_InitOptions as InitOptions, type braintrust_InvokeFunctionArgs as InvokeFunctionArgs, type braintrust_InvokeReturn as InvokeReturn, braintrust_LEGACY_CACHED_HEADER as LEGACY_CACHED_HEADER, type braintrust_LogOptions as LogOptions, braintrust_Logger as Logger, type braintrust_LoginOptions as LoginOptions, type braintrust_MetricSummary as MetricSummary, braintrust_NOOP_SPAN as NOOP_SPAN, braintrust_NoopSpan as NoopSpan, type braintrust_ObjectMetadata as ObjectMetadata, type braintrust_PromiseUnless as PromiseUnless, braintrust_Prompt as Prompt, type braintrust_PromptRowWithId as PromptRowWithId, braintrust_ReadonlyAttachment as ReadonlyAttachment, braintrust_ReadonlyExperiment as ReadonlyExperiment, type braintrust_ScoreSummary as ScoreSummary, type braintrust_SerializedBraintrustState as SerializedBraintrustState, type braintrust_SetCurrentArg as SetCurrentArg, type braintrust_Span as Span, braintrust_SpanImpl as SpanImpl, type braintrust_StartSpanArgs as StartSpanArgs, type braintrust_WithTransactionId as WithTransactionId, braintrust_X_CACHED_HEADER as X_CACHED_HEADER, braintrust__exportsForTestingOnly as _exportsForTestingOnly, braintrust__internalGetGlobalState as _internalGetGlobalState, braintrust__internalSetInitialState as _internalSetInitialState, braintrust_braintrustStreamChunkSchema as braintrustStreamChunkSchema, braintrust_createFinalValuePassThroughStream as createFinalValuePassThroughStream, braintrust_currentExperiment as currentExperiment, braintrust_currentLogger as currentLogger, braintrust_currentSpan as currentSpan, braintrust_devNullWritableStream as devNullWritableStream, braintrust_flush as flush, braintrust_getSpanParentObject as getSpanParentObject, braintrust_init as init, braintrust_initDataset as initDataset, braintrust_initExperiment as initExperiment, braintrust_initLogger as initLogger, braintrust_invoke as invoke, braintrust_loadPrompt as loadPrompt, braintrust_log as log, braintrust_logError as logError, braintrust_login as login, braintrust_loginToState as loginToState, braintrust_newId as newId, braintrust_parseCachedHeader as parseCachedHeader, braintrust_permalink as permalink, braintrust_renderMessage as renderMessage, braintrust_setFetch as setFetch, braintrust_spanComponentsToObjectId as spanComponentsToObjectId, braintrust_startSpan as startSpan, braintrust_summarize as summarize, braintrust_traceable as traceable, braintrust_traced as traced, braintrust_updateSpan as updateSpan, braintrust_withCurrent as withCurrent, braintrust_withDataset as withDataset, braintrust_withExperiment as withExperiment, braintrust_withLogger as withLogger, braintrust_wrapOpenAI as wrapOpenAI, braintrust_wrapOpenAIv4 as wrapOpenAIv4, braintrust_wrapTraced as wrapTraced };
 }
 
-export { type AnyDataset, Attachment, type AttachmentParams, type BackgroundLoggerOpts, type BaseMetadata, BraintrustState, BraintrustStream, type BraintrustStreamChunk, type ChatPrompt, type CompiledPrompt, type CompiledPromptParams, type CompletionPrompt, type DataSummary, Dataset, type DatasetSummary, type DefaultMetadataType, type DefaultPromptArgs, type EndSpanArgs, type EvalCase, Experiment, type ExperimentSummary, type Exportable, FailedHTTPResponse, type FullInitOptions, type FullLoginOptions, type InitOptions, type InvokeFunctionArgs, type InvokeReturn, LEGACY_CACHED_HEADER, type LogOptions, Logger, type LoginOptions, type MetricSummary, NOOP_SPAN, NoopSpan, type ObjectMetadata, type PromiseUnless, Prompt, type PromptRowWithId, ReadonlyExperiment, type ScoreSummary, type SerializedBraintrustState, type SetCurrentArg, type Span, SpanImpl, type StartSpanArgs, type WithTransactionId, X_CACHED_HEADER, _exportsForTestingOnly, _internalGetGlobalState, _internalSetInitialState, braintrustStreamChunkSchema, createFinalValuePassThroughStream, currentExperiment, currentLogger, currentSpan, braintrust as default, devNullWritableStream, flush, getSpanParentObject, init, initDataset, initExperiment, initLogger, invoke, loadPrompt, log, logError, login, loginToState, newId, parseCachedHeader, permalink, renderMessage, setFetch, spanComponentsToObjectId, startSpan, summarize, traceable, traced, updateSpan, withCurrent, withDataset, withExperiment, withLogger, wrapOpenAI, wrapOpenAIv4, wrapTraced };
+export { type AnyDataset, Attachment, type AttachmentParams, type BackgroundLoggerOpts, type BaseMetadata, BraintrustState, BraintrustStream, type BraintrustStreamChunk, type ChatPrompt, type CompiledPrompt, type CompiledPromptParams, type CompletionPrompt, type DataSummary, Dataset, type DatasetSummary, type DefaultMetadataType, type DefaultPromptArgs, type EndSpanArgs, type EvalCase, Experiment, type ExperimentSummary, type Exportable, FailedHTTPResponse, type FullInitOptions, type FullLoginOptions, type InitOptions, type InvokeFunctionArgs, type InvokeReturn, LEGACY_CACHED_HEADER, type LogOptions, Logger, type LoginOptions, type MetricSummary, NOOP_SPAN, NoopSpan, type ObjectMetadata, type PromiseUnless, Prompt, type PromptRowWithId, ReadonlyAttachment, ReadonlyExperiment, type ScoreSummary, type SerializedBraintrustState, type SetCurrentArg, type Span, SpanImpl, type StartSpanArgs, type WithTransactionId, X_CACHED_HEADER, _exportsForTestingOnly, _internalGetGlobalState, _internalSetInitialState, braintrustStreamChunkSchema, createFinalValuePassThroughStream, currentExperiment, currentLogger, currentSpan, braintrust as default, devNullWritableStream, flush, getSpanParentObject, init, initDataset, initExperiment, initLogger, invoke, loadPrompt, log, logError, login, loginToState, newId, parseCachedHeader, permalink, renderMessage, setFetch, spanComponentsToObjectId, startSpan, summarize, traceable, traced, updateSpan, withCurrent, withDataset, withExperiment, withLogger, wrapOpenAI, wrapOpenAIv4, wrapTraced };

package/dist/browser.d.ts

@@ -1,5 +1,5 @@
 import { LogFeedbackFullArgs, ExperimentEvent, BackgroundLogEvent, ExperimentLogFullArgs, ExperimentLogPartialArgs, IdField, SpanType, SpanComponentsV3, DEFAULT_IS_LEGACY_DATASET, TRANSACTION_ID_FIELD, TransactionId, SpanObjectTypeV3, DatasetRecord } from '@braintrust/core';
-import { GitMetadataSettings, AttachmentReference, RepoInfo, PromptData, OpenAIMessage, Tools, AnyModelParam, Message, Prompt as Prompt$1, PromptSessionEvent, StreamingMode } from '@braintrust/core/typespecs';
+import { GitMetadataSettings, AttachmentReference, AttachmentStatus, RepoInfo, PromptData, OpenAIMessage, Tools, AnyModelParam, Message, Prompt as Prompt$1, PromptSessionEvent, StreamingMode } from '@braintrust/core/typespecs';
 import { z } from 'zod';
 
 interface IsoAsyncLocalStorage<T> {
@@ -16,6 +16,8 @@ declare class LazyValue<T> {
     get hasComputed(): boolean;
 }
 
+/// <reference lib="dom" />
+
 type SetCurrentArg = {
     setCurrent?: boolean;
 };
@@ -312,17 +314,19 @@ declare class Attachment {
     /**
      * Construct an attachment.
      *
-     * @param data A string representing the path of the file on disk, or a
+     * @param param A parameter object with:
+     *
+     * `data`: A string representing the path of the file on disk, or a
      * `Blob`/`ArrayBuffer` with the file's contents. The caller is responsible
      * for ensuring the file/blob/buffer is not modified until upload is complete.
      *
-     * @param filename The desired name of the file in Braintrust after uploading.
+     * `filename`: The desired name of the file in Braintrust after uploading.
      * This parameter is for visualization purposes only and has no effect on
      * attachment storage.
      *
-     * @param contentType The MIME type of the file.
+     * `contentType`: The MIME type of the file.
      *
-     * @param state (Optional) For internal use.
+     * `state`: (Optional) For internal use.
      */
     constructor({ data, filename, contentType, state }: AttachmentParams);
     /**
@@ -350,6 +354,39 @@ declare class Attachment {
     private initUploader;
     private initData;
 }
+/**
+ * A readonly alternative to `Attachment`, which can be used for fetching
+ * already-uploaded Attachments.
+ */
+declare class ReadonlyAttachment {
+    /**
+     * Attachment metadata.
+     */
+    readonly reference: AttachmentReference;
+    private readonly _data;
+    private readonly state?;
+    /**
+     * Construct a ReadonlyAttachment.
+     *
+     * @param reference The `AttachmentReference` that should be read by the
+     * `ReadonlyAttachment` object.
+     * @param state (Optional) For internal use.
+     * @returns The new `ReadonlyAttachment` object.
+     */
+    constructor(reference: AttachmentReference, state?: BraintrustState);
+    /**
+     * The attachment contents. This is a lazy value that will read the attachment
+     * contents from the object store on first access.
+     */
+    data(): Promise<Blob>;
+    /**
+     * Fetch the attachment upload status. This will re-fetch the status each time
+     * in case it changes over time.
+     */
+    status(): Promise<AttachmentStatus>;
+    private initDownloader;
+    private fetchMetadata;
+}
 /**
  * Update a span using the output of `span.export()`. It is important that you only resume updating
  * to a span once the original span has been fully written and flushed, since otherwise updates to
@@ -1601,6 +1638,8 @@ type braintrust_PromiseUnless<B, R> = PromiseUnless<B, R>;
 type braintrust_Prompt<HasId extends boolean = true, HasVersion extends boolean = true> = Prompt<HasId, HasVersion>;
 declare const braintrust_Prompt: typeof Prompt;
 type braintrust_PromptRowWithId<HasId extends boolean = true, HasVersion extends boolean = true> = PromptRowWithId<HasId, HasVersion>;
+type braintrust_ReadonlyAttachment = ReadonlyAttachment;
+declare const braintrust_ReadonlyAttachment: typeof ReadonlyAttachment;
 type braintrust_ReadonlyExperiment = ReadonlyExperiment;
 declare const braintrust_ReadonlyExperiment: typeof ReadonlyExperiment;
 type braintrust_ScoreSummary = ScoreSummary;
@@ -1652,7 +1691,7 @@ declare const braintrust_wrapOpenAI: typeof wrapOpenAI;
 declare const braintrust_wrapOpenAIv4: typeof wrapOpenAIv4;
 declare const braintrust_wrapTraced: typeof wrapTraced;
 declare namespace braintrust {
-  export { type braintrust_AnyDataset as AnyDataset, braintrust_Attachment as Attachment, type braintrust_AttachmentParams as AttachmentParams, type braintrust_BackgroundLoggerOpts as BackgroundLoggerOpts, type braintrust_BaseMetadata as BaseMetadata, braintrust_BraintrustState as BraintrustState, braintrust_BraintrustStream as BraintrustStream, type braintrust_BraintrustStreamChunk as BraintrustStreamChunk, type braintrust_ChatPrompt as ChatPrompt, type braintrust_CompiledPrompt as CompiledPrompt, type braintrust_CompiledPromptParams as CompiledPromptParams, type braintrust_CompletionPrompt as CompletionPrompt, type braintrust_DataSummary as DataSummary, braintrust_Dataset as Dataset, type braintrust_DatasetSummary as DatasetSummary, type braintrust_DefaultMetadataType as DefaultMetadataType, type braintrust_DefaultPromptArgs as DefaultPromptArgs, type braintrust_EndSpanArgs as EndSpanArgs, type braintrust_EvalCase as EvalCase, braintrust_Experiment as Experiment, type braintrust_ExperimentSummary as ExperimentSummary, type braintrust_Exportable as Exportable, braintrust_FailedHTTPResponse as FailedHTTPResponse, type braintrust_FullInitOptions as FullInitOptions, type braintrust_FullLoginOptions as FullLoginOptions, type braintrust_InitOptions as InitOptions, type braintrust_InvokeFunctionArgs as InvokeFunctionArgs, type braintrust_InvokeReturn as InvokeReturn, braintrust_LEGACY_CACHED_HEADER as LEGACY_CACHED_HEADER, type braintrust_LogOptions as LogOptions, braintrust_Logger as Logger, type braintrust_LoginOptions as LoginOptions, type braintrust_MetricSummary as MetricSummary, braintrust_NOOP_SPAN as NOOP_SPAN, braintrust_NoopSpan as NoopSpan, type braintrust_ObjectMetadata as ObjectMetadata, type braintrust_PromiseUnless as PromiseUnless, braintrust_Prompt as Prompt, type braintrust_PromptRowWithId as PromptRowWithId, braintrust_ReadonlyExperiment as ReadonlyExperiment, type braintrust_ScoreSummary as ScoreSummary, type braintrust_SerializedBraintrustState as SerializedBraintrustState, type braintrust_SetCurrentArg as SetCurrentArg, type braintrust_Span as Span, braintrust_SpanImpl as SpanImpl, type braintrust_StartSpanArgs as StartSpanArgs, type braintrust_WithTransactionId as WithTransactionId, braintrust_X_CACHED_HEADER as X_CACHED_HEADER, braintrust__exportsForTestingOnly as _exportsForTestingOnly, braintrust__internalGetGlobalState as _internalGetGlobalState, braintrust__internalSetInitialState as _internalSetInitialState, braintrust_braintrustStreamChunkSchema as braintrustStreamChunkSchema, braintrust_createFinalValuePassThroughStream as createFinalValuePassThroughStream, braintrust_currentExperiment as currentExperiment, braintrust_currentLogger as currentLogger, braintrust_currentSpan as currentSpan, braintrust_devNullWritableStream as devNullWritableStream, braintrust_flush as flush, braintrust_getSpanParentObject as getSpanParentObject, braintrust_init as init, braintrust_initDataset as initDataset, braintrust_initExperiment as initExperiment, braintrust_initLogger as initLogger, braintrust_invoke as invoke, braintrust_loadPrompt as loadPrompt, braintrust_log as log, braintrust_logError as logError, braintrust_login as login, braintrust_loginToState as loginToState, braintrust_newId as newId, braintrust_parseCachedHeader as parseCachedHeader, braintrust_permalink as permalink, braintrust_renderMessage as renderMessage, braintrust_setFetch as setFetch, braintrust_spanComponentsToObjectId as spanComponentsToObjectId, braintrust_startSpan as startSpan, braintrust_summarize as summarize, braintrust_traceable as traceable, braintrust_traced as traced, braintrust_updateSpan as updateSpan, braintrust_withCurrent as withCurrent, braintrust_withDataset as withDataset, braintrust_withExperiment as withExperiment, braintrust_withLogger as withLogger, braintrust_wrapOpenAI as wrapOpenAI, braintrust_wrapOpenAIv4 as wrapOpenAIv4, braintrust_wrapTraced as wrapTraced };
+  export { type braintrust_AnyDataset as AnyDataset, braintrust_Attachment as Attachment, type braintrust_AttachmentParams as AttachmentParams, type braintrust_BackgroundLoggerOpts as BackgroundLoggerOpts, type braintrust_BaseMetadata as BaseMetadata, braintrust_BraintrustState as BraintrustState, braintrust_BraintrustStream as BraintrustStream, type braintrust_BraintrustStreamChunk as BraintrustStreamChunk, type braintrust_ChatPrompt as ChatPrompt, type braintrust_CompiledPrompt as CompiledPrompt, type braintrust_CompiledPromptParams as CompiledPromptParams, type braintrust_CompletionPrompt as CompletionPrompt, type braintrust_DataSummary as DataSummary, braintrust_Dataset as Dataset, type braintrust_DatasetSummary as DatasetSummary, type braintrust_DefaultMetadataType as DefaultMetadataType, type braintrust_DefaultPromptArgs as DefaultPromptArgs, type braintrust_EndSpanArgs as EndSpanArgs, type braintrust_EvalCase as EvalCase, braintrust_Experiment as Experiment, type braintrust_ExperimentSummary as ExperimentSummary, type braintrust_Exportable as Exportable, braintrust_FailedHTTPResponse as FailedHTTPResponse, type braintrust_FullInitOptions as FullInitOptions, type braintrust_FullLoginOptions as FullLoginOptions, type braintrust_InitOptions as InitOptions, type braintrust_InvokeFunctionArgs as InvokeFunctionArgs, type braintrust_InvokeReturn as InvokeReturn, braintrust_LEGACY_CACHED_HEADER as LEGACY_CACHED_HEADER, type braintrust_LogOptions as LogOptions, braintrust_Logger as Logger, type braintrust_LoginOptions as LoginOptions, type braintrust_MetricSummary as MetricSummary, braintrust_NOOP_SPAN as NOOP_SPAN, braintrust_NoopSpan as NoopSpan, type braintrust_ObjectMetadata as ObjectMetadata, type braintrust_PromiseUnless as PromiseUnless, braintrust_Prompt as Prompt, type braintrust_PromptRowWithId as PromptRowWithId, braintrust_ReadonlyAttachment as ReadonlyAttachment, braintrust_ReadonlyExperiment as ReadonlyExperiment, type braintrust_ScoreSummary as ScoreSummary, type braintrust_SerializedBraintrustState as SerializedBraintrustState, type braintrust_SetCurrentArg as SetCurrentArg, type braintrust_Span as Span, braintrust_SpanImpl as SpanImpl, type braintrust_StartSpanArgs as StartSpanArgs, type braintrust_WithTransactionId as WithTransactionId, braintrust_X_CACHED_HEADER as X_CACHED_HEADER, braintrust__exportsForTestingOnly as _exportsForTestingOnly, braintrust__internalGetGlobalState as _internalGetGlobalState, braintrust__internalSetInitialState as _internalSetInitialState, braintrust_braintrustStreamChunkSchema as braintrustStreamChunkSchema, braintrust_createFinalValuePassThroughStream as createFinalValuePassThroughStream, braintrust_currentExperiment as currentExperiment, braintrust_currentLogger as currentLogger, braintrust_currentSpan as currentSpan, braintrust_devNullWritableStream as devNullWritableStream, braintrust_flush as flush, braintrust_getSpanParentObject as getSpanParentObject, braintrust_init as init, braintrust_initDataset as initDataset, braintrust_initExperiment as initExperiment, braintrust_initLogger as initLogger, braintrust_invoke as invoke, braintrust_loadPrompt as loadPrompt, braintrust_log as log, braintrust_logError as logError, braintrust_login as login, braintrust_loginToState as loginToState, braintrust_newId as newId, braintrust_parseCachedHeader as parseCachedHeader, braintrust_permalink as permalink, braintrust_renderMessage as renderMessage, braintrust_setFetch as setFetch, braintrust_spanComponentsToObjectId as spanComponentsToObjectId, braintrust_startSpan as startSpan, braintrust_summarize as summarize, braintrust_traceable as traceable, braintrust_traced as traced, braintrust_updateSpan as updateSpan, braintrust_withCurrent as withCurrent, braintrust_withDataset as withDataset, braintrust_withExperiment as withExperiment, braintrust_withLogger as withLogger, braintrust_wrapOpenAI as wrapOpenAI, braintrust_wrapOpenAIv4 as wrapOpenAIv4, braintrust_wrapTraced as wrapTraced };
 }
 
-export { type AnyDataset, Attachment, type AttachmentParams, type BackgroundLoggerOpts, type BaseMetadata, BraintrustState, BraintrustStream, type BraintrustStreamChunk, type ChatPrompt, type CompiledPrompt, type CompiledPromptParams, type CompletionPrompt, type DataSummary, Dataset, type DatasetSummary, type DefaultMetadataType, type DefaultPromptArgs, type EndSpanArgs, type EvalCase, Experiment, type ExperimentSummary, type Exportable, FailedHTTPResponse, type FullInitOptions, type FullLoginOptions, type InitOptions, type InvokeFunctionArgs, type InvokeReturn, LEGACY_CACHED_HEADER, type LogOptions, Logger, type LoginOptions, type MetricSummary, NOOP_SPAN, NoopSpan, type ObjectMetadata, type PromiseUnless, Prompt, type PromptRowWithId, ReadonlyExperiment, type ScoreSummary, type SerializedBraintrustState, type SetCurrentArg, type Span, SpanImpl, type StartSpanArgs, type WithTransactionId, X_CACHED_HEADER, _exportsForTestingOnly, _internalGetGlobalState, _internalSetInitialState, braintrustStreamChunkSchema, createFinalValuePassThroughStream, currentExperiment, currentLogger, currentSpan, braintrust as default, devNullWritableStream, flush, getSpanParentObject, init, initDataset, initExperiment, initLogger, invoke, loadPrompt, log, logError, login, loginToState, newId, parseCachedHeader, permalink, renderMessage, setFetch, spanComponentsToObjectId, startSpan, summarize, traceable, traced, updateSpan, withCurrent, withDataset, withExperiment, withLogger, wrapOpenAI, wrapOpenAIv4, wrapTraced };
+export { type AnyDataset, Attachment, type AttachmentParams, type BackgroundLoggerOpts, type BaseMetadata, BraintrustState, BraintrustStream, type BraintrustStreamChunk, type ChatPrompt, type CompiledPrompt, type CompiledPromptParams, type CompletionPrompt, type DataSummary, Dataset, type DatasetSummary, type DefaultMetadataType, type DefaultPromptArgs, type EndSpanArgs, type EvalCase, Experiment, type ExperimentSummary, type Exportable, FailedHTTPResponse, type FullInitOptions, type FullLoginOptions, type InitOptions, type InvokeFunctionArgs, type InvokeReturn, LEGACY_CACHED_HEADER, type LogOptions, Logger, type LoginOptions, type MetricSummary, NOOP_SPAN, NoopSpan, type ObjectMetadata, type PromiseUnless, Prompt, type PromptRowWithId, ReadonlyAttachment, ReadonlyExperiment, type ScoreSummary, type SerializedBraintrustState, type SetCurrentArg, type Span, SpanImpl, type StartSpanArgs, type WithTransactionId, X_CACHED_HEADER, _exportsForTestingOnly, _internalGetGlobalState, _internalSetInitialState, braintrustStreamChunkSchema, createFinalValuePassThroughStream, currentExperiment, currentLogger, currentSpan, braintrust as default, devNullWritableStream, flush, getSpanParentObject, init, initDataset, initExperiment, initLogger, invoke, loadPrompt, log, logError, login, loginToState, newId, parseCachedHeader, permalink, renderMessage, setFetch, spanComponentsToObjectId, startSpan, summarize, traceable, traced, updateSpan, withCurrent, withDataset, withExperiment, withLogger, wrapOpenAI, wrapOpenAIv4, wrapTraced };

package/dist/browser.js

@@ -41,6 +41,7 @@ __export(browser_exports, {
   NOOP_SPAN: () => NOOP_SPAN,
   NoopSpan: () => NoopSpan,
   Prompt: () => Prompt,
+  ReadonlyAttachment: () => ReadonlyAttachment,
   ReadonlyExperiment: () => ReadonlyExperiment,
   SpanImpl: () => SpanImpl,
   X_CACHED_HEADER: () => X_CACHED_HEADER,
@@ -801,17 +802,19 @@ var Attachment = class {
   /**
    * Construct an attachment.
    *
-   * @param data A string representing the path of the file on disk, or a
+   * @param param A parameter object with:
+   *
+   * `data`: A string representing the path of the file on disk, or a
    * `Blob`/`ArrayBuffer` with the file's contents. The caller is responsible
    * for ensuring the file/blob/buffer is not modified until upload is complete.
    *
-   * @param filename The desired name of the file in Braintrust after uploading.
+   * `filename`: The desired name of the file in Braintrust after uploading.
    * This parameter is for visualization purposes only and has no effect on
    * attachment storage.
    *
-   * @param contentType The MIME type of the file.
+   * `contentType`: The MIME type of the file.
    *
-   * @param state (Optional) For internal use.
+   * `state`: (Optional) For internal use.
    */
   constructor({ data, filename, contentType, state }) {
     this.reference = {
@@ -955,6 +958,77 @@ with a Blob/ArrayBuffer, or run the program on Node.js.`
     }
   }
 };
+var attachmentMetadataSchema = import_zod2.z.object({
+  downloadUrl: import_zod2.z.string(),
+  status: import_typespecs2.attachmentStatusSchema
+});
+var ReadonlyAttachment = class {
+  /**
+   * Attachment metadata.
+   */
+  reference;
+  _data;
+  state;
+  /**
+   * Construct a ReadonlyAttachment.
+   *
+   * @param reference The `AttachmentReference` that should be read by the
+   * `ReadonlyAttachment` object.
+   * @param state (Optional) For internal use.
+   * @returns The new `ReadonlyAttachment` object.
+   */
+  constructor(reference, state) {
+    this.reference = reference;
+    this.state = state;
+    this._data = this.initDownloader();
+  }
+  /**
+   * The attachment contents. This is a lazy value that will read the attachment
+   * contents from the object store on first access.
+   */
+  async data() {
+    return this._data.get();
+  }
+  /**
+   * Fetch the attachment upload status. This will re-fetch the status each time
+   * in case it changes over time.
+   */
+  async status() {
+    return (await this.fetchMetadata()).status;
+  }
+  initDownloader() {
+    const download = async () => {
+      const { downloadUrl, status } = await this.fetchMetadata();
+      if (status.upload_status !== "done") {
+        throw new Error(
+          `Expected attachment status "done", got "${status.upload_status}"`
+        );
+      }
+      const objResponse = await fetch(downloadUrl);
+      if (objResponse.status !== 200) {
+        const error = await objResponse.text();
+        throw new Error(`Couldn't download attachment: ${error}`);
+      }
+      return await objResponse.blob();
+    };
+    return new LazyValue(download);
+  }
+  async fetchMetadata() {
+    const state = this.state ?? _globalState;
+    await state.login({});
+    const resp = await state.apiConn().get("/attachment", {
+      key: this.reference.key,
+      filename: this.reference.filename,
+      content_type: this.reference.content_type,
+      org_id: state.orgId || ""
+    });
+    if (!resp.ok) {
+      const errorStr = JSON.stringify(resp);
+      throw new Error(`Invalid response from API server: ${errorStr}`);
+    }
+    return attachmentMetadataSchema.parse(await resp.json());
+  }
+};
 function logFeedbackImpl(state, parentObjectType, parentObjectId, {
   id,
   expected,
@@ -2496,6 +2570,20 @@ function extractAttachments(event, attachments) {
     extractAttachments(value, attachments);
   }
 }
+function enrichAttachments(event) {
+  for (const [key, value] of Object.entries(event)) {
+    const parsedValue = import_typespecs2.attachmentReferenceSchema.safeParse(value);
+    if (parsedValue.success) {
+      event[key] = new ReadonlyAttachment(parsedValue.data);
+      continue;
+    }
+    if (!(value instanceof Object)) {
+      continue;
+    }
+    enrichAttachments(value);
+  }
+  return event;
+}
 function validateAndSanitizeExperimentLogFullArgs(event, hasDataset) {
   if ("input" in event && !isEmpty(event.input) && "inputs" in event && !isEmpty(event.inputs) || !("input" in event) && !("inputs" in event)) {
     throw new Error(
@@ -2583,7 +2671,7 @@ var Experiment = class extends ObjectFetcher {
   // For type identification.
   kind = "experiment";
   constructor(state, lazyMetadata, dataset) {
-    super("experiment", void 0);
+    super("experiment", void 0, enrichAttachments);
     this.lazyMetadata = lazyMetadata;
     this.dataset = dataset;
     this.lastStartTime = getCurrentUnixTimestamp();
@@ -2826,7 +2914,7 @@ var Experiment = class extends ObjectFetcher {
 };
 var ReadonlyExperiment = class extends ObjectFetcher {
   constructor(state, lazyMetadata) {
-    super("experiment", void 0);
+    super("experiment", void 0, enrichAttachments);
     this.state = state;
     this.lazyMetadata = lazyMetadata;
   }
@@ -3103,7 +3191,7 @@ var Dataset = class extends ObjectFetcher {
     super(
       "dataset",
       pinnedVersion,
-      (r) => (0, import_core.ensureDatasetRecord)(r, isLegacyDataset)
+      (r) => (0, import_core.ensureDatasetRecord)(enrichAttachments(r), isLegacyDataset)
     );
     this.state = state;
     this.lazyMetadata = lazyMetadata;
@@ -3505,6 +3593,7 @@ __export(exports_browser_exports, {
   NOOP_SPAN: () => NOOP_SPAN,
   NoopSpan: () => NoopSpan,
   Prompt: () => Prompt,
+  ReadonlyAttachment: () => ReadonlyAttachment,
   ReadonlyExperiment: () => ReadonlyExperiment,
   SpanImpl: () => SpanImpl,
   X_CACHED_HEADER: () => X_CACHED_HEADER,
@@ -4012,6 +4101,7 @@ var browser_default = exports_browser_exports;
   NOOP_SPAN,
   NoopSpan,
   Prompt,
+  ReadonlyAttachment,
   ReadonlyExperiment,
   SpanImpl,
   X_CACHED_HEADER,

package/dist/browser.mjs

@@ -56,7 +56,9 @@ import {
   promptSchema,
   toolsSchema,
   gitMetadataSettingsSchema,
-  BRAINTRUST_ATTACHMENT
+  BRAINTRUST_ATTACHMENT,
+  attachmentStatusSchema,
+  attachmentReferenceSchema
 } from "@braintrust/core/typespecs";
 
 // src/util.ts
@@ -750,17 +752,19 @@ var Attachment = class {
   /**
    * Construct an attachment.
    *
-   * @param data A string representing the path of the file on disk, or a
+   * @param param A parameter object with:
+   *
+   * `data`: A string representing the path of the file on disk, or a
    * `Blob`/`ArrayBuffer` with the file's contents. The caller is responsible
    * for ensuring the file/blob/buffer is not modified until upload is complete.
    *
-   * @param filename The desired name of the file in Braintrust after uploading.
+   * `filename`: The desired name of the file in Braintrust after uploading.
    * This parameter is for visualization purposes only and has no effect on
    * attachment storage.
    *
-   * @param contentType The MIME type of the file.
+   * `contentType`: The MIME type of the file.
    *
-   * @param state (Optional) For internal use.
+   * `state`: (Optional) For internal use.
    */
   constructor({ data, filename, contentType, state }) {
     this.reference = {
@@ -904,6 +908,77 @@ with a Blob/ArrayBuffer, or run the program on Node.js.`
     }
   }
 };
+var attachmentMetadataSchema = z2.object({
+  downloadUrl: z2.string(),
+  status: attachmentStatusSchema
+});
+var ReadonlyAttachment = class {
+  /**
+   * Attachment metadata.
+   */
+  reference;
+  _data;
+  state;
+  /**
+   * Construct a ReadonlyAttachment.
+   *
+   * @param reference The `AttachmentReference` that should be read by the
+   * `ReadonlyAttachment` object.
+   * @param state (Optional) For internal use.
+   * @returns The new `ReadonlyAttachment` object.
+   */
+  constructor(reference, state) {
+    this.reference = reference;
+    this.state = state;
+    this._data = this.initDownloader();
+  }
+  /**
+   * The attachment contents. This is a lazy value that will read the attachment
+   * contents from the object store on first access.
+   */
+  async data() {
+    return this._data.get();
+  }
+  /**
+   * Fetch the attachment upload status. This will re-fetch the status each time
+   * in case it changes over time.
+   */
+  async status() {
+    return (await this.fetchMetadata()).status;
+  }
+  initDownloader() {
+    const download = async () => {
+      const { downloadUrl, status } = await this.fetchMetadata();
+      if (status.upload_status !== "done") {
+        throw new Error(
+          `Expected attachment status "done", got "${status.upload_status}"`
+        );
+      }
+      const objResponse = await fetch(downloadUrl);
+      if (objResponse.status !== 200) {
+        const error = await objResponse.text();
+        throw new Error(`Couldn't download attachment: ${error}`);
+      }
+      return await objResponse.blob();
+    };
+    return new LazyValue(download);
+  }
+  async fetchMetadata() {
+    const state = this.state ?? _globalState;
+    await state.login({});
+    const resp = await state.apiConn().get("/attachment", {
+      key: this.reference.key,
+      filename: this.reference.filename,
+      content_type: this.reference.content_type,
+      org_id: state.orgId || ""
+    });
+    if (!resp.ok) {
+      const errorStr = JSON.stringify(resp);
+      throw new Error(`Invalid response from API server: ${errorStr}`);
+    }
+    return attachmentMetadataSchema.parse(await resp.json());
+  }
+};
 function logFeedbackImpl(state, parentObjectType, parentObjectId, {
   id,
   expected,
@@ -2445,6 +2520,20 @@ function extractAttachments(event, attachments) {
     extractAttachments(value, attachments);
   }
 }
+function enrichAttachments(event) {
+  for (const [key, value] of Object.entries(event)) {
+    const parsedValue = attachmentReferenceSchema.safeParse(value);
+    if (parsedValue.success) {
+      event[key] = new ReadonlyAttachment(parsedValue.data);
+      continue;
+    }
+    if (!(value instanceof Object)) {
+      continue;
+    }
+    enrichAttachments(value);
+  }
+  return event;
+}
 function validateAndSanitizeExperimentLogFullArgs(event, hasDataset) {
   if ("input" in event && !isEmpty(event.input) && "inputs" in event && !isEmpty(event.inputs) || !("input" in event) && !("inputs" in event)) {
     throw new Error(
@@ -2532,7 +2621,7 @@ var Experiment = class extends ObjectFetcher {
   // For type identification.
   kind = "experiment";
   constructor(state, lazyMetadata, dataset) {
-    super("experiment", void 0);
+    super("experiment", void 0, enrichAttachments);
     this.lazyMetadata = lazyMetadata;
     this.dataset = dataset;
     this.lastStartTime = getCurrentUnixTimestamp();
@@ -2775,7 +2864,7 @@ var Experiment = class extends ObjectFetcher {
 };
 var ReadonlyExperiment = class extends ObjectFetcher {
   constructor(state, lazyMetadata) {
-    super("experiment", void 0);
+    super("experiment", void 0, enrichAttachments);
     this.state = state;
     this.lazyMetadata = lazyMetadata;
   }
@@ -3052,7 +3141,7 @@ var Dataset = class extends ObjectFetcher {
     super(
       "dataset",
       pinnedVersion,
-      (r) => ensureDatasetRecord(r, isLegacyDataset)
+      (r) => ensureDatasetRecord(enrichAttachments(r), isLegacyDataset)
     );
     this.state = state;
     this.lazyMetadata = lazyMetadata;
@@ -3454,6 +3543,7 @@ __export(exports_browser_exports, {
   NOOP_SPAN: () => NOOP_SPAN,
   NoopSpan: () => NoopSpan,
   Prompt: () => Prompt,
+  ReadonlyAttachment: () => ReadonlyAttachment,
   ReadonlyExperiment: () => ReadonlyExperiment,
   SpanImpl: () => SpanImpl,
   X_CACHED_HEADER: () => X_CACHED_HEADER,
@@ -3962,6 +4052,7 @@ export {
   NOOP_SPAN,
   NoopSpan,
   Prompt,
+  ReadonlyAttachment,
   ReadonlyExperiment,
   SpanImpl,
   X_CACHED_HEADER,