openlayer 0.0.0 → 0.0.1-alpha.1

package/src/error.ts

@@ -0,0 +1,146 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { castToError, Headers } from './core';
+
+export class OpenlayerError extends Error {}
+
+export class APIError extends OpenlayerError {
+  readonly status: number | undefined;
+  readonly headers: Headers | undefined;
+  readonly error: Object | undefined;
+
+  constructor(
+    status: number | undefined,
+    error: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    super(`${APIError.makeMessage(status, error, message)}`);
+    this.status = status;
+    this.headers = headers;
+    this.error = error;
+  }
+
+  private static makeMessage(status: number | undefined, error: any, message: string | undefined) {
+    const msg =
+      error?.message ?
+        typeof error.message === 'string' ?
+          error.message
+        : JSON.stringify(error.message)
+      : error ? JSON.stringify(error)
+      : message;
+
+    if (status && msg) {
+      return `${status} ${msg}`;
+    }
+    if (status) {
+      return `${status} status code (no body)`;
+    }
+    if (msg) {
+      return msg;
+    }
+    return '(no status code or body)';
+  }
+
+  static generate(
+    status: number | undefined,
+    errorResponse: Object | undefined,
+    message: string | undefined,
+    headers: Headers | undefined,
+  ) {
+    if (!status) {
+      return new APIConnectionError({ cause: castToError(errorResponse) });
+    }
+
+    const error = errorResponse as Record<string, any>;
+
+    if (status === 400) {
+      return new BadRequestError(status, error, message, headers);
+    }
+
+    if (status === 401) {
+      return new AuthenticationError(status, error, message, headers);
+    }
+
+    if (status === 403) {
+      return new PermissionDeniedError(status, error, message, headers);
+    }
+
+    if (status === 404) {
+      return new NotFoundError(status, error, message, headers);
+    }
+
+    if (status === 409) {
+      return new ConflictError(status, error, message, headers);
+    }
+
+    if (status === 422) {
+      return new UnprocessableEntityError(status, error, message, headers);
+    }
+
+    if (status === 429) {
+      return new RateLimitError(status, error, message, headers);
+    }
+
+    if (status >= 500) {
+      return new InternalServerError(status, error, message, headers);
+    }
+
+    return new APIError(status, error, message, headers);
+  }
+}
+
+export class APIUserAbortError extends APIError {
+  override readonly status: undefined = undefined;
+
+  constructor({ message }: { message?: string } = {}) {
+    super(undefined, undefined, message || 'Request was aborted.', undefined);
+  }
+}
+
+export class APIConnectionError extends APIError {
+  override readonly status: undefined = undefined;
+
+  constructor({ message, cause }: { message?: string; cause?: Error | undefined }) {
+    super(undefined, undefined, message || 'Connection error.', undefined);
+    // in some environments the 'cause' property is already declared
+    // @ts-ignore
+    if (cause) this.cause = cause;
+  }
+}
+
+export class APIConnectionTimeoutError extends APIConnectionError {
+  constructor({ message }: { message?: string } = {}) {
+    super({ message: message ?? 'Request timed out.' });
+  }
+}
+
+export class BadRequestError extends APIError {
+  override readonly status: 400 = 400;
+}
+
+export class AuthenticationError extends APIError {
+  override readonly status: 401 = 401;
+}
+
+export class PermissionDeniedError extends APIError {
+  override readonly status: 403 = 403;
+}
+
+export class NotFoundError extends APIError {
+  override readonly status: 404 = 404;
+}
+
+export class ConflictError extends APIError {
+  override readonly status: 409 = 409;
+}
+
+export class UnprocessableEntityError extends APIError {
+  override readonly status: 422 = 422;
+}
+
+export class RateLimitError extends APIError {
+  override readonly status: 429 = 429;
+}
+
+export class InternalServerError extends APIError {}

package/src/index.ts

