braintrust 0.0.145 → 0.0.147

package/dist/index.js

@@ -74,6 +74,7 @@ __export(src_exports, {
   summarize: () => summarize,
   traceable: () => traceable,
   traced: () => traced,
+  updateSpan: () => updateSpan,
   withDataset: () => withDataset,
   withExperiment: () => withExperiment,
   withLogger: () => withLogger,
@@ -420,6 +421,33 @@ var BraintrustStream = class _BraintrustStream {
   toReadableStream() {
     return this.stream;
   }
+  /**
+   * Returns an async iterator for the BraintrustStream.
+   * This allows for easy consumption of the stream using a for-await...of loop.
+   *
+   * @returns An async iterator that yields BraintrustStreamChunk objects.
+   */
+  [Symbol.asyncIterator]() {
+    const reader = this.stream.getReader();
+    return {
+      async next() {
+        const { done, value } = await reader.read();
+        if (done) {
+          reader.releaseLock();
+          return { done: true, value: void 0 };
+        }
+        return { done: false, value };
+      },
+      async return() {
+        reader.releaseLock();
+        return { done: true, value: void 0 };
+      },
+      async throw(error2) {
+        reader.releaseLock();
+        throw error2;
+      }
+    };
+  }
   /**
    * Get the final value of the stream. The final value is the concatenation of all
    * the chunks in the stream, deserialized into a string or JSON object, depending on
@@ -708,8 +736,10 @@ var BraintrustState = class _BraintrustState {
     state.apiConn().set_token(state.loginToken);
     state.apiConn().make_long_lived();
     state.appConn().set_token(state.loginToken);
-    state.proxyConn().make_long_lived();
-    state.proxyConn().set_token(state.loginToken);
+    if (state.proxyUrl) {
+      state.proxyConn().make_long_lived();
+      state.proxyConn().set_token(state.loginToken);
+    }
     state.loggedIn = true;
     state.loginReplaceApiConn(state.apiConn());
     return state;
@@ -749,6 +779,9 @@ var BraintrustState = class _BraintrustState {
     return this._apiConn;
   }
   proxyConn() {
+    if (!this.proxyUrl) {
+      return this.apiConn();
+    }
     if (!this._proxyConn) {
       if (!this.proxyUrl) {
         throw new Error("Must initialize proxyUrl before requesting proxyConn");
@@ -966,6 +999,41 @@ function logFeedbackImpl(state, parentObjectType, parentObjectId, {
     state.bgLogger().log([record]);
   }
 }
+function updateSpanImpl(state, parentObjectType, parentObjectId, id, event) {
+  const updateEvent = validateAndSanitizeExperimentLogPartialArgs({
+    id,
+    ...event
+  });
+  const parentIds = async () => new import_core.SpanComponentsV2({
+    objectType: parentObjectType,
+    objectId: await parentObjectId.get()
+  }).objectIdFields();
+  const record = new LazyValue(async () => ({
+    id,
+    ...updateEvent,
+    ...await parentIds(),
+    [import_core.IS_MERGE_FIELD]: true
+  }));
+  state.bgLogger().log([record]);
+}
+function updateSpan({
+  exported,
+  state,
+  ...event
+}) {
+  const resolvedState = state ?? _globalState;
+  const components = import_core.SpanComponentsV2.fromStr(exported);
+  if (!components.rowIds?.rowId) {
+    throw new Error("Exported span must have a row id");
+  }
+  updateSpanImpl(
+    resolvedState,
+    components.objectType,
+    new LazyValue(spanComponentsToObjectIdLambda(resolvedState, components)),
+    components.rowIds?.rowId,
+    event
+  );
+}
 function spanComponentsToObjectIdLambda(state, components) {
   if (components.objectId) {
     const ret = components.objectId;
@@ -1170,6 +1238,25 @@ var Logger = class {
   logFeedback(event) {
     logFeedbackImpl(this.state, this.parentObjectType(), this.lazyId, event);
   }
+  /**
+   * Update a span in the experiment using its id. It is important that you only update a span once the original span has been fully written and flushed,
+   * since otherwise updates to the span may conflict with the original span.
+   *
+   * @param event The event data to update the span with. Must include `id`. See `Experiment.log` for a full list of valid fields.
+   */
+  updateSpan(event) {
+    const { id, ...eventRest } = event;
+    if (!id) {
+      throw new Error("Span id is required to update a span");
+    }
+    updateSpanImpl(
+      this.state,
+      this.parentObjectType(),
+      this.lazyId,
+      id,
+      eventRest
+    );
+  }
   /**
    * Return a serialized representation of the logger that can be used to start subspans in other places. See `Span.start_span` for more details.
    */
@@ -1889,7 +1976,7 @@ async function loadPrompt({
     throw new Error("Must specify slug");
   }
   const state = stateArg ?? _globalState;
-  state.login({
+  await state.login({
     orgName,
     apiKey,
     appUrl,
@@ -1976,7 +2063,9 @@ async function loginToState(options = {}) {
   }
   conn.make_long_lived();
   state.appConn().set_token(apiKey);
-  state.proxyConn().set_token(apiKey);
+  if (state.proxyUrl) {
+    state.proxyConn().set_token(apiKey);
+  }
   state.loginToken = conn.token;
   state.loggedIn = true;
   state.loginReplaceApiConn(conn);
@@ -2507,6 +2596,25 @@ var Experiment = class extends ObjectFetcher {
   logFeedback(event) {
     logFeedbackImpl(this.state, this.parentObjectType(), this.lazyId, event);
   }
+  /**
+   * Update a span in the experiment using its id. It is important that you only update a span once the original span has been fully written and flushed,
+   * since otherwise updates to the span may conflict with the original span.
+   *
+   * @param event The event data to update the span with. Must include `id`. See `Experiment.log` for a full list of valid fields.
+   */
+  updateSpan(event) {
+    const { id, ...eventRest } = event;
+    if (!id) {
+      throw new Error("Span id is required to update a span");
+    }
+    updateSpanImpl(
+      this.state,
+      this.parentObjectType(),
+      this.lazyId,
+      id,
+      eventRest
+    );
+  }
   /**
    * Return a serialized representation of the experiment that can be used to start subspans in other places. See `Span.start_span` for more details.
    */
@@ -3117,7 +3225,14 @@ async function invoke(args) {
     forceLogin
   });
   const parent = parentArg ? typeof parentArg === "string" ? parentArg : await parentArg.export() : await getSpanParentObject().export();
-  const functionId = import_typespecs3.functionIdSchema.safeParse(functionIdArgs);
+  const functionId = import_typespecs3.functionIdSchema.safeParse({
+    project_name: functionIdArgs.projectName,
+    slug: functionIdArgs.slug,
+    global_function: functionIdArgs.globalFunction,
+    prompt_session_id: functionIdArgs.promptSessionId,
+    prompt_session_function_id: functionIdArgs.promptSessionFunctionId,
+    version: functionIdArgs.version
+  });
   if (!functionId.success) {
     throw new Error(
       `Invalid function ID arguments: ${functionId.error.message}`
@@ -3127,8 +3242,7 @@ async function invoke(args) {
     ...functionId.data,
     input,
     parent,
-    stream,
-    api_version: import_typespecs3.INVOKE_API_VERSION
+    stream
   };
   const resp = await state.proxyConn().post(`function/invoke`, request, {
     headers: {
@@ -4297,6 +4411,24 @@ var waterfall$1 = awaitify(waterfall);
 function BaseExperiment(options = {}) {
   return { _type: "BaseExperiment", ...options };
 }
+var EvalResultWithSummary = class {
+  constructor(summary, results) {
+    this.summary = summary;
+    this.results = results;
+  }
+  toString() {
+    return formatExperimentSummary(this.summary);
+  }
+  [Symbol.for("nodejs.util.inspect.custom")]() {
+    return `EvalResultWithSummary(summary="...", results=[...])`;
+  }
+  toJSON() {
+    return {
+      summary: this.summary,
+      results: this.results
+    };
+  }
+};
 function makeEvalName(projectName, experimentName) {
   let out = projectName;
   if (experimentName) {
@@ -4311,6 +4443,17 @@ function initExperiment2(state, options = {}) {
     setCurrent: false
   });
 }
+function callEvaluatorData(data) {
+  let dataResult = typeof data === "function" ? data() : data;
+  let baseExperiment = void 0;
+  if ("_type" in dataResult && dataResult._type === "BaseExperiment") {
+    baseExperiment = dataResult.name;
+  }
+  return {
+    data: dataResult,
+    baseExperiment
+  };
+}
 globalThis._evals = {
   evaluators: {},
   reporters: {}
@@ -4327,15 +4470,15 @@ async function Eval(name, evaluator, reporterOrOpts) {
       reporter: options.reporter
     };
     globalThis._spanContext = { currentSpan, NOOP_SPAN };
-    return {
-      summary: {
+    return new EvalResultWithSummary(
+      {
         scores: {},
         metrics: {},
         projectName: "",
         experimentName: ""
       },
-      results: []
-    };
+      []
+    );
   }
   const progressReporter = new BarProgressReporter();
   if (typeof options.reporter === "string") {
@@ -4345,12 +4488,14 @@ async function Eval(name, evaluator, reporterOrOpts) {
   }
   const resolvedReporter = options.reporter || defaultReporter;
   try {
+    const { data, baseExperiment } = callEvaluatorData(evaluator.data);
     const experiment = initExperiment2(evaluator.state, {
       ...evaluator.projectId ? { projectId: evaluator.projectId } : { project: name },
       experiment: evaluator.experimentName,
       metadata: evaluator.metadata,
       isPublic: evaluator.isPublic,
-      update: evaluator.update
+      update: evaluator.update,
+      baseExperiment
     });
     if (options.onStart) {
       experiment.summarize({ summarizeScores: false }).then(options.onStart);
@@ -4359,7 +4504,8 @@ async function Eval(name, evaluator, reporterOrOpts) {
       const evalDef = {
         evalName,
         projectName: name,
-        ...evaluator
+        ...evaluator,
+        data
       };
       const ret = await runEvaluator(experiment, evalDef, progressReporter, []);
       progressReporter.stop();
@@ -4634,10 +4780,7 @@ async function runEvaluatorInternal(experiment, evaluator, progressReporter, fil
   q.push(data);
   await q.drain();
   const summary = experiment ? await experiment.summarize() : buildLocalSummary(evaluator, results);
-  return {
-    summary,
-    results
-  };
+  return new EvalResultWithSummary(summary, results);
 }
 var error = import_chalk.default.bold.red;
 var warning = import_chalk.default.hex("#FFA500");
@@ -5332,6 +5475,7 @@ configureNode();
   summarize,
   traceable,
   traced,
+  updateSpan,
   withDataset,
   withExperiment,
   withLogger,

package/dist/index.mjs

@@ -360,6 +360,33 @@ var BraintrustStream = class _BraintrustStream {
   toReadableStream() {
     return this.stream;
   }
+  /**
+   * Returns an async iterator for the BraintrustStream.
+   * This allows for easy consumption of the stream using a for-await...of loop.
+   *
+   * @returns An async iterator that yields BraintrustStreamChunk objects.
+   */
+  [Symbol.asyncIterator]() {
+    const reader = this.stream.getReader();
+    return {
+      async next() {
+        const { done, value } = await reader.read();
+        if (done) {
+          reader.releaseLock();
+          return { done: true, value: void 0 };
+        }
+        return { done: false, value };
+      },
+      async return() {
+        reader.releaseLock();
+        return { done: true, value: void 0 };
+      },
+      async throw(error2) {
+        reader.releaseLock();
+        throw error2;
+      }
+    };
+  }
   /**
    * Get the final value of the stream. The final value is the concatenation of all
    * the chunks in the stream, deserialized into a string or JSON object, depending on
@@ -648,8 +675,10 @@ var BraintrustState = class _BraintrustState {
     state.apiConn().set_token(state.loginToken);
     state.apiConn().make_long_lived();
     state.appConn().set_token(state.loginToken);
-    state.proxyConn().make_long_lived();
-    state.proxyConn().set_token(state.loginToken);
+    if (state.proxyUrl) {
+      state.proxyConn().make_long_lived();
+      state.proxyConn().set_token(state.loginToken);
+    }
     state.loggedIn = true;
     state.loginReplaceApiConn(state.apiConn());
     return state;
@@ -689,6 +718,9 @@ var BraintrustState = class _BraintrustState {
     return this._apiConn;
   }
   proxyConn() {
+    if (!this.proxyUrl) {
+      return this.apiConn();
+    }
     if (!this._proxyConn) {
       if (!this.proxyUrl) {
         throw new Error("Must initialize proxyUrl before requesting proxyConn");
@@ -906,6 +938,41 @@ function logFeedbackImpl(state, parentObjectType, parentObjectId, {
     state.bgLogger().log([record]);
   }
 }
+function updateSpanImpl(state, parentObjectType, parentObjectId, id, event) {
+  const updateEvent = validateAndSanitizeExperimentLogPartialArgs({
+    id,
+    ...event
+  });
+  const parentIds = async () => new SpanComponentsV2({
+    objectType: parentObjectType,
+    objectId: await parentObjectId.get()
+  }).objectIdFields();
+  const record = new LazyValue(async () => ({
+    id,
+    ...updateEvent,
+    ...await parentIds(),
+    [IS_MERGE_FIELD]: true
+  }));
+  state.bgLogger().log([record]);
+}
+function updateSpan({
+  exported,
+  state,
+  ...event
+}) {
+  const resolvedState = state ?? _globalState;
+  const components = SpanComponentsV2.fromStr(exported);
+  if (!components.rowIds?.rowId) {
+    throw new Error("Exported span must have a row id");
+  }
+  updateSpanImpl(
+    resolvedState,
+    components.objectType,
+    new LazyValue(spanComponentsToObjectIdLambda(resolvedState, components)),
+    components.rowIds?.rowId,
+    event
+  );
+}
 function spanComponentsToObjectIdLambda(state, components) {
   if (components.objectId) {
     const ret = components.objectId;
@@ -1110,6 +1177,25 @@ var Logger = class {
   logFeedback(event) {
     logFeedbackImpl(this.state, this.parentObjectType(), this.lazyId, event);
   }
+  /**
+   * Update a span in the experiment using its id. It is important that you only update a span once the original span has been fully written and flushed,
+   * since otherwise updates to the span may conflict with the original span.
+   *
+   * @param event The event data to update the span with. Must include `id`. See `Experiment.log` for a full list of valid fields.
+   */
+  updateSpan(event) {
+    const { id, ...eventRest } = event;
+    if (!id) {
+      throw new Error("Span id is required to update a span");
+    }
+    updateSpanImpl(
+      this.state,
+      this.parentObjectType(),
+      this.lazyId,
+      id,
+      eventRest
+    );
+  }
   /**
    * Return a serialized representation of the logger that can be used to start subspans in other places. See `Span.start_span` for more details.
    */
@@ -1829,7 +1915,7 @@ async function loadPrompt({
     throw new Error("Must specify slug");
   }
   const state = stateArg ?? _globalState;
-  state.login({
+  await state.login({
     orgName,
     apiKey,
     appUrl,
@@ -1916,7 +2002,9 @@ async function loginToState(options = {}) {
   }
   conn.make_long_lived();
   state.appConn().set_token(apiKey);
-  state.proxyConn().set_token(apiKey);
+  if (state.proxyUrl) {
+    state.proxyConn().set_token(apiKey);
+  }
   state.loginToken = conn.token;
   state.loggedIn = true;
   state.loginReplaceApiConn(conn);
@@ -2447,6 +2535,25 @@ var Experiment = class extends ObjectFetcher {
   logFeedback(event) {
     logFeedbackImpl(this.state, this.parentObjectType(), this.lazyId, event);
   }
+  /**
+   * Update a span in the experiment using its id. It is important that you only update a span once the original span has been fully written and flushed,
+   * since otherwise updates to the span may conflict with the original span.
+   *
+   * @param event The event data to update the span with. Must include `id`. See `Experiment.log` for a full list of valid fields.
+   */
+  updateSpan(event) {
+    const { id, ...eventRest } = event;
+    if (!id) {
+      throw new Error("Span id is required to update a span");
+    }
+    updateSpanImpl(
+      this.state,
+      this.parentObjectType(),
+      this.lazyId,
+      id,
+      eventRest
+    );
+  }
   /**
    * Return a serialized representation of the experiment that can be used to start subspans in other places. See `Span.start_span` for more details.
    */
@@ -3035,7 +3142,6 @@ function configureNode() {
 
 // src/functions/invoke.ts
 import {
-  INVOKE_API_VERSION,
   functionIdSchema
 } from "@braintrust/core/typespecs";
 async function invoke(args) {
@@ -3060,7 +3166,14 @@ async function invoke(args) {
     forceLogin
   });
   const parent = parentArg ? typeof parentArg === "string" ? parentArg : await parentArg.export() : await getSpanParentObject().export();
-  const functionId = functionIdSchema.safeParse(functionIdArgs);
+  const functionId = functionIdSchema.safeParse({
+    project_name: functionIdArgs.projectName,
+    slug: functionIdArgs.slug,
+    global_function: functionIdArgs.globalFunction,
+    prompt_session_id: functionIdArgs.promptSessionId,
+    prompt_session_function_id: functionIdArgs.promptSessionFunctionId,
+    version: functionIdArgs.version
+  });
   if (!functionId.success) {
     throw new Error(
       `Invalid function ID arguments: ${functionId.error.message}`
@@ -3070,8 +3183,7 @@ async function invoke(args) {
     ...functionId.data,
     input,
     parent,
-    stream,
-    api_version: INVOKE_API_VERSION
+    stream
   };
   const resp = await state.proxyConn().post(`function/invoke`, request, {
     headers: {
@@ -4240,6 +4352,24 @@ var waterfall$1 = awaitify(waterfall);
 function BaseExperiment(options = {}) {
   return { _type: "BaseExperiment", ...options };
 }
+var EvalResultWithSummary = class {
+  constructor(summary, results) {
+    this.summary = summary;
+    this.results = results;
+  }
+  toString() {
+    return formatExperimentSummary(this.summary);
+  }
+  [Symbol.for("nodejs.util.inspect.custom")]() {
+    return `EvalResultWithSummary(summary="...", results=[...])`;
+  }
+  toJSON() {
+    return {
+      summary: this.summary,
+      results: this.results
+    };
+  }
+};
 function makeEvalName(projectName, experimentName) {
   let out = projectName;
   if (experimentName) {
@@ -4254,6 +4384,17 @@ function initExperiment2(state, options = {}) {
     setCurrent: false
   });
 }
+function callEvaluatorData(data) {
+  let dataResult = typeof data === "function" ? data() : data;
+  let baseExperiment = void 0;
+  if ("_type" in dataResult && dataResult._type === "BaseExperiment") {
+    baseExperiment = dataResult.name;
+  }
+  return {
+    data: dataResult,
+    baseExperiment
+  };
+}
 globalThis._evals = {
   evaluators: {},
   reporters: {}
@@ -4270,15 +4411,15 @@ async function Eval(name, evaluator, reporterOrOpts) {
       reporter: options.reporter
     };
     globalThis._spanContext = { currentSpan, NOOP_SPAN };
-    return {
-      summary: {
+    return new EvalResultWithSummary(
+      {
         scores: {},
         metrics: {},
         projectName: "",
         experimentName: ""
       },
-      results: []
-    };
+      []
+    );
   }
   const progressReporter = new BarProgressReporter();
   if (typeof options.reporter === "string") {
@@ -4288,12 +4429,14 @@ async function Eval(name, evaluator, reporterOrOpts) {
   }
   const resolvedReporter = options.reporter || defaultReporter;
   try {
+    const { data, baseExperiment } = callEvaluatorData(evaluator.data);
     const experiment = initExperiment2(evaluator.state, {
       ...evaluator.projectId ? { projectId: evaluator.projectId } : { project: name },
       experiment: evaluator.experimentName,
       metadata: evaluator.metadata,
       isPublic: evaluator.isPublic,
-      update: evaluator.update
+      update: evaluator.update,
+      baseExperiment
     });
     if (options.onStart) {
       experiment.summarize({ summarizeScores: false }).then(options.onStart);
@@ -4302,7 +4445,8 @@ async function Eval(name, evaluator, reporterOrOpts) {
       const evalDef = {
         evalName,
         projectName: name,
-        ...evaluator
+        ...evaluator,
+        data
       };
       const ret = await runEvaluator(experiment, evalDef, progressReporter, []);
       progressReporter.stop();
@@ -4577,10 +4721,7 @@ async function runEvaluatorInternal(experiment, evaluator, progressReporter, fil
   q.push(data);
   await q.drain();
   const summary = experiment ? await experiment.summarize() : buildLocalSummary(evaluator, results);
-  return {
-    summary,
-    results
-  };
+  return new EvalResultWithSummary(summary, results);
 }
 var error = chalk.bold.red;
 var warning = chalk.hex("#FFA500");
@@ -5274,6 +5415,7 @@ export {
   summarize,
   traceable,
   traced,
+  updateSpan,
   withDataset,
   withExperiment,
   withLogger,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "braintrust",
-  "version": "0.0.145",
+  "version": "0.0.147",
   "description": "SDK for integrating Braintrust",
   "repository": {
     "type": "git",
@@ -70,7 +70,7 @@
   },
   "dependencies": {
     "@ai-sdk/provider": "^0.0.11",
-    "@braintrust/core": "0.0.46",
+    "@braintrust/core": "0.0.48",
     "@next/env": "^14.2.3",
     "@vercel/functions": "^1.0.2",
     "ai": "^3.2.16",