@superinterface/react 5.1.2 → 5.2.0-beta.0

package/types/node_modules/openai/core/api-promise.d.mts

@@ -0,0 +1,49 @@
+import { type OpenAI } from "../client.mjs";
+import { type PromiseOrValue } from "../internal/types.mjs";
+import { type APIResponseProps, type WithRequestID } from "../internal/parse.mjs";
+/**
+ * A subclass of `Promise` providing additional helper methods
+ * for interacting with the SDK.
+ */
+export declare class APIPromise<T> extends Promise<WithRequestID<T>> {
+    #private;
+    private responsePromise;
+    private parseResponse;
+    private parsedPromise;
+    constructor(client: OpenAI, responsePromise: Promise<APIResponseProps>, parseResponse?: (client: OpenAI, props: APIResponseProps) => PromiseOrValue<WithRequestID<T>>);
+    _thenUnwrap<U>(transform: (data: T, props: APIResponseProps) => U): APIPromise<U>;
+    /**
+     * Gets the raw `Response` instance instead of parsing the response
+     * data.
+     *
+     * If you want to parse the response body but still get the `Response`
+     * instance, you can use {@link withResponse()}.
+     *
+     * 👋 Getting the wrong TypeScript type for `Response`?
+     * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
+     * to your `tsconfig.json`.
+     */
+    asResponse(): Promise<Response>;
+    /**
+     * Gets the parsed response data, the raw `Response` instance and the ID of the request,
+     * returned via the X-Request-ID header which is useful for debugging requests and reporting
+     * issues to OpenAI.
+     *
+     * If you just want to get the raw `Response` instance without parsing it,
+     * you can use {@link asResponse()}.
+     *
+     * 👋 Getting the wrong TypeScript type for `Response`?
+     * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
+     * to your `tsconfig.json`.
+     */
+    withResponse(): Promise<{
+        data: T;
+        response: Response;
+        request_id: string | null;
+    }>;
+    private parse;
+    then<TResult1 = WithRequestID<T>, TResult2 = never>(onfulfilled?: ((value: WithRequestID<T>) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<WithRequestID<T> | TResult>;
+    finally(onfinally?: (() => void) | undefined | null): Promise<WithRequestID<T>>;
+}
+//# sourceMappingURL=api-promise.d.mts.map

package/types/node_modules/openai/core/api-promise.d.ts

@@ -0,0 +1,49 @@
+import { type OpenAI } from "../client.js";
+import { type PromiseOrValue } from "../internal/types.js";
+import { type APIResponseProps, type WithRequestID } from "../internal/parse.js";
+/**
+ * A subclass of `Promise` providing additional helper methods
+ * for interacting with the SDK.
+ */
+export declare class APIPromise<T> extends Promise<WithRequestID<T>> {
+    #private;
+    private responsePromise;
+    private parseResponse;
+    private parsedPromise;
+    constructor(client: OpenAI, responsePromise: Promise<APIResponseProps>, parseResponse?: (client: OpenAI, props: APIResponseProps) => PromiseOrValue<WithRequestID<T>>);
+    _thenUnwrap<U>(transform: (data: T, props: APIResponseProps) => U): APIPromise<U>;
+    /**
+     * Gets the raw `Response` instance instead of parsing the response
+     * data.
+     *
+     * If you want to parse the response body but still get the `Response`
+     * instance, you can use {@link withResponse()}.
+     *
+     * 👋 Getting the wrong TypeScript type for `Response`?
+     * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
+     * to your `tsconfig.json`.
+     */
+    asResponse(): Promise<Response>;
+    /**
+     * Gets the parsed response data, the raw `Response` instance and the ID of the request,
+     * returned via the X-Request-ID header which is useful for debugging requests and reporting
+     * issues to OpenAI.
+     *
+     * If you just want to get the raw `Response` instance without parsing it,
+     * you can use {@link asResponse()}.
+     *
+     * 👋 Getting the wrong TypeScript type for `Response`?
+     * Try setting `"moduleResolution": "NodeNext"` or add `"lib": ["DOM"]`
+     * to your `tsconfig.json`.
+     */
+    withResponse(): Promise<{
+        data: T;
+        response: Response;
+        request_id: string | null;
+    }>;
+    private parse;
+    then<TResult1 = WithRequestID<T>, TResult2 = never>(onfulfilled?: ((value: WithRequestID<T>) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<WithRequestID<T> | TResult>;
+    finally(onfinally?: (() => void) | undefined | null): Promise<WithRequestID<T>>;
+}
+//# sourceMappingURL=api-promise.d.ts.map

package/types/node_modules/openai/core/error.d.mts

@@ -0,0 +1,59 @@
+export declare class OpenAIError extends Error {
+}
+export declare class APIError<TStatus extends number | undefined = number | undefined, THeaders extends Headers | undefined = Headers | undefined, TError extends Object | undefined = Object | undefined> extends OpenAIError {
+    /** HTTP status for the response that caused the error */
+    readonly status: TStatus;
+    /** HTTP headers for the response that caused the error */
+    readonly headers: THeaders;
+    /** JSON body of the response that caused the error */
+    readonly error: TError;
+    readonly code: string | null | undefined;
+    readonly param: string | null | undefined;
+    readonly type: string | undefined;
+    readonly requestID: string | null | undefined;
+    constructor(status: TStatus, error: TError, message: string | undefined, headers: THeaders);
+    private static makeMessage;
+    static generate(status: number | undefined, errorResponse: Object | undefined, message: string | undefined, headers: Headers | undefined): APIError;
+}
+export declare class APIUserAbortError extends APIError<undefined, undefined, undefined> {
+    constructor({ message }?: {
+        message?: string;
+    });
+}
+export declare class APIConnectionError extends APIError<undefined, undefined, undefined> {
+    constructor({ message, cause }: {
+        message?: string | undefined;
+        cause?: Error | undefined;
+    });
+}
+export declare class APIConnectionTimeoutError extends APIConnectionError {
+    constructor({ message }?: {
+        message?: string;
+    });
+}
+export declare class BadRequestError extends APIError<400, Headers> {
+}
+export declare class AuthenticationError extends APIError<401, Headers> {
+}
+export declare class PermissionDeniedError extends APIError<403, Headers> {
+}
+export declare class NotFoundError extends APIError<404, Headers> {
+}
+export declare class ConflictError extends APIError<409, Headers> {
+}
+export declare class UnprocessableEntityError extends APIError<422, Headers> {
+}
+export declare class RateLimitError extends APIError<429, Headers> {
+}
+export declare class InternalServerError extends APIError<number, Headers> {
+}
+export declare class LengthFinishReasonError extends OpenAIError {
+    constructor();
+}
+export declare class ContentFilterFinishReasonError extends OpenAIError {
+    constructor();
+}
+export declare class InvalidWebhookSignatureError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=error.d.mts.map

package/types/node_modules/openai/core/error.d.ts

@@ -0,0 +1,59 @@
+export declare class OpenAIError extends Error {
+}
+export declare class APIError<TStatus extends number | undefined = number | undefined, THeaders extends Headers | undefined = Headers | undefined, TError extends Object | undefined = Object | undefined> extends OpenAIError {
+    /** HTTP status for the response that caused the error */
+    readonly status: TStatus;
+    /** HTTP headers for the response that caused the error */
+    readonly headers: THeaders;
+    /** JSON body of the response that caused the error */
+    readonly error: TError;
+    readonly code: string | null | undefined;
+    readonly param: string | null | undefined;
+    readonly type: string | undefined;
+    readonly requestID: string | null | undefined;
+    constructor(status: TStatus, error: TError, message: string | undefined, headers: THeaders);
+    private static makeMessage;
+    static generate(status: number | undefined, errorResponse: Object | undefined, message: string | undefined, headers: Headers | undefined): APIError;
+}
+export declare class APIUserAbortError extends APIError<undefined, undefined, undefined> {
+    constructor({ message }?: {
+        message?: string;
+    });
+}
+export declare class APIConnectionError extends APIError<undefined, undefined, undefined> {
+    constructor({ message, cause }: {
+        message?: string | undefined;
+        cause?: Error | undefined;
+    });
+}
+export declare class APIConnectionTimeoutError extends APIConnectionError {
+    constructor({ message }?: {
+        message?: string;
+    });
+}
+export declare class BadRequestError extends APIError<400, Headers> {
+}
+export declare class AuthenticationError extends APIError<401, Headers> {
+}
+export declare class PermissionDeniedError extends APIError<403, Headers> {
+}
+export declare class NotFoundError extends APIError<404, Headers> {
+}
+export declare class ConflictError extends APIError<409, Headers> {
+}
+export declare class UnprocessableEntityError extends APIError<422, Headers> {
+}
+export declare class RateLimitError extends APIError<429, Headers> {
+}
+export declare class InternalServerError extends APIError<number, Headers> {
+}
+export declare class LengthFinishReasonError extends OpenAIError {
+    constructor();
+}
+export declare class ContentFilterFinishReasonError extends OpenAIError {
+    constructor();
+}
+export declare class InvalidWebhookSignatureError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=error.d.ts.map

package/types/node_modules/openai/core/pagination.d.mts

@@ -0,0 +1,89 @@
+import { FinalRequestOptions } from "../internal/request-options.mjs";
+import { APIPromise } from "./api-promise.mjs";
+import { type OpenAI } from "../client.mjs";
+import { type APIResponseProps } from "../internal/parse.mjs";
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+export declare abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+    #private;
+    protected options: FinalRequestOptions;
+    protected response: Response;
+    protected body: unknown;
+    constructor(client: OpenAI, response: Response, body: unknown, options: FinalRequestOptions);
+    abstract nextPageRequestOptions(): PageRequestOptions | null;
+    abstract getPaginatedItems(): Item[];
+    hasNextPage(): boolean;
+    getNextPage(): Promise<this>;
+    iterPages(): AsyncGenerator<this>;
+    [Symbol.asyncIterator](): AsyncGenerator<Item>;
+}
+/**
+ * This subclass of Promise will resolve to an instantiated Page once the request completes.
+ *
+ * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
+ *
+ *    for await (const item of client.items.list()) {
+ *      console.log(item)
+ *    }
+ */
+export declare class PagePromise<PageClass extends AbstractPage<Item>, Item = ReturnType<PageClass['getPaginatedItems']>[number]> extends APIPromise<PageClass> implements AsyncIterable<Item> {
+    constructor(client: OpenAI, request: Promise<APIResponseProps>, Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass);
+    /**
+     * Allow auto-paginating iteration on an unawaited list call, eg:
+     *
+     *    for await (const item of client.items.list()) {
+     *      console.log(item)
+     *    }
+     */
+    [Symbol.asyncIterator](): AsyncGenerator<Item>;
+}
+export interface PageResponse<Item> {
+    data: Array<Item>;
+    object: string;
+}
+/**
+ * Note: no pagination actually occurs yet, this is for forwards-compatibility.
+ */
+export declare class Page<Item> extends AbstractPage<Item> implements PageResponse<Item> {
+    data: Array<Item>;
+    object: string;
+    constructor(client: OpenAI, response: Response, body: PageResponse<Item>, options: FinalRequestOptions);
+    getPaginatedItems(): Item[];
+    nextPageRequestOptions(): PageRequestOptions | null;
+}
+export interface CursorPageResponse<Item> {
+    data: Array<Item>;
+    has_more: boolean;
+}
+export interface CursorPageParams {
+    after?: string;
+    limit?: number;
+}
+export declare class CursorPage<Item extends {
+    id: string;
+}> extends AbstractPage<Item> implements CursorPageResponse<Item> {
+    data: Array<Item>;
+    has_more: boolean;
+    constructor(client: OpenAI, response: Response, body: CursorPageResponse<Item>, options: FinalRequestOptions);
+    getPaginatedItems(): Item[];
+    hasNextPage(): boolean;
+    nextPageRequestOptions(): PageRequestOptions | null;
+}
+export interface ConversationCursorPageResponse<Item> {
+    data: Array<Item>;
+    has_more: boolean;
+    last_id: string;
+}
+export interface ConversationCursorPageParams {
+    after?: string;
+    limit?: number;
+}
+export declare class ConversationCursorPage<Item> extends AbstractPage<Item> implements ConversationCursorPageResponse<Item> {
+    data: Array<Item>;
+    has_more: boolean;
+    last_id: string;
+    constructor(client: OpenAI, response: Response, body: ConversationCursorPageResponse<Item>, options: FinalRequestOptions);
+    getPaginatedItems(): Item[];
+    hasNextPage(): boolean;
+    nextPageRequestOptions(): PageRequestOptions | null;
+}
+//# sourceMappingURL=pagination.d.mts.map

package/types/node_modules/openai/core/pagination.d.ts

@@ -0,0 +1,89 @@
+import { FinalRequestOptions } from "../internal/request-options.js";
+import { APIPromise } from "./api-promise.js";
+import { type OpenAI } from "../client.js";
+import { type APIResponseProps } from "../internal/parse.js";
+export type PageRequestOptions = Pick<FinalRequestOptions, 'query' | 'headers' | 'body' | 'path' | 'method'>;
+export declare abstract class AbstractPage<Item> implements AsyncIterable<Item> {
+    #private;
+    protected options: FinalRequestOptions;
+    protected response: Response;
+    protected body: unknown;
+    constructor(client: OpenAI, response: Response, body: unknown, options: FinalRequestOptions);
+    abstract nextPageRequestOptions(): PageRequestOptions | null;
+    abstract getPaginatedItems(): Item[];
+    hasNextPage(): boolean;
+    getNextPage(): Promise<this>;
+    iterPages(): AsyncGenerator<this>;
+    [Symbol.asyncIterator](): AsyncGenerator<Item>;
+}
+/**
+ * This subclass of Promise will resolve to an instantiated Page once the request completes.
+ *
+ * It also implements AsyncIterable to allow auto-paginating iteration on an unawaited list call, eg:
+ *
+ *    for await (const item of client.items.list()) {
+ *      console.log(item)
+ *    }
+ */
+export declare class PagePromise<PageClass extends AbstractPage<Item>, Item = ReturnType<PageClass['getPaginatedItems']>[number]> extends APIPromise<PageClass> implements AsyncIterable<Item> {
+    constructor(client: OpenAI, request: Promise<APIResponseProps>, Page: new (...args: ConstructorParameters<typeof AbstractPage>) => PageClass);
+    /**
+     * Allow auto-paginating iteration on an unawaited list call, eg:
+     *
+     *    for await (const item of client.items.list()) {
+     *      console.log(item)
+     *    }
+     */
+    [Symbol.asyncIterator](): AsyncGenerator<Item>;
+}
+export interface PageResponse<Item> {
+    data: Array<Item>;
+    object: string;
+}
+/**
+ * Note: no pagination actually occurs yet, this is for forwards-compatibility.
+ */
+export declare class Page<Item> extends AbstractPage<Item> implements PageResponse<Item> {
+    data: Array<Item>;
+    object: string;
+    constructor(client: OpenAI, response: Response, body: PageResponse<Item>, options: FinalRequestOptions);
+    getPaginatedItems(): Item[];
+    nextPageRequestOptions(): PageRequestOptions | null;
+}
+export interface CursorPageResponse<Item> {
+    data: Array<Item>;
+    has_more: boolean;
+}
+export interface CursorPageParams {
+    after?: string;
+    limit?: number;
+}
+export declare class CursorPage<Item extends {
+    id: string;
+}> extends AbstractPage<Item> implements CursorPageResponse<Item> {
+    data: Array<Item>;
+    has_more: boolean;
+    constructor(client: OpenAI, response: Response, body: CursorPageResponse<Item>, options: FinalRequestOptions);
+    getPaginatedItems(): Item[];
+    hasNextPage(): boolean;
+    nextPageRequestOptions(): PageRequestOptions | null;
+}
+export interface ConversationCursorPageResponse<Item> {
+    data: Array<Item>;
+    has_more: boolean;
+    last_id: string;
+}
+export interface ConversationCursorPageParams {
+    after?: string;
+    limit?: number;
+}
+export declare class ConversationCursorPage<Item> extends AbstractPage<Item> implements ConversationCursorPageResponse<Item> {
+    data: Array<Item>;
+    has_more: boolean;
+    last_id: string;
+    constructor(client: OpenAI, response: Response, body: ConversationCursorPageResponse<Item>, options: FinalRequestOptions);
+    getPaginatedItems(): Item[];
+    hasNextPage(): boolean;
+    nextPageRequestOptions(): PageRequestOptions | null;
+}
+//# sourceMappingURL=pagination.d.ts.map

package/types/node_modules/openai/core/resource.d.mts

@@ -0,0 +1,6 @@
+import type { OpenAI } from "../client.mjs";
+export declare abstract class APIResource {
+    protected _client: OpenAI;
+    constructor(client: OpenAI);
+}
+//# sourceMappingURL=resource.d.mts.map

package/types/node_modules/openai/core/resource.d.ts

@@ -0,0 +1,6 @@
+import type { OpenAI } from "../client.js";
+export declare abstract class APIResource {
+    protected _client: OpenAI;
+    constructor(client: OpenAI);
+}
+//# sourceMappingURL=resource.d.ts.map

package/types/node_modules/openai/core/streaming.d.mts

@@ -0,0 +1,33 @@
+import { type ReadableStream } from "../internal/shim-types.mjs";
+import type { OpenAI } from "../client.mjs";
+export type ServerSentEvent = {
+    event: string | null;
+    data: string;
+    raw: string[];
+};
+export declare class Stream<Item> implements AsyncIterable<Item> {
+    #private;
+    private iterator;
+    controller: AbortController;
+    constructor(iterator: () => AsyncIterator<Item>, controller: AbortController, client?: OpenAI);
+    static fromSSEResponse<Item>(response: Response, controller: AbortController, client?: OpenAI): Stream<Item>;
+    /**
+     * Generates a Stream from a newline-separated ReadableStream
+     * where each item is a JSON value.
+     */
+    static fromReadableStream<Item>(readableStream: ReadableStream, controller: AbortController, client?: OpenAI): Stream<Item>;
+    [Symbol.asyncIterator](): AsyncIterator<Item>;
+    /**
+     * Splits the stream into two streams which can be
+     * independently read from at different speeds.
+     */
+    tee(): [Stream<Item>, Stream<Item>];
+    /**
+     * Converts this stream to a newline-separated ReadableStream of
+     * JSON stringified values in the stream
+     * which can be turned back into a Stream with `Stream.fromReadableStream()`.
+     */
+    toReadableStream(): ReadableStream;
+}
+export declare function _iterSSEMessages(response: Response, controller: AbortController): AsyncGenerator<ServerSentEvent, void, unknown>;
+//# sourceMappingURL=streaming.d.mts.map

package/types/node_modules/openai/core/streaming.d.ts

@@ -0,0 +1,33 @@
+import { type ReadableStream } from "../internal/shim-types.js";
+import type { OpenAI } from "../client.js";
+export type ServerSentEvent = {
+    event: string | null;
+    data: string;
+    raw: string[];
+};
+export declare class Stream<Item> implements AsyncIterable<Item> {
+    #private;
+    private iterator;
+    controller: AbortController;
+    constructor(iterator: () => AsyncIterator<Item>, controller: AbortController, client?: OpenAI);
+    static fromSSEResponse<Item>(response: Response, controller: AbortController, client?: OpenAI): Stream<Item>;
+    /**
+     * Generates a Stream from a newline-separated ReadableStream
+     * where each item is a JSON value.
+     */
+    static fromReadableStream<Item>(readableStream: ReadableStream, controller: AbortController, client?: OpenAI): Stream<Item>;
+    [Symbol.asyncIterator](): AsyncIterator<Item>;
+    /**
+     * Splits the stream into two streams which can be
+     * independently read from at different speeds.
+     */
+    tee(): [Stream<Item>, Stream<Item>];
+    /**
+     * Converts this stream to a newline-separated ReadableStream of
+     * JSON stringified values in the stream
+     * which can be turned back into a Stream with `Stream.fromReadableStream()`.
+     */
+    toReadableStream(): ReadableStream;
+}
+export declare function _iterSSEMessages(response: Response, controller: AbortController): AsyncGenerator<ServerSentEvent, void, unknown>;
+//# sourceMappingURL=streaming.d.ts.map

package/types/node_modules/openai/core/uploads.d.mts

@@ -0,0 +1,3 @@
+export { type Uploadable } from "../internal/uploads.mjs";
+export { toFile, type ToFileInput } from "../internal/to-file.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/types/node_modules/openai/core/uploads.d.ts

@@ -0,0 +1,3 @@
+export { type Uploadable } from "../internal/uploads.js";
+export { toFile, type ToFileInput } from "../internal/to-file.js";
+//# sourceMappingURL=uploads.d.ts.map

package/types/node_modules/openai/error.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/error.mjs";
+//# sourceMappingURL=error.d.mts.map

package/types/node_modules/openai/error.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/error.js";
+//# sourceMappingURL=error.d.ts.map

package/types/node_modules/openai/helpers/audio.d.mts

@@ -0,0 +1,9 @@
+export declare function playAudio(input: NodeJS.ReadableStream | Response | File): Promise<void>;
+type RecordAudioOptions = {
+    signal?: AbortSignal;
+    device?: number;
+    timeout?: number;
+};
+export declare function recordAudio(options?: RecordAudioOptions): Promise<File>;
+export {};
+//# sourceMappingURL=audio.d.mts.map

package/types/node_modules/openai/helpers/audio.d.ts

@@ -0,0 +1,9 @@
+export declare function playAudio(input: NodeJS.ReadableStream | Response | File): Promise<void>;
+type RecordAudioOptions = {
+    signal?: AbortSignal;
+    device?: number;
+    timeout?: number;
+};
+export declare function recordAudio(options?: RecordAudioOptions): Promise<File>;
+export {};
+//# sourceMappingURL=audio.d.ts.map

package/types/node_modules/openai/helpers/zod.d.mts

@@ -0,0 +1,70 @@
+import { ResponseFormatJSONSchema } from "../resources/index.mjs";
+import type { infer as zodInfer, ZodType } from 'zod/v3';
+import { AutoParseableResponseFormat, AutoParseableTextFormat, AutoParseableTool } from "../lib/parser.mjs";
+import { AutoParseableResponseTool } from "../lib/ResponsesParser.mjs";
+import { type ResponseFormatTextJSONSchemaConfig } from "../resources/responses/responses.mjs";
+/**
+ * Creates a chat completion `JSONSchema` response format object from
+ * the given Zod schema.
+ *
+ * If this is passed to the `.parse()`, `.stream()` or `.runTools()`
+ * chat completion methods then the response message will contain a
+ * `.parsed` property that is the result of parsing the content with
+ * the given Zod object.
+ *
+ * ```ts
+ * const completion = await client.chat.completions.parse({
+ *    model: 'gpt-4o-2024-08-06',
+ *    messages: [
+ *      { role: 'system', content: 'You are a helpful math tutor.' },
+ *      { role: 'user', content: 'solve 8x + 31 = 2' },
+ *    ],
+ *    response_format: zodResponseFormat(
+ *      z.object({
+ *        steps: z.array(z.object({
+ *          explanation: z.string(),
+ *          answer: z.string(),
+ *        })),
+ *        final_answer: z.string(),
+ *      }),
+ *      'math_answer',
+ *    ),
+ *  });
+ *  const message = completion.choices[0]?.message;
+ *  if (message?.parsed) {
+ *    console.log(message.parsed);
+ *    console.log(message.parsed.final_answer);
+ * }
+ * ```
+ *
+ * This can be passed directly to the `.create()` method but will not
+ * result in any automatic parsing, you'll have to parse the response yourself.
+ */
+export declare function zodResponseFormat<ZodInput extends ZodType>(zodObject: ZodInput, name: string, props?: Omit<ResponseFormatJSONSchema.JSONSchema, 'schema' | 'strict' | 'name'>): AutoParseableResponseFormat<zodInfer<ZodInput>>;
+export declare function zodTextFormat<ZodInput extends ZodType>(zodObject: ZodInput, name: string, props?: Omit<ResponseFormatTextJSONSchemaConfig, 'schema' | 'type' | 'strict' | 'name'>): AutoParseableTextFormat<zodInfer<ZodInput>>;
+/**
+ * Creates a chat completion `function` tool that can be invoked
+ * automatically by the chat completion `.runTools()` method or automatically
+ * parsed by `.parse()` / `.stream()`.
+ */
+export declare function zodFunction<Parameters extends ZodType>(options: {
+    name: string;
+    parameters: Parameters;
+    function?: ((args: zodInfer<Parameters>) => unknown | Promise<unknown>) | undefined;
+    description?: string | undefined;
+}): AutoParseableTool<{
+    arguments: Parameters;
+    name: string;
+    function: (args: zodInfer<Parameters>) => unknown;
+}>;
+export declare function zodResponsesFunction<Parameters extends ZodType>(options: {
+    name: string;
+    parameters: Parameters;
+    function?: ((args: zodInfer<Parameters>) => unknown | Promise<unknown>) | undefined;
+    description?: string | undefined;
+}): AutoParseableResponseTool<{
+    arguments: Parameters;
+    name: string;
+    function: (args: zodInfer<Parameters>) => unknown;
+}>;
+//# sourceMappingURL=zod.d.mts.map

package/types/node_modules/openai/helpers/zod.d.ts

@@ -0,0 +1,70 @@
+import { ResponseFormatJSONSchema } from "../resources/index.js";
+import type { infer as zodInfer, ZodType } from 'zod/v3';
+import { AutoParseableResponseFormat, AutoParseableTextFormat, AutoParseableTool } from "../lib/parser.js";
+import { AutoParseableResponseTool } from "../lib/ResponsesParser.js";
+import { type ResponseFormatTextJSONSchemaConfig } from "../resources/responses/responses.js";
+/**
+ * Creates a chat completion `JSONSchema` response format object from
+ * the given Zod schema.
+ *
+ * If this is passed to the `.parse()`, `.stream()` or `.runTools()`
+ * chat completion methods then the response message will contain a
+ * `.parsed` property that is the result of parsing the content with
+ * the given Zod object.
+ *
+ * ```ts
+ * const completion = await client.chat.completions.parse({
+ *    model: 'gpt-4o-2024-08-06',
+ *    messages: [
+ *      { role: 'system', content: 'You are a helpful math tutor.' },
+ *      { role: 'user', content: 'solve 8x + 31 = 2' },
+ *    ],
+ *    response_format: zodResponseFormat(
+ *      z.object({
+ *        steps: z.array(z.object({
+ *          explanation: z.string(),
+ *          answer: z.string(),
+ *        })),
+ *        final_answer: z.string(),
+ *      }),
+ *      'math_answer',
+ *    ),
+ *  });
+ *  const message = completion.choices[0]?.message;
+ *  if (message?.parsed) {
+ *    console.log(message.parsed);
+ *    console.log(message.parsed.final_answer);
+ * }
+ * ```
+ *
+ * This can be passed directly to the `.create()` method but will not
+ * result in any automatic parsing, you'll have to parse the response yourself.
+ */
+export declare function zodResponseFormat<ZodInput extends ZodType>(zodObject: ZodInput, name: string, props?: Omit<ResponseFormatJSONSchema.JSONSchema, 'schema' | 'strict' | 'name'>): AutoParseableResponseFormat<zodInfer<ZodInput>>;
+export declare function zodTextFormat<ZodInput extends ZodType>(zodObject: ZodInput, name: string, props?: Omit<ResponseFormatTextJSONSchemaConfig, 'schema' | 'type' | 'strict' | 'name'>): AutoParseableTextFormat<zodInfer<ZodInput>>;
+/**
+ * Creates a chat completion `function` tool that can be invoked
+ * automatically by the chat completion `.runTools()` method or automatically
+ * parsed by `.parse()` / `.stream()`.
+ */
+export declare function zodFunction<Parameters extends ZodType>(options: {
+    name: string;
+    parameters: Parameters;
+    function?: ((args: zodInfer<Parameters>) => unknown | Promise<unknown>) | undefined;
+    description?: string | undefined;
+}): AutoParseableTool<{
+    arguments: Parameters;
+    name: string;
+    function: (args: zodInfer<Parameters>) => unknown;
+}>;
+export declare function zodResponsesFunction<Parameters extends ZodType>(options: {
+    name: string;
+    parameters: Parameters;
+    function?: ((args: zodInfer<Parameters>) => unknown | Promise<unknown>) | undefined;
+    description?: string | undefined;
+}): AutoParseableResponseTool<{
+    arguments: Parameters;
+    name: string;
+    function: (args: zodInfer<Parameters>) => unknown;
+}>;
+//# sourceMappingURL=zod.d.ts.map