@@ -0,0 +1,199 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from './core';
+import * as Errors from './error';
+import { type Agent } from './_shims/index';
+import * as Uploads from './uploads';
+import * as API from './resources/index';
+
+export interface ClientOptions {
+  /**
+   * Defaults to process.env['OPENLAYER_API_KEY'].
+   */
+  apiKey?: string | null | undefined;
+
+  /**
+   * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
+   *
+   * Defaults to process.env['OPENLAYER_BASE_URL'].
+   */
+  baseURL?: string | null | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * Note that request timeouts are retried by default, so in a worst-case scenario you may wait
+   * much longer than this timeout before the promise succeeds or fails.
+   */
+  timeout?: number;
+
+  /**
+   * An HTTP agent used to manage HTTP(S) connections.
+   *
+   * If not provided, an agent will be constructed by default in the Node.js environment,
+   * otherwise no agent is used.
+   */
+  httpAgent?: Agent;
+
+  /**
+   * Specify a custom `fetch` function implementation.
+   *
+   * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is
+   * defined globally.
+   */
+  fetch?: Core.Fetch | undefined;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
+  maxRetries?: number;
+
+  /**
+   * Default headers to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * header to `undefined` or `null` in request options.
+   */
+  defaultHeaders?: Core.Headers;
+
+  /**
+   * Default query parameters to include with every request to the API.
+   *
+   * These can be removed in individual requests by explicitly setting the
+   * param to `undefined` in request options.
+   */
+  defaultQuery?: Core.DefaultQuery;
+}
+
+/** API Client for interfacing with the Openlayer API. */
+export class Openlayer extends Core.APIClient {
+  apiKey: string | null;
+
+  private _options: ClientOptions;
+
+  /**
+   * API Client for interfacing with the Openlayer API.
+   *
+   * @param {string | null | undefined} [opts.apiKey=process.env['OPENLAYER_API_KEY'] ?? null]
+   * @param {string} [opts.baseURL=process.env['OPENLAYER_BASE_URL'] ?? https://api.openlayer.com/v1] - Override the default base URL for the API.
+   * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
+   * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
+   * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
+   * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
+   * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API.
+   * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API.
+   */
+  constructor({
+    baseURL = Core.readEnv('OPENLAYER_BASE_URL'),
+    apiKey = Core.readEnv('OPENLAYER_API_KEY') ?? null,
+    ...opts
+  }: ClientOptions = {}) {
+    const options: ClientOptions = {
+      apiKey,
+      ...opts,
+      baseURL: baseURL || `https://api.openlayer.com/v1`,
+    };
+
+    super({
+      baseURL: options.baseURL!,
+      timeout: options.timeout ?? 60000 /* 1 minute */,
+      httpAgent: options.httpAgent,
+      maxRetries: options.maxRetries,
+      fetch: options.fetch,
+    });
+    this._options = options;
+
+    this.apiKey = apiKey;
+  }
+
+  projects: API.Projects = new API.Projects(this);
+  commits: API.Commits = new API.Commits(this);
+  inferencePipelines: API.InferencePipelines = new API.InferencePipelines(this);
+
+  protected override defaultQuery(): Core.DefaultQuery | undefined {
+    return this._options.defaultQuery;
+  }
+
+  protected override defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    return {
+      ...super.defaultHeaders(opts),
+      ...this._options.defaultHeaders,
+    };
+  }
+
+  protected override validateHeaders(headers: Core.Headers, customHeaders: Core.Headers) {
+    if (this.apiKey && headers['authorization']) {
+      return;
+    }
+    if (customHeaders['authorization'] === null) {
+      return;
+    }
+
+    throw new Error(
+      'Could not resolve authentication method. Expected the apiKey to be set. Or for the "Authorization" headers to be explicitly omitted',
+    );
+  }
+
+  protected override authHeaders(opts: Core.FinalRequestOptions): Core.Headers {
+    if (this.apiKey == null) {
+      return {};
+    }
+    return { Authorization: `Bearer ${this.apiKey}` };
+  }
+
+  static Openlayer = this;
+
+  static OpenlayerError = Errors.OpenlayerError;
+  static APIError = Errors.APIError;
+  static APIConnectionError = Errors.APIConnectionError;
+  static APIConnectionTimeoutError = Errors.APIConnectionTimeoutError;
+  static APIUserAbortError = Errors.APIUserAbortError;
+  static NotFoundError = Errors.NotFoundError;
+  static ConflictError = Errors.ConflictError;
+  static RateLimitError = Errors.RateLimitError;
+  static BadRequestError = Errors.BadRequestError;
+  static AuthenticationError = Errors.AuthenticationError;
+  static InternalServerError = Errors.InternalServerError;
+  static PermissionDeniedError = Errors.PermissionDeniedError;
+  static UnprocessableEntityError = Errors.UnprocessableEntityError;
+
+  static toFile = Uploads.toFile;
+  static fileFromPath = Uploads.fileFromPath;
+}
+
+export const {
+  OpenlayerError,
+  APIError,
+  APIConnectionError,
+  APIConnectionTimeoutError,
+  APIUserAbortError,
+  NotFoundError,
+  ConflictError,
+  RateLimitError,
+  BadRequestError,
+  AuthenticationError,
+  InternalServerError,
+  PermissionDeniedError,
+  UnprocessableEntityError,
+} = Errors;
+
+export import toFile = Uploads.toFile;
+export import fileFromPath = Uploads.fileFromPath;
+
+export namespace Openlayer {
+  export import RequestOptions = Core.RequestOptions;
+
+  export import Projects = API.Projects;
+  export import ProjectListResponse = API.ProjectListResponse;
+  export import ProjectListParams = API.ProjectListParams;
+
+  export import Commits = API.Commits;
+
+  export import InferencePipelines = API.InferencePipelines;
+}
+
+export default Openlayer;

