@glexir/sdk 0.0.0-stage → 0.2.0

package/dist/resources/embeddings.js

@@ -0,0 +1,34 @@
+import { APIResource } from '../core/resource.js';
+/** Decodes a base64 little-endian float32 vector. */
+export function decodeBase64Embedding(base64) {
+    const binary = atob(base64);
+    const bytes = new Uint8Array(binary.length);
+    for (let i = 0; i < binary.length; i++)
+        bytes[i] = binary.charCodeAt(i);
+    const view = new DataView(bytes.buffer);
+    const out = new Array(bytes.length / 4);
+    for (let i = 0; i < out.length; i++)
+        out[i] = view.getFloat32(i * 4, true);
+    return out;
+}
+export class Embeddings extends APIResource {
+    /**
+     * Creates embedding vectors. When `encoding_format` is omitted the SDK requests compact
+     * base64 on the wire and decodes it to `number[]`, as OpenAI's SDK does.
+     */
+    create(body, options) {
+        if (body.encoding_format !== undefined) {
+            return this.client.post('/embeddings', { ...options, body });
+        }
+        return this.client
+            .post('/embeddings', { ...options, body: { ...body, encoding_format: 'base64' } })
+            ._thenUnwrap((response) => {
+            for (const item of response.data) {
+                if (typeof item.embedding === 'string')
+                    item.embedding = decodeBase64Embedding(item.embedding);
+            }
+            return response;
+        });
+    }
+}
+//# sourceMappingURL=embeddings.js.map

package/dist/resources/embeddings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"embeddings.js","sourceRoot":"","sources":["../../src/resources/embeddings.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,qDAAqD;AACrD,MAAM,UAAU,qBAAqB,CAAC,MAAc;IAClD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;IAC5B,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACxE,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,GAAG,GAAa,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3E,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,OAAO,UAAW,SAAQ,WAAW;IAGzC;;;OAGG;IACH,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAC1D,IAAI,IAAI,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,IAAI,CAAC,MAAM;aACf,IAAI,CAA6C,aAAa,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,EAAE,GAAG,IAAI,EAAE,eAAe,EAAE,QAAQ,EAAE,EAAE,CAAC;aAC7H,WAAW,CAAC,CAAC,QAAQ,EAAE,EAAE;YACxB,KAAK,MAAM,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACjC,IAAI,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ;oBAAE,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACjG,CAAC;YACD,OAAO,QAAmC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACP,CAAC;CACF"}

package/dist/resources/files.d.ts

@@ -0,0 +1,15 @@
+import type { APIPromise } from '../core/api-promise.js';
+import type { PagePromise } from '../core/pagination.js';
+import type { RequestOptions } from '../core/request-options.js';
+import { APIResource } from '../core/resource.js';
+import type { FileCreateParams, FileDeleted, FileListParams, FileObject } from '../types/platform.js';
+/** Upload files for model input (`user_data`) or batch jobs (`batch`). */
+export declare class Files extends APIResource {
+    create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileObject>;
+    retrieve(fileId: string, options?: RequestOptions): APIPromise<FileObject>;
+    /** Lists your files. Iterate with `for await` to page through all of them. */
+    list(query?: FileListParams, options?: RequestOptions): PagePromise<FileObject>;
+    delete(fileId: string, options?: RequestOptions): APIPromise<FileDeleted>;
+    /** Downloads a file's contents (e.g. batch output). Returns the raw `Response`; use `.text()`, `.arrayBuffer()` or `.body`. */
+    content(fileId: string, options?: RequestOptions): APIPromise<Response>;
+}

package/dist/resources/files.js

