OpenAI API

/**
 * OpenAIAPI - generated by OmniStream from OpenAI API's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/openai";

export class OpenAIAPIError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `OpenAIAPI error ${status}`);
    this.name = "OpenAIAPIError";
    this.status = status;
    this.code = code;
  }
}

export interface OpenAIAPIOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class OpenAIAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: OpenAIAPIOptions = {}) {
    if (!token) throw new Error("OpenAIAPI: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new OpenAIAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Transcribes audio into the input language. */
  createTranscription(): Promise<any> {
    return this._request("POST", "/audio/transcriptions", {  });
  }

  /** Translates audio into into English. */
  createTranslation(): Promise<any> {
    return this._request("POST", "/audio/translations", {  });
  }

  /** Creates a completion for the chat message */
  createChatCompletion(body: unknown): Promise<any> {
    return this._request("POST", "/chat/completions", { body });
  }

  /** Creates a completion for the provided prompt and parameters */
  createCompletion(body: unknown): Promise<any> {
    return this._request("POST", "/completions", { body });
  }

  /** Creates a new edit for the provided input, instruction, and parameters. */
  createEdit(body: unknown): Promise<any> {
    return this._request("POST", "/edits", { body });
  }

  /** Creates an embedding vector representing the input text. */
  createEmbedding(body: unknown): Promise<any> {
    return this._request("POST", "/embeddings", { body });
  }

  /** Returns a list of files that belong to the user's organization. */
  listFiles(): Promise<any> {
    return this._request("GET", "/files", {});
  }

  /** Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.
 */
  createFile(): Promise<any> {
    return this._request("POST", "/files", {  });
  }

  /** Returns information about a specific file. */
  retrieveFile(params: { "file_id": string }): Promise<any> {
    return this._request("GET", "/files/{file_id}", { params });
  }

  /** Delete a file. */
  deleteFile(params: { "file_id": string }): Promise<any> {
    return this._request("DELETE", "/files/{file_id}", { params });
  }

  /** Returns the contents of the specified file */
  downloadFile(params: { "file_id": string }): Promise<any> {
    return this._request("GET", "/files/{file_id}/content", { params });
  }

  /** List your organization's fine-tuning jobs
 */
  listFineTunes(): Promise<any> {
    return this._request("GET", "/fine-tunes", {});
  }

  /** Creates a job that fine-tunes a specified model from a given dataset.

Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.

[Learn more about Fine-tuning](/docs/guides/fine-tuning)
 */
  createFineTune(body: unknown): Promise<any> {
    return this._request("POST", "/fine-tunes", { body });
  }

  /** Gets info about the fine-tune job.

[Learn more about Fine-tuning](/docs/guides/fine-tuning)
 */
  retrieveFineTune(params: { "fine_tune_id": string }): Promise<any> {
    return this._request("GET", "/fine-tunes/{fine_tune_id}", { params });
  }

  /** Immediately cancel a fine-tune job.
 */
  cancelFineTune(params: { "fine_tune_id": string }): Promise<any> {
    return this._request("POST", "/fine-tunes/{fine_tune_id}/cancel", { params });
  }

  /** Get fine-grained status updates for a fine-tune job.
 */
  listFineTuneEvents(params: { "fine_tune_id": string; "stream"?: boolean }): Promise<any> {
    return this._request("GET", "/fine-tunes/{fine_tune_id}/events", { params });
  }

  /** Creates an edited or extended image given an original image and a prompt. */
  createImageEdit(): Promise<any> {
    return this._request("POST", "/images/edits", {  });
  }

  /** Creates an image given a prompt. */
  createImage(body: unknown): Promise<any> {
    return this._request("POST", "/images/generations", { body });
  }

  /** Creates a variation of a given image. */
  createImageVariation(): Promise<any> {
    return this._request("POST", "/images/variations", {  });
  }

  /** Lists the currently available models, and provides basic information about each one such as the owner and availability. */
  listModels(): Promise<any> {
    return this._request("GET", "/models", {});
  }

  /** Retrieves a model instance, providing basic information about the model such as the owner and permissioning. */
  retrieveModel(params: { "model": string }): Promise<any> {
    return this._request("GET", "/models/{model}", { params });
  }

  /** Delete a fine-tuned model. You must have the Owner role in your organization. */
  deleteModel(params: { "model": string }): Promise<any> {
    return this._request("DELETE", "/models/{model}", { params });
  }

  /** Classifies if text violates OpenAI's Content Policy */
  createModeration(body: unknown): Promise<any> {
    return this._request("POST", "/moderations", { body });
  }
}

export default OpenAIAPI;