package/src/lib/.keep

@@ -0,0 +1,4 @@
+File generated from our OpenAPI spec by Stainless.
+
+This directory can be used to store custom files to expand the SDK.
+It is ignored by Stainless code generation and its content (other than this keep file) won't be touched.

package/src/lib/core/cli.ts

@@ -0,0 +1,96 @@
+/*
+ * Description: This file contains the CLIHandler class which is responsible
+ * For handling the CLI input and output.
+ *
+ * Example Usage:
+ * // Initialize CLI handler with the user's model run method
+ * const cliHandler = new CLIHandler(model.run.bind(model));
+ *
+ * // Setup CLI and process dataset
+ * cliHandler.runFromCLI();
+ */
+
+import { program } from 'commander';
+import * as fs from 'fs';
+import * as path from 'path';
+
+// Define shared interfaces and utilities here
+export interface RunReturn {
+  otherFields: { [key: string]: any };
+  output: any;
+}
+
+// Define an interface for the configuration object
+export interface Config {
+  inputVariableNames?: string[];
+  metadata: {
+    outputTimestamp: number;
+  };
+  outputColumnName: string;
+}
+
+class CLIHandler {
+  private run: (...args: any[]) => Promise<any>;
+
+  constructor(runFunction: (...args: any[]) => Promise<any>) {
+    this.run = runFunction;
+  }
+
+  public runFromCLI() {
+    program
+      .requiredOption('--dataset-path <path>', 'Path to the dataset')
+      .requiredOption('--output-dir <path>', 'Directory to place results');
+
+    program.parse(process.argv);
+
+    const options = program.opts();
+    const { datasetPath, outputDir } = options;
+
+    // Load dataset
+    const datasetFullPath = path.resolve(datasetPath);
+    const rawData = fs.readFileSync(datasetFullPath, 'utf8');
+    const dataset = JSON.parse(rawData);
+
+    // Process each item in the dataset dynamically
+    Promise.all(
+      dataset.map(async (item: any) => {
+        const result = await this.run(item);
+        // Merge the original item fields with the result
+        return { ...item, ...result.otherFields, output: result.output };
+      }),
+    )
+      .then((results) => {
+        /*
+         * Wait for all rows to be run
+         * Write results now to output dir or log to console
+         */
+        this.writeOutput(results, outputDir);
+        console.log('Results processing completed. Check console for output.');
+      })
+      .catch((err) => {
+        console.error(`Error processing dataset: ${err}`);
+      });
+  }
+
+  private writeOutput(results: RunReturn[], outputDir: string) {
+    const config: Config = {
+      metadata: { outputTimestamp: Date.now() },
+      outputColumnName: 'output',
+    };
+
+    // Construct an output directory {outputDir}/{datasetName}/
+    const outputDirPath = path.resolve(outputDir);
+    fs.mkdirSync(outputDirPath, { recursive: true });
+
+    const datasetPath = path.join(outputDirPath, 'dataset.json');
+    const configPath = path.join(outputDirPath, 'config.json');
+
+    fs.writeFileSync(datasetPath, JSON.stringify(results, null, 4), 'utf8');
+    fs.writeFileSync(configPath, JSON.stringify(config, null, 4), 'utf8');
+
+    console.info(`Output written to ${datasetPath}`);
+    console.info(`Config written to ${configPath}`);
+  }
+}
+
+export default CLIHandler;

package/src/lib/core/index.d.ts

@@ -0,0 +1,2 @@
+export * as cli from './cli';
+export * as openAiMonitor from './openai-monitor';