@@ -0,0 +1,27 @@
+import { APIResource } from '../core/resource.js';
+const encode = encodeURIComponent;
+/** Upload files for model input (`user_data`) or batch jobs (`batch`). */
+export class Files extends APIResource {
+    create(body, options) {
+        return this.client.post('/files', { ...options, body, multipart: true });
+    }
+    retrieve(fileId, options) {
+        return this.client.get(`/files/${encode(fileId)}`, options);
+    }
+    /** Lists your files. Iterate with `for await` to page through all of them. */
+    list(query = {}, options) {
+        return this.client.requestAPIList({ ...options, method: 'get', path: '/files', query: { ...query } }, 'last-item-id');
+    }
+    delete(fileId, options) {
+        return this.client.delete(`/files/${encode(fileId)}`, options);
+    }
+    /** Downloads a file's contents (e.g. batch output). Returns the raw `Response`; use `.text()`, `.arrayBuffer()` or `.body`. */
+    content(fileId, options) {
+        return this.client.get(`/files/${encode(fileId)}/content`, {
+            ...options,
+            binary: true,
+            headers: { accept: 'application/binary', ...options?.headers },
+        });
+    }
+}
+//# sourceMappingURL=files.js.map

package/dist/resources/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../src/resources/files.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,MAAM,MAAM,GAAG,kBAAkB,CAAC;AAElC,0EAA0E;AAC1E,MAAM,OAAO,KAAM,SAAQ,WAAW;IACpC,MAAM,CAAC,IAAsB,EAAE,OAAwB;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,QAAQ,CAAC,MAAc,EAAE,OAAwB;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,8EAA8E;IAC9E,IAAI,CAAC,QAAwB,EAAE,EAAE,OAAwB;QACvD,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAa,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;IACpI,CAAC;IAED,MAAM,CAAC,MAAc,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED,+HAA+H;IAC/H,OAAO,CAAC,MAAc,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;YACzD,GAAG,OAAO;YACV,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE;SAC/D,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/resources/models.d.ts

@@ -0,0 +1,10 @@
+import type { APIPromise } from '../core/api-promise.js';
+import type { PagePromise } from '../core/pagination.js';
+import type { RequestOptions } from '../core/request-options.js';
+import { APIResource } from '../core/resource.js';
+import type { Model } from '../types/platform.js';
+export declare class Models extends APIResource {
+    /** Models available to your Glexir key. */
+    list(options?: RequestOptions): PagePromise<Model>;
+    retrieve(model: string, options?: RequestOptions): APIPromise<Model>;
+}

package/dist/resources/models.js

@@ -0,0 +1,11 @@
+import { APIResource } from '../core/resource.js';
+export class Models extends APIResource {
+    /** Models available to your Glexir key. */
+    list(options) {
+        return this.client.requestAPIList({ ...options, method: 'get', path: '/models' }, 'none');
+    }
+    retrieve(model, options) {
+        return this.client.get(`/models/${encodeURIComponent(model)}`, options);
+    }
+}
+//# sourceMappingURL=models.js.map

package/dist/resources/models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/resources/models.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAGlD,MAAM,OAAO,MAAO,SAAQ,WAAW;IACrC,2CAA2C;IAC3C,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAAQ,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,MAAM,CAAC,CAAC;IACnG,CAAC;IAED,QAAQ,CAAC,KAAa,EAAE,OAAwB;QAC9C,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,kBAAkB,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/dist/resources/responses.d.ts

