braintrust 0.0.141-dev1 → 0.0.141

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { GitMetadataSettings, LogFeedbackFullArgs, BackgroundLogEvent, ExperimentEvent, ExperimentLogFullArgs, ExperimentLogPartialArgs, IdField, SpanType, RepoInfo, DEFAULT_IS_LEGACY_DATASET, TRANSACTION_ID_FIELD, TransactionId, SpanObjectTypeV2, DatasetRecord, Score } from '@braintrust/core';
 export { CommentEvent, DatasetRecord, ExperimentLogFullArgs, ExperimentLogPartialArgs, IdField, InputField, InputsField, LogCommentFullArgs, LogFeedbackFullArgs, OtherExperimentLogFields, ParentExperimentIds, ParentProjectLogIds } from '@braintrust/core';
-import { PromptData, OpenAIMessage, Tools, AnyModelParam, Prompt as Prompt$1, PromptSessionEvent, FunctionId } from '@braintrust/core/typespecs';
+import { PromptData, OpenAIMessage, Tools, AnyModelParam, Prompt as Prompt$1, PromptSessionEvent } from '@braintrust/core/typespecs';
 import { z } from 'zod';
 
 interface IsoAsyncLocalStorage<T> {
@@ -138,7 +138,7 @@ declare const loginSchema: z.ZodObject<{
     appUrl: z.ZodString;
     appPublicUrl: z.ZodString;
     orgName: z.ZodString;
-    logUrl: z.ZodString;
+    apiUrl: z.ZodString;
     proxyUrl: z.ZodString;
     loginToken: z.ZodString;
     orgId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -156,7 +156,7 @@ declare const loginSchema: z.ZodObject<{
     appUrl: string;
     appPublicUrl: string;
     orgName: string;
-    logUrl: string;
+    apiUrl: string;
     proxyUrl: string;
     loginToken: string;
     orgId?: string | null | undefined;
@@ -168,7 +168,7 @@ declare const loginSchema: z.ZodObject<{
     appUrl: string;
     appPublicUrl: string;
     orgName: string;
-    logUrl: string;
+    apiUrl: string;
     proxyUrl: string;
     loginToken: string;
     orgId?: string | null | undefined;
@@ -190,13 +190,13 @@ declare class BraintrustState {
     loginToken: string | null;
     orgId: string | null;
     orgName: string | null;
-    logUrl: string | null;
+    apiUrl: string | null;
     proxyUrl: string | null;
     loggedIn: boolean;
     gitMetadataSettings?: GitMetadataSettings;
     fetch: typeof globalThis.fetch;
+    private _appConn;
     private _apiConn;
-    private _logConn;
     private _proxyConn;
     constructor(loginParams: LoginOptions);
     resetLoginInfo(): void;
@@ -207,11 +207,11 @@ declare class BraintrustState {
     login(loginParams: LoginOptions & {
         forceLogin?: boolean;
     }): Promise<void>;
+    appConn(): HTTPConnection;
     apiConn(): HTTPConnection;
-    logConn(): HTTPConnection;
     proxyConn(): HTTPConnection;
     bgLogger(): BackgroundLogger;
-    loginReplaceLogConn(logConn: HTTPConnection): void;
+    loginReplaceApiConn(apiConn: HTTPConnection): void;
 }
 declare function _internalSetInitialState(): void;
 declare const _internalGetGlobalState: () => BraintrustState;
@@ -272,7 +272,6 @@ declare class Logger<IsAsyncFlush extends boolean> implements Exportable {
     get project(): Promise<ObjectMetadata>;
     get id(): Promise<string>;
     private parentObjectType;
-    private triggerWaitUntilFlush;
     /**
      * Log a single event. The event will be batched and uploaded behind the scenes if `logOptions.asyncFlush` is true.
      *
@@ -326,7 +325,7 @@ declare class Logger<IsAsyncFlush extends boolean> implements Exportable {
     get asyncFlush(): IsAsyncFlush | undefined;
 }
 declare class BackgroundLogger {
-    private logConn;
+    private apiConn;
     private items;
     private activeFlush;
     private activeFlushResolved;
@@ -340,7 +339,7 @@ declare class BackgroundLogger {
     failedPublishPayloadsDir: string | undefined;
     allPublishPayloadsDir: string | undefined;
     private queueDropLoggingState;
-    constructor(logConn: LazyValue<HTTPConnection>);
+    constructor(apiConn: LazyValue<HTTPConnection>);
     log(items: LazyValue<BackgroundLogEvent>[]): void;
     flush(): Promise<void>;
     private flushOnce;
@@ -351,7 +350,7 @@ declare class BackgroundLogger {
     private static writePayloadToDir;
     private triggerActiveFlush;
     private logFailedPayloadsDir;
-    internalReplaceLogConn(logConn: HTTPConnection): void;
+    internalReplaceApiConn(apiConn: HTTPConnection): void;
 }
 type InitOpenOption<IsOpen extends boolean> = {
     open?: IsOpen;
@@ -1025,33 +1024,155 @@ interface DatasetSummary {
     dataSummary: DataSummary;
 }
 
-type BraintrustStreamChunk = {
+declare const braintrustStreamChunkSchema: z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"text_delta">;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    data: string;
+    type: "text_delta";
+}, {
+    data: string;
     type: "text_delta";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"json_delta">;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
     data: string;
-} | {
     type: "json_delta";
+}, {
     data: string;
-};
+    type: "json_delta";
+}>]>;
+/**
+ * A chunk of data from a Braintrust stream. Each chunk type matches
+ * an SSE event type.
+ */
+type BraintrustStreamChunk = z.infer<typeof braintrustStreamChunkSchema>;
+/**
+ * A Braintrust stream. This is a wrapper around a ReadableStream of `BraintrustStreamChunk`,
+ * with some utility methods to make them easy to log and convert into various formats.
+ */
 declare class BraintrustStream {
     private stream;
+    private memoizedFinalValue;
     constructor(baseStream: ReadableStream<Uint8Array>);
     constructor(stream: ReadableStream<string>);
     constructor(stream: ReadableStream<BraintrustStreamChunk>);
+    /**
+     * Copy the stream. This returns a new stream that shares the same underlying
+     * stream (via `tee`). Since streams are consumed in Javascript, use `copy()` if you
+     * need to use the stream multiple times.
+     *
+     * @returns A new stream that you can independently consume.
+     */
     copy(): BraintrustStream;
+    /**
+     * Get the underlying ReadableStream.
+     *
+     * @returns The underlying ReadableStream<BraintrustStreamChunk>.
+     */
     toReadableStream(): ReadableStream<BraintrustStreamChunk>;
+    /**
+     * 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
+     * the value's type.
+     *
+     * This function returns a promise that resolves when the stream is closed, and
+     * contains the final value. Multiple calls to `finalValue()` will return the same
+     * promise, so it is safe to call this multiple times.
+     *
+     * This function consumes the stream, so if you need to use the stream multiple
+     * times, you should call `copy()` first.
+     *
+     * @returns A promise that resolves with the final value of the stream or `undefined` if the stream is empty.
+     */
+    finalValue(): Promise<unknown>;
 }
+/**
+ * Create a stream that passes through the final value of the stream. This is
+ * used to implement `BraintrustStream.finalValue()`.
+ *
+ * @param onFinal A function to call with the final value of the stream.
+ * @returns A new stream that passes through the final value of the stream.
+ */
 declare function createFinalValuePassThroughStream<T extends BraintrustStreamChunk | string | Uint8Array>(onFinal: (result: unknown) => void): TransformStream<T, BraintrustStreamChunk>;
 declare function devNullWritableStream(): WritableStream;
 
-type InvokeReturn<Stream extends boolean, Return> = Stream extends true ? BraintrustStream : Return;
-type InvokeFunctionArgs<Arg, Return, Stream extends boolean = false> = FunctionId & FullLoginOptions & {
-    arg: Arg;
+/**
+ * Arguments for the `invoke` function.
+ */
+interface InvokeFunctionArgs<Input, Output, Stream extends boolean = false> {
+    /**
+     * The ID of the function to invoke.
+     */
+    function_id?: string;
+    /**
+     * The name of the project containing the function to invoke.
+     */
+    project_name?: string;
+    /**
+     * The slug of the function to invoke.
+     */
+    slug?: string;
+    /**
+     * The name of the global function to invoke.
+     */
+    global_function?: string;
+    /**
+     * The ID of the prompt session to invoke the function from.
+     */
+    prompt_session_id?: string;
+    /**
+     * The ID of the function in the prompt session to invoke.
+     */
+    prompt_session_function_id?: string;
+    /**
+     * The version of the function to invoke.
+     */
+    version?: string;
+    /**
+     * The input to the function. This will be logged as the `input` field in the span.
+     */
+    input: Input;
+    /**
+     * The parent of the function. This can be an existing span, logger, or experiment, or
+     * the output of `.export()` if you are distributed tracing. If unspecified, will use
+     * the same semantics as `traced()` to determine the parent and no-op if not in a tracing
+     * context.
+     */
     parent?: Exportable | string;
-    state?: BraintrustState;
+    /**
+     * Whether to stream the function's output. If true, the function will return a
+     * `BraintrustStream`, otherwise it will return the output of the function as a JSON
+     * object.
+     */
     stream?: Stream;
-    schema?: z.ZodSchema<Return>;
-};
-declare function invoke<Arg, Return, Stream extends boolean = false>(args: InvokeFunctionArgs<Arg, Return, Stream>): Promise<InvokeReturn<Stream, Return>>;
+    /**
+     * A Zod schema to validate the output of the function and return a typed value. This
+     * is only used if `stream` is false.
+     */
+    schema?: Stream extends true ? never : z.ZodSchema<Output>;
+    /**
+     * (Advanced) This parameter allows you to pass in a custom login state. This is useful
+     * for multi-tenant environments where you are running functions from different Braintrust
+     * organizations.
+     */
+    state?: BraintrustState;
+}
+/**
+ * The return type of the `invoke` function. Conditionally returns a `BraintrustStream`
+ * if `stream` is true, otherwise returns the output of the function using the Zod schema's
+ * type if present.
+ */
+type InvokeReturn<Stream extends boolean, Output> = Stream extends true ? BraintrustStream : Output;
+/**
+ * Invoke a Braintrust function, returning a `BraintrustStream` or the value as a plain
+ * Javascript object.
+ *
+ * @param args The arguments for the function (see {@link InvokeFunctionArgs} for more details).
+ * @returns The output of the function.
+ */
+declare function invoke<Input, Output, Stream extends boolean = false>(args: InvokeFunctionArgs<Input, Output, Stream> & FullLoginOptions): Promise<InvokeReturn<Stream, Output>>;
 
 type BaseExperiment<Input, Expected, Metadata extends BaseMetadata = DefaultMetadataType> = {
     _type: "BaseExperiment";
@@ -1247,4 +1368,4 @@ declare function parseCachedHeader(value: string | null | undefined): number | u
  */
 declare function wrapAISDKModel<T extends object>(model: T): T;
 
-export { type AnyDataset, BaseExperiment, 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, Eval, type EvalCase, type EvalScorerArgs, type EvalTask, type Evaluator, Experiment, type ExperimentSummary, type Exportable, type FullInitOptions, type FullLoginOptions, type InitOptions, type InvokeFunctionArgs, type InvokeReturn, LEGACY_CACHED_HEADER, LazyValue, type LogOptions, Logger, type LoginOptions, type MetricSummary, NOOP_SPAN, NoopSpan, type ObjectMetadata, type PromiseUnless, Prompt, ReadonlyExperiment, Reporter, type ReporterBody, type ScoreSummary, type SerializedBraintrustState, type SetCurrentArg, type Span, SpanImpl, type StartSpanArgs, type WithTransactionId, X_CACHED_HEADER, _internalGetGlobalState, _internalSetInitialState, buildLocalSummary, createFinalValuePassThroughStream, currentExperiment, currentLogger, currentSpan, devNullWritableStream, flush, getSpanParentObject, init, initDataset, initExperiment, initLogger, invoke, loadPrompt, log, login, loginToState, newId, parseCachedHeader, reportFailures, setFetch, startSpan, summarize, traceable, traced, withDataset, withExperiment, withLogger, wrapAISDKModel, wrapOpenAI, wrapOpenAIv4, wrapTraced };
+export { type AnyDataset, BaseExperiment, 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, Eval, type EvalCase, type EvalScorerArgs, type EvalTask, type Evaluator, Experiment, type ExperimentSummary, type Exportable, type FullInitOptions, type FullLoginOptions, type InitOptions, type InvokeFunctionArgs, type InvokeReturn, LEGACY_CACHED_HEADER, LazyValue, type LogOptions, Logger, type LoginOptions, type MetricSummary, NOOP_SPAN, NoopSpan, type ObjectMetadata, type PromiseUnless, Prompt, ReadonlyExperiment, Reporter, type ReporterBody, type ScoreSummary, type SerializedBraintrustState, type SetCurrentArg, type Span, SpanImpl, type StartSpanArgs, type WithTransactionId, X_CACHED_HEADER, _internalGetGlobalState, _internalSetInitialState, braintrustStreamChunkSchema, buildLocalSummary, createFinalValuePassThroughStream, currentExperiment, currentLogger, currentSpan, devNullWritableStream, flush, getSpanParentObject, init, initDataset, initExperiment, initLogger, invoke, loadPrompt, log, login, loginToState, newId, parseCachedHeader, reportFailures, setFetch, startSpan, summarize, traceable, traced, withDataset, withExperiment, withLogger, wrapAISDKModel, wrapOpenAI, wrapOpenAIv4, wrapTraced };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { GitMetadataSettings, LogFeedbackFullArgs, BackgroundLogEvent, ExperimentEvent, ExperimentLogFullArgs, ExperimentLogPartialArgs, IdField, SpanType, RepoInfo, DEFAULT_IS_LEGACY_DATASET, TRANSACTION_ID_FIELD, TransactionId, SpanObjectTypeV2, DatasetRecord, Score } from '@braintrust/core';
 export { CommentEvent, DatasetRecord, ExperimentLogFullArgs, ExperimentLogPartialArgs, IdField, InputField, InputsField, LogCommentFullArgs, LogFeedbackFullArgs, OtherExperimentLogFields, ParentExperimentIds, ParentProjectLogIds } from '@braintrust/core';
-import { PromptData, OpenAIMessage, Tools, AnyModelParam, Prompt as Prompt$1, PromptSessionEvent, FunctionId } from '@braintrust/core/typespecs';
+import { PromptData, OpenAIMessage, Tools, AnyModelParam, Prompt as Prompt$1, PromptSessionEvent } from '@braintrust/core/typespecs';
 import { z } from 'zod';
 
 interface IsoAsyncLocalStorage<T> {
@@ -138,7 +138,7 @@ declare const loginSchema: z.ZodObject<{
     appUrl: z.ZodString;
     appPublicUrl: z.ZodString;
     orgName: z.ZodString;
-    logUrl: z.ZodString;
+    apiUrl: z.ZodString;
     proxyUrl: z.ZodString;
     loginToken: z.ZodString;
     orgId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -156,7 +156,7 @@ declare const loginSchema: z.ZodObject<{
     appUrl: string;
     appPublicUrl: string;
     orgName: string;
-    logUrl: string;
+    apiUrl: string;
     proxyUrl: string;
     loginToken: string;
     orgId?: string | null | undefined;
@@ -168,7 +168,7 @@ declare const loginSchema: z.ZodObject<{
     appUrl: string;
     appPublicUrl: string;
     orgName: string;
-    logUrl: string;
+    apiUrl: string;
     proxyUrl: string;
     loginToken: string;
     orgId?: string | null | undefined;
@@ -190,13 +190,13 @@ declare class BraintrustState {
     loginToken: string | null;
     orgId: string | null;
     orgName: string | null;
-    logUrl: string | null;
+    apiUrl: string | null;
     proxyUrl: string | null;
     loggedIn: boolean;
     gitMetadataSettings?: GitMetadataSettings;
     fetch: typeof globalThis.fetch;
+    private _appConn;
     private _apiConn;
-    private _logConn;
     private _proxyConn;
     constructor(loginParams: LoginOptions);
     resetLoginInfo(): void;
@@ -207,11 +207,11 @@ declare class BraintrustState {
     login(loginParams: LoginOptions & {
         forceLogin?: boolean;
     }): Promise<void>;
+    appConn(): HTTPConnection;
     apiConn(): HTTPConnection;
-    logConn(): HTTPConnection;
     proxyConn(): HTTPConnection;
     bgLogger(): BackgroundLogger;
-    loginReplaceLogConn(logConn: HTTPConnection): void;
+    loginReplaceApiConn(apiConn: HTTPConnection): void;
 }
 declare function _internalSetInitialState(): void;
 declare const _internalGetGlobalState: () => BraintrustState;
@@ -272,7 +272,6 @@ declare class Logger<IsAsyncFlush extends boolean> implements Exportable {
     get project(): Promise<ObjectMetadata>;
     get id(): Promise<string>;
     private parentObjectType;
-    private triggerWaitUntilFlush;
     /**
      * Log a single event. The event will be batched and uploaded behind the scenes if `logOptions.asyncFlush` is true.
      *
@@ -326,7 +325,7 @@ declare class Logger<IsAsyncFlush extends boolean> implements Exportable {
     get asyncFlush(): IsAsyncFlush | undefined;
 }
 declare class BackgroundLogger {
-    private logConn;
+    private apiConn;
     private items;
     private activeFlush;
     private activeFlushResolved;
@@ -340,7 +339,7 @@ declare class BackgroundLogger {
     failedPublishPayloadsDir: string | undefined;
     allPublishPayloadsDir: string | undefined;
     private queueDropLoggingState;
-    constructor(logConn: LazyValue<HTTPConnection>);
+    constructor(apiConn: LazyValue<HTTPConnection>);
     log(items: LazyValue<BackgroundLogEvent>[]): void;
     flush(): Promise<void>;
     private flushOnce;
@@ -351,7 +350,7 @@ declare class BackgroundLogger {
     private static writePayloadToDir;
     private triggerActiveFlush;
     private logFailedPayloadsDir;
-    internalReplaceLogConn(logConn: HTTPConnection): void;
+    internalReplaceApiConn(apiConn: HTTPConnection): void;
 }
 type InitOpenOption<IsOpen extends boolean> = {
     open?: IsOpen;
@@ -1025,33 +1024,155 @@ interface DatasetSummary {
     dataSummary: DataSummary;
 }
 
-type BraintrustStreamChunk = {
+declare const braintrustStreamChunkSchema: z.ZodUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"text_delta">;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    data: string;
+    type: "text_delta";
+}, {
+    data: string;
     type: "text_delta";
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"json_delta">;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
     data: string;
-} | {
     type: "json_delta";
+}, {
     data: string;
-};
+    type: "json_delta";
+}>]>;
+/**
+ * A chunk of data from a Braintrust stream. Each chunk type matches
+ * an SSE event type.
+ */
+type BraintrustStreamChunk = z.infer<typeof braintrustStreamChunkSchema>;
+/**
+ * A Braintrust stream. This is a wrapper around a ReadableStream of `BraintrustStreamChunk`,
+ * with some utility methods to make them easy to log and convert into various formats.
+ */
 declare class BraintrustStream {
     private stream;
+    private memoizedFinalValue;
     constructor(baseStream: ReadableStream<Uint8Array>);
     constructor(stream: ReadableStream<string>);
     constructor(stream: ReadableStream<BraintrustStreamChunk>);
+    /**
+     * Copy the stream. This returns a new stream that shares the same underlying
+     * stream (via `tee`). Since streams are consumed in Javascript, use `copy()` if you
+     * need to use the stream multiple times.
+     *
+     * @returns A new stream that you can independently consume.
+     */
     copy(): BraintrustStream;
+    /**
+     * Get the underlying ReadableStream.
+     *
+     * @returns The underlying ReadableStream<BraintrustStreamChunk>.
+     */
     toReadableStream(): ReadableStream<BraintrustStreamChunk>;
+    /**
+     * 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
+     * the value's type.
+     *
+     * This function returns a promise that resolves when the stream is closed, and
+     * contains the final value. Multiple calls to `finalValue()` will return the same
+     * promise, so it is safe to call this multiple times.
+     *
+     * This function consumes the stream, so if you need to use the stream multiple
+     * times, you should call `copy()` first.
+     *
+     * @returns A promise that resolves with the final value of the stream or `undefined` if the stream is empty.
+     */
+    finalValue(): Promise<unknown>;
 }
+/**
+ * Create a stream that passes through the final value of the stream. This is
+ * used to implement `BraintrustStream.finalValue()`.
+ *
+ * @param onFinal A function to call with the final value of the stream.
+ * @returns A new stream that passes through the final value of the stream.
+ */
 declare function createFinalValuePassThroughStream<T extends BraintrustStreamChunk | string | Uint8Array>(onFinal: (result: unknown) => void): TransformStream<T, BraintrustStreamChunk>;
 declare function devNullWritableStream(): WritableStream;
 
-type InvokeReturn<Stream extends boolean, Return> = Stream extends true ? BraintrustStream : Return;
-type InvokeFunctionArgs<Arg, Return, Stream extends boolean = false> = FunctionId & FullLoginOptions & {
-    arg: Arg;
+/**
+ * Arguments for the `invoke` function.
+ */
+interface InvokeFunctionArgs<Input, Output, Stream extends boolean = false> {
+    /**
+     * The ID of the function to invoke.
+     */
+    function_id?: string;
+    /**
+     * The name of the project containing the function to invoke.
+     */
+    project_name?: string;
+    /**
+     * The slug of the function to invoke.
+     */
+    slug?: string;
+    /**
+     * The name of the global function to invoke.
+     */
+    global_function?: string;
+    /**
+     * The ID of the prompt session to invoke the function from.
+     */
+    prompt_session_id?: string;
+    /**
+     * The ID of the function in the prompt session to invoke.
+     */
+    prompt_session_function_id?: string;
+    /**
+     * The version of the function to invoke.
+     */
+    version?: string;
+    /**
+     * The input to the function. This will be logged as the `input` field in the span.
+     */
+    input: Input;
+    /**
+     * The parent of the function. This can be an existing span, logger, or experiment, or
+     * the output of `.export()` if you are distributed tracing. If unspecified, will use
+     * the same semantics as `traced()` to determine the parent and no-op if not in a tracing
+     * context.
+     */
     parent?: Exportable | string;
-    state?: BraintrustState;
+    /**
+     * Whether to stream the function's output. If true, the function will return a
+     * `BraintrustStream`, otherwise it will return the output of the function as a JSON
+     * object.
+     */
     stream?: Stream;
-    schema?: z.ZodSchema<Return>;
-};
-declare function invoke<Arg, Return, Stream extends boolean = false>(args: InvokeFunctionArgs<Arg, Return, Stream>): Promise<InvokeReturn<Stream, Return>>;
+    /**
+     * A Zod schema to validate the output of the function and return a typed value. This
+     * is only used if `stream` is false.
+     */
+    schema?: Stream extends true ? never : z.ZodSchema<Output>;
+    /**
+     * (Advanced) This parameter allows you to pass in a custom login state. This is useful
+     * for multi-tenant environments where you are running functions from different Braintrust
+     * organizations.
+     */
+    state?: BraintrustState;
+}
+/**
+ * The return type of the `invoke` function. Conditionally returns a `BraintrustStream`
+ * if `stream` is true, otherwise returns the output of the function using the Zod schema's
+ * type if present.
+ */
+type InvokeReturn<Stream extends boolean, Output> = Stream extends true ? BraintrustStream : Output;
+/**
+ * Invoke a Braintrust function, returning a `BraintrustStream` or the value as a plain
+ * Javascript object.
+ *
+ * @param args The arguments for the function (see {@link InvokeFunctionArgs} for more details).
+ * @returns The output of the function.
+ */
+declare function invoke<Input, Output, Stream extends boolean = false>(args: InvokeFunctionArgs<Input, Output, Stream> & FullLoginOptions): Promise<InvokeReturn<Stream, Output>>;
 
 type BaseExperiment<Input, Expected, Metadata extends BaseMetadata = DefaultMetadataType> = {
     _type: "BaseExperiment";
@@ -1247,4 +1368,4 @@ declare function parseCachedHeader(value: string | null | undefined): number | u
  */
 declare function wrapAISDKModel<T extends object>(model: T): T;
 
-export { type AnyDataset, BaseExperiment, 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, Eval, type EvalCase, type EvalScorerArgs, type EvalTask, type Evaluator, Experiment, type ExperimentSummary, type Exportable, type FullInitOptions, type FullLoginOptions, type InitOptions, type InvokeFunctionArgs, type InvokeReturn, LEGACY_CACHED_HEADER, LazyValue, type LogOptions, Logger, type LoginOptions, type MetricSummary, NOOP_SPAN, NoopSpan, type ObjectMetadata, type PromiseUnless, Prompt, ReadonlyExperiment, Reporter, type ReporterBody, type ScoreSummary, type SerializedBraintrustState, type SetCurrentArg, type Span, SpanImpl, type StartSpanArgs, type WithTransactionId, X_CACHED_HEADER, _internalGetGlobalState, _internalSetInitialState, buildLocalSummary, createFinalValuePassThroughStream, currentExperiment, currentLogger, currentSpan, devNullWritableStream, flush, getSpanParentObject, init, initDataset, initExperiment, initLogger, invoke, loadPrompt, log, login, loginToState, newId, parseCachedHeader, reportFailures, setFetch, startSpan, summarize, traceable, traced, withDataset, withExperiment, withLogger, wrapAISDKModel, wrapOpenAI, wrapOpenAIv4, wrapTraced };
+export { type AnyDataset, BaseExperiment, 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, Eval, type EvalCase, type EvalScorerArgs, type EvalTask, type Evaluator, Experiment, type ExperimentSummary, type Exportable, type FullInitOptions, type FullLoginOptions, type InitOptions, type InvokeFunctionArgs, type InvokeReturn, LEGACY_CACHED_HEADER, LazyValue, type LogOptions, Logger, type LoginOptions, type MetricSummary, NOOP_SPAN, NoopSpan, type ObjectMetadata, type PromiseUnless, Prompt, ReadonlyExperiment, Reporter, type ReporterBody, type ScoreSummary, type SerializedBraintrustState, type SetCurrentArg, type Span, SpanImpl, type StartSpanArgs, type WithTransactionId, X_CACHED_HEADER, _internalGetGlobalState, _internalSetInitialState, braintrustStreamChunkSchema, buildLocalSummary, createFinalValuePassThroughStream, currentExperiment, currentLogger, currentSpan, devNullWritableStream, flush, getSpanParentObject, init, initDataset, initExperiment, initLogger, invoke, loadPrompt, log, login, loginToState, newId, parseCachedHeader, reportFailures, setFetch, startSpan, summarize, traceable, traced, withDataset, withExperiment, withLogger, wrapAISDKModel, wrapOpenAI, wrapOpenAIv4, wrapTraced };