braintrust 0.4.10 → 1.0.0-rc.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Braintrust Data LLC
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,5 +1,15 @@
 An isomorphic JS library for logging data to Braintrust.
 
+## Version information
+
+This SDK has two active version lines:
+
+- **1.x** (developed on the `js-1.x` branch): The latest major release with improved ESM support. OpenTelemetry integration is now available via the separate [`@braintrust/otel`](https://www.npmjs.com/package/@braintrust/otel) package.
+
+- **0.4.x** (developed on the `main` branch): The previous version line, available for backward compatibility. Once 1.x is stable, it will be promoted to the `main` branch.
+
+**Recommendation**: Use the latest 1.x release. If you encounter any issues, please reach out to [support@braintrust.dev](mailto:support@braintrust.dev).
+
 ### Quickstart
 
 Install the library with npm (or yarn).

package/dev/dist/index.d.mts

@@ -198,6 +198,74 @@ interface NewDatasetRecord {
 }
 type DatasetRecord<IsLegacyDataset extends boolean = typeof DEFAULT_IS_LEGACY_DATASET> = IsLegacyDataset extends true ? LegacyDatasetRecord : NewDatasetRecord;
 
+declare enum SpanObjectTypeV3 {
+    EXPERIMENT = 1,
+    PROJECT_LOGS = 2,
+    PLAYGROUND_LOGS = 3
+}
+declare const spanComponentsV3Schema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    object_type: z.ZodNativeEnum<typeof SpanObjectTypeV3>;
+    propagated_event: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, "strip", z.ZodTypeAny, {
+    object_type: SpanObjectTypeV3;
+    propagated_event?: Record<string, unknown> | null | undefined;
+}, {
+    object_type: SpanObjectTypeV3;
+    propagated_event?: Record<string, unknown> | null | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    object_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    compute_object_metadata_args: z.ZodOptional<z.ZodNull>;
+}, "strip", z.ZodTypeAny, {
+    object_id?: string | null | undefined;
+    compute_object_metadata_args?: null | undefined;
+}, {
+    object_id?: string | null | undefined;
+    compute_object_metadata_args?: null | undefined;
+}>, z.ZodObject<{
+    object_id: z.ZodOptional<z.ZodNull>;
+    compute_object_metadata_args: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    compute_object_metadata_args: Record<string, unknown>;
+    object_id?: null | undefined;
+}, {
+    compute_object_metadata_args: Record<string, unknown>;
+    object_id?: null | undefined;
+}>]>>, z.ZodUnion<[z.ZodObject<{
+    row_id: z.ZodString;
+    span_id: z.ZodString;
+    root_span_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    span_id: string;
+    root_span_id: string;
+    row_id: string;
+}, {
+    span_id: string;
+    root_span_id: string;
+    row_id: string;
+}>, z.ZodObject<{
+    row_id: z.ZodOptional<z.ZodNull>;
+    span_id: z.ZodOptional<z.ZodNull>;
+    root_span_id: z.ZodOptional<z.ZodNull>;
+}, "strip", z.ZodTypeAny, {
+    span_id?: null | undefined;
+    root_span_id?: null | undefined;
+    row_id?: null | undefined;
+}, {
+    span_id?: null | undefined;
+    root_span_id?: null | undefined;
+    row_id?: null | undefined;
+}>]>>;
+type SpanComponentsV3Data = z.infer<typeof spanComponentsV3Schema>;
+declare class SpanComponentsV3 {
+    data: SpanComponentsV3Data;
+    constructor(data: SpanComponentsV3Data);
+    toStr(): string;
+    static fromStr(s: string): SpanComponentsV3;
+    objectIdFields(): ParentExperimentIds | ParentProjectLogIds | ParentPlaygroundLogIds;
+    export(): Promise<string>;
+    private static fromJsonObj;
+}
+
 interface Score {
     name: string;
     score: number | null;
@@ -208,6 +276,69 @@ interface Score {
     error?: unknown;
 }
 
+declare const spanComponentsV4Schema: z.ZodIntersection<z.ZodIntersection<z.ZodObject<{
+    object_type: z.ZodNativeEnum<typeof SpanObjectTypeV3>;
+    propagated_event: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+}, "strip", z.ZodTypeAny, {
+    object_type: SpanObjectTypeV3;
+    propagated_event?: Record<string, unknown> | null | undefined;
+}, {
+    object_type: SpanObjectTypeV3;
+    propagated_event?: Record<string, unknown> | null | undefined;
+}>, z.ZodUnion<[z.ZodObject<{
+    object_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    compute_object_metadata_args: z.ZodOptional<z.ZodNull>;
+}, "strip", z.ZodTypeAny, {
+    object_id?: string | null | undefined;
+    compute_object_metadata_args?: null | undefined;
+}, {
+    object_id?: string | null | undefined;
+    compute_object_metadata_args?: null | undefined;
+}>, z.ZodObject<{
+    object_id: z.ZodOptional<z.ZodNull>;
+    compute_object_metadata_args: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    compute_object_metadata_args: Record<string, unknown>;
+    object_id?: null | undefined;
+}, {
+    compute_object_metadata_args: Record<string, unknown>;
+    object_id?: null | undefined;
+}>]>>, z.ZodUnion<[z.ZodObject<{
+    row_id: z.ZodString;
+    span_id: z.ZodString;
+    root_span_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    span_id: string;
+    root_span_id: string;
+    row_id: string;
+}, {
+    span_id: string;
+    root_span_id: string;
+    row_id: string;
+}>, z.ZodObject<{
+    row_id: z.ZodOptional<z.ZodNull>;
+    span_id: z.ZodOptional<z.ZodNull>;
+    root_span_id: z.ZodOptional<z.ZodNull>;
+}, "strip", z.ZodTypeAny, {
+    span_id?: null | undefined;
+    root_span_id?: null | undefined;
+    row_id?: null | undefined;
+}, {
+    span_id?: null | undefined;
+    root_span_id?: null | undefined;
+    row_id?: null | undefined;
+}>]>>;
+type SpanComponentsV4Data = z.infer<typeof spanComponentsV4Schema>;
+declare class SpanComponentsV4 {
+    data: SpanComponentsV4Data;
+    constructor(data: SpanComponentsV4Data);
+    toStr(): string;
+    static fromStr(s: string): SpanComponentsV4;
+    objectIdFields(): ParentExperimentIds | ParentProjectLogIds | ParentPlaygroundLogIds;
+    export(): Promise<string>;
+    private static fromJsonObj;
+}
+
 declare const spanTypeAttributeValues: readonly ["llm", "score", "function", "eval", "task", "tool"];
 type SpanType = (typeof spanTypeAttributeValues)[number];
 
@@ -7903,6 +8034,11 @@ interface Span extends Exportable {
      * Parent span IDs of the span.
      */
     spanParents: string[];
+    getParentInfo(): {
+        objectType: SpanObjectTypeV3;
+        objectId: LazyValue<string>;
+        computeObjectMetadataArgs: Record<string, unknown> | undefined;
+    } | undefined;
     /**
      * Incrementally update the current span with new data. The event will be batched and uploaded behind the scenes.
      *
@@ -8005,12 +8141,6 @@ interface Span extends Exportable {
      */
     startSpanWithParents(spanId: string, spanParents: string[], args?: StartSpanArgs): Span;
     state(): BraintrustState;
-    /**
-     * Internal method to get the OTEL parent string for this span.
-     * This is used by OtelContextManager to set the braintrust.parent attribute.
-     * @returns A string like "project_id:X" or "experiment_id:X", or undefined if no parent
-     */
-    _getOtelParent(): string | undefined;
     kind: "span";
 }
 declare abstract class ContextManager {
@@ -8018,6 +8148,12 @@ declare abstract class ContextManager {
     abstract runInContext<R>(span: Span, callback: () => R): R;
     abstract getCurrentSpan(): Span | undefined;
 }
+declare global {
+    var BRAINTRUST_CONTEXT_MANAGER: (new () => ContextManager) | undefined;
+    var BRAINTRUST_ID_GENERATOR: (new () => IDGenerator) | undefined;
+    var BRAINTRUST_SPAN_COMPONENT: SpanComponent | undefined;
+}
+type SpanComponent = typeof SpanComponentsV3 | typeof SpanComponentsV4;
 /**
  * A fake implementation of the Span API which does nothing. This can be used as the default span.
  */
@@ -8031,6 +8167,7 @@ declare class NoopSpan implements Span {
     log(_: ExperimentLogPartialArgs): void;
     logFeedback(_event: Omit<LogFeedbackFullArgs, "id">): void;
     traced<R>(callback: (span: Span) => R, _1?: StartSpanArgs & SetCurrentArg): R;
+    getParentInfo(): undefined;
     startSpan(_1?: StartSpanArgs): this;
     end(args?: EndSpanArgs): number;
     export(): Promise<string>;
@@ -8041,7 +8178,6 @@ declare class NoopSpan implements Span {
     setAttributes(_args: Omit<StartSpanArgs, "event">): void;
     startSpanWithParents(_spanId: string, _spanParents: string[], _args?: StartSpanArgs): Span;
     state(): BraintrustState;
-    _getOtelParent(): string | undefined;
     toString(): string;
 }
 declare const NOOP_SPAN: NoopSpan;
@@ -8292,6 +8428,7 @@ declare class HTTPBackgroundLogger implements BackgroundLogger {
     queueDropLoggingPeriod: number;
     failedPublishPayloadsDir: string | undefined;
     allPublishPayloadsDir: string | undefined;
+    flushChunkSize: number;
     private _disabled;
     private queueDropLoggingState;
     constructor(apiConn: LazyValue<HTTPConnection>, opts?: BackgroundLoggerOpts);
@@ -8299,6 +8436,7 @@ declare class HTTPBackgroundLogger implements BackgroundLogger {
     log(items: LazyValue<BackgroundLogEvent>[]): void;
     flush(): Promise<void>;
     private flushOnce;
+    private flushWrappedItemsChunk;
     private unwrapLazyValues;
     private submitLogsRequest;
     private registerDroppedItemCount;
@@ -8378,6 +8516,7 @@ declare class ObjectFetcher<RecordType> implements AsyncIterable<WithTransaction
     constructor(objectType: "dataset" | "experiment", pinnedVersion: string | undefined, mutateRecord?: ((r: any) => WithTransactionId<RecordType>) | undefined, _internal_btql?: Record<string, unknown> | undefined);
     get id(): Promise<string>;
     protected getState(): Promise<BraintrustState>;
+    private fetchRecordsFromApi;
     fetch(): AsyncGenerator<WithTransactionId<RecordType>>;
     [Symbol.asyncIterator](): AsyncIterator<WithTransactionId<RecordType>>;
     fetchedData(): Promise<WithTransactionId<RecordType>[]>;
@@ -8771,6 +8910,7 @@ interface BaseFnOpts {
     slug: string;
     description: string;
     ifExists: IfExistsType;
+    metadata?: Record<string, unknown>;
 }
 
 type NameOrId = {
@@ -8827,10 +8967,12 @@ type Schema<Input, Output> = Partial<{
 }>;
 type CodeOpts<Params, Returns, Fn extends GenericFunction<Params, Returns>> = Partial<BaseFnOpts> & {
     handler: Fn;
+    metadata?: Record<string, unknown>;
 } & Schema<Params, Returns>;
 type ScorerPromptOpts = Partial<BaseFnOpts> & PromptOpts<false, false, false, false> & {
     useCot: boolean;
     choiceScores: Record<string, number>;
+    metadata?: Record<string, unknown>;
 };
 type ScorerArgs<Output, Input> = {
     output: Output;
@@ -8839,7 +8981,10 @@ type ScorerArgs<Output, Input> = {
     metadata?: Record<string, unknown>;
 };
 type Exact<T, Shape> = T extends Shape ? Exclude<keyof T, keyof Shape> extends never ? T : never : never;
-type ScorerOpts<Output, Input, Params, Returns, Fn extends GenericFunction<Exact<Params, ScorerArgs<Output, Input>>, Returns>> = CodeOpts<Exact<Params, ScorerArgs<Output, Input>>, Returns, Fn> | ScorerPromptOpts;
+type ScorerOptsUnion<Output, Input, Params, Returns, Fn extends GenericFunction<Exact<Params, ScorerArgs<Output, Input>>, Returns>> = CodeOpts<Exact<Params, ScorerArgs<Output, Input>>, Returns, Fn> | ScorerPromptOpts;
+type ScorerOpts<Output, Input, Params, Returns, Fn extends GenericFunction<Exact<Params, ScorerArgs<Output, Input>>, Returns>> = ScorerOptsUnion<Output, Input, Params, Returns, Fn> & {
+    metadata?: Record<string, unknown>;
+};
 declare class CodeFunction<Input, Output, Fn extends GenericFunction<Input, Output>> {
     readonly project: Project;
     readonly handler: Fn;
@@ -8850,6 +8995,7 @@ declare class CodeFunction<Input, Output, Fn extends GenericFunction<Input, Outp
     readonly parameters?: z.ZodSchema<Input>;
     readonly returns?: z.ZodSchema<Output>;
     readonly ifExists?: IfExistsType;
+    readonly metadata?: Record<string, unknown>;
     constructor(project: Project, opts: Omit<CodeOpts<Input, Output, Fn>, "name" | "slug"> & {
         name: string;
         slug: string;
@@ -8868,6 +9014,7 @@ declare class CodePrompt {
     readonly id?: string;
     readonly functionType?: FunctionTypeEnumType;
     readonly toolFunctions: (SavedFunctionIdType | GenericCodeFunction)[];
+    readonly metadata?: Record<string, unknown>;
     constructor(project: Project, prompt: PromptDataType, toolFunctions: (SavedFunctionIdType | GenericCodeFunction)[], opts: Omit<PromptOpts<false, false, false, false>, "name" | "slug"> & {
         name: string;
         slug: string;
@@ -10088,6 +10235,7 @@ interface FunctionEvent {
     function_data: z.infer<typeof FunctionData>;
     function_type?: FunctionTypeEnumType;
     if_exists?: IfExistsType;
+    metadata?: Record<string, unknown>;
 }
 declare class ProjectNameIdMap {
     private nameToId;