@@ -0,0 +1,61 @@
+import type { APIPromise } from '../core/api-promise.js';
+import type { PagePromise } from '../core/pagination.js';
+import type { RequestOptions } from '../core/request-options.js';
+import { APIResource } from '../core/resource.js';
+import type { Stream } from '../core/streaming.js';
+import { ResponseStream } from '../lib/response-stream.js';
+import type { CompactedResponse, InputItemListParams, InputTokenCountParams, InputTokenCountResponse, Response, ResponseCompactParams, ResponseCreateParams, ResponseCreateParamsBase, ResponseCreateParamsNonStreaming, ResponseCreateParamsStreaming, ResponseItem, ResponseRetrieveParams, ResponseStreamEvent } from '../types/responses.js';
+export interface ParseOptions<T> extends RequestOptions {
+    /** Validate/transform the parsed JSON (e.g. `schema.parse` from zod). */
+    validate?: (value: unknown) => T;
+}
+export interface ParsedResponse<T> extends Response {
+    /** The parsed structured output, or `null` when the model refused. */
+    output_parsed: T | null;
+}
+/** Resume a background response that was created with `stream: true`. */
+export interface ResponseStreamResumeParams {
+    response_id: string;
+    starting_after?: number;
+}
+export type ResponseStreamParams = (ResponseCreateParamsBase & {
+    stream?: true;
+}) | ResponseStreamResumeParams;
+export declare class InputItems extends APIResource {
+    /** Lists the input items of a stored response. Iterate with `for await` to page through all of them. */
+    list(responseId: string, query?: InputItemListParams, options?: RequestOptions): PagePromise<ResponseItem>;
+}
+export declare class InputTokens extends APIResource {
+    /** Counts input tokens for a would-be request without generating output. */
+    count(body?: InputTokenCountParams, options?: RequestOptions): APIPromise<InputTokenCountResponse>;
+}
+/** The Responses API: OpenAI's recommended interface for text generation, reasoning and tool calling. */
+export declare class Responses extends APIResource {
+    readonly inputItems: InputItems;
+    readonly inputTokens: InputTokens;
+    create(body: ResponseCreateParamsNonStreaming, options?: RequestOptions): APIPromise<Response>;
+    create(body: ResponseCreateParamsStreaming, options?: RequestOptions): APIPromise<Stream<ResponseStreamEvent>>;
+    create(body: ResponseCreateParams, options?: RequestOptions): APIPromise<Response | Stream<ResponseStreamEvent>>;
+    retrieve(responseId: string, query?: ResponseRetrieveParams & {
+        stream?: false;
+    }, options?: RequestOptions): APIPromise<Response>;
+    retrieve(responseId: string, query: ResponseRetrieveParams & {
+        stream: true;
+    }, options?: RequestOptions): APIPromise<Stream<ResponseStreamEvent>>;
+    delete(responseId: string, options?: RequestOptions): APIPromise<void>;
+    /** Cancels a background response. Calling it again returns the final response. */
+    cancel(responseId: string, options?: RequestOptions): APIPromise<Response>;
+    /** Compacts a conversation into an opaque `compaction` item you can pass as input later. */
+    compact(body: ResponseCompactParams, options?: RequestOptions): APIPromise<CompactedResponse>;
+    /**
+     * Streams a response with an accumulating helper. Pass create params, or
+     * `{ response_id, starting_after }` to resume a background response created with `stream: true`.
+     */
+    stream(params: ResponseStreamParams, options?: RequestOptions): ResponseStream;
+    /**
+     * Creates a response and parses the structured output when `text.format` is `json_schema`
+     * (or `json_object`). Throws if the output was truncated or filtered.
+     */
+    parse<T = unknown>(body: ResponseCreateParamsNonStreaming, options?: ParseOptions<T>): Promise<ParsedResponse<T>>;
+}
+export declare function parseResponseOutput<T>(response: Response, body: Pick<ResponseCreateParamsNonStreaming, 'text'>, validate?: (value: unknown) => T): ParsedResponse<T>;

package/dist/resources/responses.js

@@ -0,0 +1,85 @@
+import { ContentFilterFinishReasonError, LengthFinishReasonError } from '../core/errors.js';
+import { APIResource } from '../core/resource.js';
+import { addOutputText } from '../lib/output-text.js';
+import { ResponseStream } from '../lib/response-stream.js';
+const encode = encodeURIComponent;
+export class InputItems extends APIResource {
+    /** Lists the input items of a stored response. Iterate with `for await` to page through all of them. */
+    list(responseId, query = {}, options) {
+        return this.client.requestAPIList({ ...options, method: 'get', path: `/responses/${encode(responseId)}/input_items`, query: { ...query } }, 'last-item-id');
+    }
+}
+export class InputTokens extends APIResource {
+    /** Counts input tokens for a would-be request without generating output. */
+    count(body = {}, options) {
+        return this.client.post('/responses/input_tokens', { ...options, body });
+    }
+}
+/** The Responses API: OpenAI's recommended interface for text generation, reasoning and tool calling. */
+export class Responses extends APIResource {
+    inputItems = new InputItems(this.client);
+    inputTokens = new InputTokens(this.client);
+    create(body, options) {
+        if (body.stream) {
+            return this.client.post('/responses', { ...options, body, stream: true });
+        }
+        return this.client.post('/responses', { ...options, body })._thenUnwrap((r) => addOutputText(r));
+    }
+    retrieve(responseId, query = {}, options) {
+        const path = `/responses/${encode(responseId)}`;
+        if (query.stream) {
+            return this.client.get(path, { ...options, query: { ...query }, stream: true });
+        }
+        return this.client.get(path, { ...options, query: { ...query } })._thenUnwrap((r) => addOutputText(r));
+    }
+    delete(responseId, options) {
+        return this.client.delete(`/responses/${encode(responseId)}`, { ...options, headers: { accept: '*/*', ...options?.headers } });
+    }
+    /** Cancels a background response. Calling it again returns the final response. */
+    cancel(responseId, options) {
+        return this.client.post(`/responses/${encode(responseId)}/cancel`, options)._thenUnwrap((r) => addOutputText(r));
+    }
+    /** Compacts a conversation into an opaque `compaction` item you can pass as input later. */
+    compact(body, options) {
+        return this.client.post('/responses/compact', { ...options, body });
+    }
+    /**
+     * Streams a response with an accumulating helper. Pass create params, or
+     * `{ response_id, starting_after }` to resume a background response created with `stream: true`.
+     */
+    stream(params, options) {
+        if (!('model' in params) && typeof params.response_id === 'string') {
+            const resume = params;
+            const query = { stream: true };
+            if (resume.starting_after !== undefined)
+                query.starting_after = resume.starting_after;
+            return new ResponseStream(this.retrieve(resume.response_id, query, options));
+        }
+        return new ResponseStream(this.create({ ...params, stream: true }, options));
+    }
+    /**
+     * Creates a response and parses the structured output when `text.format` is `json_schema`
+     * (or `json_object`). Throws if the output was truncated or filtered.
+     */
+    async parse(body, options = {}) {
+        const { validate, ...requestOptions } = options;
+        const response = await this.create(body, requestOptions);
+        return parseResponseOutput(response, body, validate);
+    }
+}
+export function parseResponseOutput(response, body, validate) {
+    const reason = response.incomplete_details?.reason;
+    if (reason === 'max_output_tokens')
+        throw new LengthFinishReasonError();
+    if (reason === 'content_filter')
+        throw new ContentFilterFinishReasonError();
+    const format = body.text?.format?.type;
+    const refused = response.output.some((item) => item.type === 'message' && item.content.some((p) => p.type === 'refusal'));
+    let parsed = null;
+    if (!refused && (format === 'json_schema' || format === 'json_object')) {
+        const value = JSON.parse(response.output_text);
+        parsed = validate ? validate(value) : value;
+    }
+    return Object.assign(response, { output_parsed: parsed });
+}
+//# sourceMappingURL=responses.js.map

package/dist/resources/responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../src/resources/responses.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,8BAA8B,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAC;AAG5F,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAmC3D,MAAM,MAAM,GAAG,kBAAkB,CAAC;AAElC,MAAM,OAAO,UAAW,SAAQ,WAAW;IACzC,wGAAwG;IACxG,IAAI,CAAC,UAAkB,EAAE,QAA6B,EAAE,EAAE,OAAwB;QAChF,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,CAC/B,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,cAAc,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,EACxG,cAAc,CACf,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C,4EAA4E;IAC5E,KAAK,CAAC,OAA8B,EAAE,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3E,CAAC;CACF;AAED,yGAAyG;AACzG,MAAM,OAAO,SAAU,SAAQ,WAAW;IAC/B,UAAU,GAAe,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrD,WAAW,GAAgB,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAKjE,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAA8B,YAAY,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACzG,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAW,YAAY,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7G,CAAC;IAQD,QAAQ,CACN,UAAkB,EAClB,QAAuD,EAAE,EACzD,OAAwB;QAExB,MAAM,IAAI,GAAG,cAAc,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QAChD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA8B,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/G,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAW,IAAI,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IACnH,CAAC;IAED,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;IACjI,CAAC;IAED,kFAAkF;IAClF,MAAM,CAAC,UAAkB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAW,cAAc,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7H,CAAC;IAED,4FAA4F;IAC5F,OAAO,CAAC,IAA2B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,MAA4B,EAAE,OAAwB;QAC3D,IAAI,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,OAAO,MAAM,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YACnE,MAAM,MAAM,GAAG,MAAoC,CAAC;YACpD,MAAM,KAAK,GAA8C,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YAC1E,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS;gBAAE,KAAK,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;YACtF,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;QAC/E,CAAC;QACD,OAAO,IAAI,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAI,MAAmC,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;IAC7G,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAc,IAAsC,EAAE,UAA2B,EAAE;QAC5F,MAAM,EAAE,QAAQ,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,CAAC;QAChD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QACzD,OAAO,mBAAmB,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,UAAU,mBAAmB,CACjC,QAAkB,EAClB,IAAoD,EACpD,QAAgC;IAEhC,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAC;IACnD,IAAI,MAAM,KAAK,mBAAmB;QAAE,MAAM,IAAI,uBAAuB,EAAE,CAAC;IACxE,IAAI,MAAM,KAAK,gBAAgB;QAAE,MAAM,IAAI,8BAA8B,EAAE,CAAC;IAE5E,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC;IACvC,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC;IAC1H,IAAI,MAAM,GAAa,IAAI,CAAC;IAC5B,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,KAAK,aAAa,IAAI,MAAM,KAAK,aAAa,CAAC,EAAE,CAAC;QACvE,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACxD,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAAW,CAAC;IACrD,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,CAAC;AAC5D,CAAC"}

package/dist/types/audio.d.ts

@@ -0,0 +1,172 @@
+import type { Uploadable } from '../core/multipart.js';
+/**
+ * Speech-to-text models. Start with `gpt-transcribe`; every other model listed here
+ * shuts down on 2027-02-26.
+ */
+export type TranscriptionModel = 'gpt-transcribe' | 'gpt-4o-transcribe' | 'gpt-4o-mini-transcribe' | 'gpt-4o-mini-transcribe-2025-12-15' | 'gpt-4o-transcribe-diarize' | 'whisper-1' | (string & {});
+export type AudioResponseFormat = 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt' | 'diarized_json';
+export interface VadConfig {
+    type: 'server_vad';
+    /** Audio to include before detected speech, in milliseconds. */
+    prefix_padding_ms?: number;
+    /** Silence that ends a speech segment, in milliseconds. */
+    silence_duration_ms?: number;
+    /** Detection sensitivity, 0.0–1.0. */
+    threshold?: number;
+}
+export interface TranscriptionCreateParamsBase {
+    /**
+     * Audio file, at most 25 MB: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav or webm. The format
+     * is detected from the filename, so use a `File` or `toFile(data, "name.ext")`.
+     */
+    file: Uploadable;
+    model: TranscriptionModel;
+    response_format?: AudioResponseFormat;
+    /** ISO-639-1 code. With `gpt-transcribe`, use `languages` instead (not both). */
+    language?: string;
+    /** Candidate languages (`gpt-transcribe`). Accepts ISO 639-1, some ISO 639-3, and `zh-cn` / `zh-tw` / `zh-hk`. */
+    languages?: string[];
+    /** Domain terms to bias recognition (`gpt-transcribe`). Entries must not contain `<`, `>`, CR or LF. */
+    keywords?: string[];
+    /** Context or previous transcript; should match the audio language. Not supported by the diarize model. */
+    prompt?: string;
+    /** 0–1. 0 lets the model pick automatically. */
+    temperature?: number;
+    /** Requires `response_format: "verbose_json"` (whisper-1 only). */
+    timestamp_granularities?: Array<'word' | 'segment'>;
+    /** `logprobs` works with `json` output on gpt-4o-transcribe models. */
+    include?: Array<'logprobs'>;
+    /** Required for the diarize model when audio is longer than 30 seconds. */
+    chunking_strategy?: 'auto' | VadConfig;
+    /** Up to 4 speaker labels for diarization, e.g. `customer`, `agent`. */
+    known_speaker_names?: string[];
+    /** `data:` URLs of 2–10 second samples, matching `known_speaker_names`. */
+    known_speaker_references?: string[];
+    stream?: boolean | null;
+    [key: string]: unknown;
+}
+export interface TranscriptionLogprob {
+    token?: string;
+    bytes?: number[];
+    logprob?: number;
+}
+export interface TranscriptionTokenUsage {
+    type: 'tokens';
+    input_tokens: number;
+    output_tokens: number;
+    total_tokens: number;
+    input_token_details?: {
+        audio_tokens?: number;
+        text_tokens?: number;
+    };
+}
+export interface TranscriptionDurationUsage {
+    type: 'duration';
+    /** Audio duration billed, in seconds. */
+    seconds: number;
+}
+export type TranscriptionUsage = TranscriptionTokenUsage | TranscriptionDurationUsage;
+/** `response_format: "json"` (the default). */
+export interface Transcription {
+    text: string;
+    /** Detected languages (`gpt-transcribe`); empty when detection was unreliable. */
+    languages?: Array<{
+        code: string;
+    }>;
+    logprobs?: TranscriptionLogprob[];
+    usage?: TranscriptionUsage;
+    _request_id?: string | null;
+}
+export interface TranscriptionSegment {
+    id: number;
+    seek: number;
+    start: number;
+    end: number;
+    text: string;
+    tokens: number[];
+    temperature: number;
+    avg_logprob: number;
+    compression_ratio: number;
+    no_speech_prob: number;
+}
+export interface TranscriptionWord {
+    word: string;
+    start: number;
+    end: number;
+}
+/** `response_format: "verbose_json"`. */
+export interface TranscriptionVerbose {
+    duration: number;
+    language: string;
+    text: string;
+    segments?: TranscriptionSegment[];
+    words?: TranscriptionWord[];
+    usage?: TranscriptionDurationUsage;
+    _request_id?: string | null;
+}
+export interface TranscriptionDiarizedSegment {
+    id: string;
+    type: 'transcript.text.segment';
+    start: number;
+    end: number;
+    text: string;
+    /** A `known_speaker_names` value, otherwise `A`, `B`, ... */
+    speaker: string;
+}
+/** `response_format: "diarized_json"` (gpt-4o-transcribe-diarize). */
+export interface TranscriptionDiarized {
+    task: 'transcribe';
+    duration: number;
+    text: string;
+    segments: TranscriptionDiarizedSegment[];
+    usage?: TranscriptionUsage;
+    _request_id?: string | null;
+}
+export interface TranscriptionTextDeltaEvent {
+    type: 'transcript.text.delta';
+    delta: string;
+    logprobs?: TranscriptionLogprob[];
+    /** Diarization only. */
+    segment_id?: string;
+}
+export interface TranscriptionTextDoneEvent {
+    type: 'transcript.text.done';
+    text: string;
+    languages?: Array<{
+        code: string;
+    }>;
+    logprobs?: TranscriptionLogprob[];
+    usage?: TranscriptionUsage;
+}
+/** Emitted with the diarize model and `response_format: "diarized_json"`. */
+export interface TranscriptionTextSegmentEvent {
+    type: 'transcript.text.segment';
+    id: string;
+    start: number;
+    end: number;
+    speaker: string;
+    text: string;
+}
+export type TranscriptionStreamEvent = TranscriptionTextDeltaEvent | TranscriptionTextDoneEvent | TranscriptionTextSegmentEvent;
+/** @deprecated `/audio/translations` shuts down on 2027-02-26. */
+export interface TranslationCreateParams {
+    file: Uploadable;
+    /** Only `whisper-1`. */
+    model: 'whisper-1' | (string & {});
+    /** Should be in English. */
+    prompt?: string;
+    response_format?: 'json' | 'text' | 'srt' | 'verbose_json' | 'vtt';
+    temperature?: number;
+    [key: string]: unknown;
+}
+export interface Translation {
+    text: string;
+    _request_id?: string | null;
+}
+export interface TranslationVerbose {
+    duration: number;
+    language: string;
+    text: string;
+    segments?: TranscriptionSegment[];
+    _request_id?: string | null;
+}

package/dist/types/audio.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=audio.js.map

package/dist/types/audio.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"audio.js","sourceRoot":"","sources":["../../src/types/audio.ts"],"names":[],"mappings":""}