openlayer 0.12.0 → 0.13.0

package/resources.mjs.map

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

package/src/_shims/index.d.ts

@@ -79,3 +79,5 @@ export function fileFromPath(path: string, options?: FileFromPathOptions): Promi
 export function fileFromPath(path: string, filename?: string, options?: FileFromPathOptions): Promise<File>;
 
 export function isFsReadStream(value: any): value is FsReadStream;
+
+export const init: () => void;

package/src/_shims/index.js

@@ -3,7 +3,9 @@
  */
 const shims = require('./registry');
 const auto = require('openlayer/_shims/auto/runtime');
-if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+exports.init = () => {
+  if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+};
 for (const property of Object.keys(shims)) {
   Object.defineProperty(exports, property, {
     get() {
@@ -11,3 +13,5 @@ for (const property of Object.keys(shims)) {
     },
   });
 }
+
+exports.init();

package/src/_shims/index.mjs

@@ -3,5 +3,9 @@
  */
 import * as shims from './registry.mjs';
 import * as auto from "./auto/runtime";
-if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+export const init = () => {
+  if (!shims.kind) shims.setShims(auto.getRuntime(), { auto: true });
+};
 export * from './registry.mjs';
+
+init();

package/src/core.ts

@@ -16,7 +16,12 @@ import {
   type RequestInit,
   type Response,
   type HeadersInit,
+  init,
 } from './_shims/index';
+
+// try running side effects outside of _shims/index to workaround https://github.com/vercel/next.js/issues/76881
+init();
+
 export { type Response };
 import { BlobLike, isBlobLike, isMultipartBody } from './uploads';
 export {
@@ -28,6 +33,20 @@ export {
 
 export type Fetch = (url: RequestInfo, init?: RequestInit) => Promise<Response>;
 
+/**
+ * An alias to the builtin `Array` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Array<T> = Array<T>;
+
+/**
+ * An alias to the builtin `Record` type so we can
+ * easily alias it in import statements if there are name clashes.
+ */
+type _Record<K extends keyof any, T> = Record<K, T>;
+
+export type { _Array as Array, _Record as Record };
+
 type PromiseOrValue<T> = T | Promise<T>;
 
 type APIResponseProps = {
@@ -151,6 +170,7 @@ export class APIPromise<T> extends Promise<T> {
 
 export abstract class APIClient {
   baseURL: string;
+  #baseURLOverridden: boolean;
   maxRetries: number;
   timeout: number;
   httpAgent: Agent | undefined;
@@ -160,18 +180,21 @@ export abstract class APIClient {
 
   constructor({
     baseURL,
+    baseURLOverridden,
     maxRetries = 2,
     timeout = 60000, // 1 minute
     httpAgent,
     fetch: overriddenFetch,
   }: {
     baseURL: string;
+    baseURLOverridden: boolean;
     maxRetries?: number | undefined;
     timeout: number | undefined;
     httpAgent: Agent | undefined;
     fetch: Fetch | undefined;
   }) {
     this.baseURL = baseURL;
+    this.#baseURLOverridden = baseURLOverridden;
     this.maxRetries = validatePositiveInteger('maxRetries', maxRetries);
     this.timeout = validatePositiveInteger('timeout', timeout);
     this.httpAgent = httpAgent;
@@ -194,7 +217,7 @@ export abstract class APIClient {
   protected defaultHeaders(opts: FinalRequestOptions): Headers {
     return {
       Accept: 'application/json',
-      'Content-Type': 'application/json',
+      ...(['head', 'get'].includes(opts.method) ? {} : { 'Content-Type': 'application/json' }),
       'User-Agent': this.getUserAgent(),
       ...getPlatformHeaders(),
       ...this.authHeaders(opts),
@@ -277,10 +300,11 @@ export abstract class APIClient {
   }
 
   buildRequest<Req>(
-    options: FinalRequestOptions<Req>,
+    inputOptions: FinalRequestOptions<Req>,
     { retryCount = 0 }: { retryCount?: number } = {},
   ): { req: RequestInit; url: string; timeout: number } {
-    const { method, path, query, headers: headers = {} } = options;
+    const options = { ...inputOptions };
+    const { method, path, query, defaultBaseURL, headers: headers = {} } = options;
 
     const body =
       ArrayBuffer.isView(options.body) || (options.__binaryRequest && typeof options.body === 'string') ?
@@ -290,11 +314,11 @@ export abstract class APIClient {
       : null;
     const contentLength = this.calculateContentLength(body);
 
-    const url = this.buildURL(path!, query);
+    const url = this.buildURL(path!, query, defaultBaseURL);
     if ('timeout' in options) validatePositiveInteger('timeout', options.timeout);
-    const timeout = options.timeout ?? this.timeout;
+    options.timeout = options.timeout ?? this.timeout;
     const httpAgent = options.httpAgent ?? this.httpAgent ?? getDefaultAgent(url);
-    const minAgentTimeout = timeout + 1000;
+    const minAgentTimeout = options.timeout + 1000;
     if (
       typeof (httpAgent as any)?.options?.timeout === 'number' &&
       minAgentTimeout > ((httpAgent as any).options.timeout ?? 0)
@@ -307,8 +331,8 @@ export abstract class APIClient {
     }
 
     if (this.idempotencyHeader && method !== 'get') {
-      if (!options.idempotencyKey) options.idempotencyKey = this.defaultIdempotencyKey();
-      headers[this.idempotencyHeader] = options.idempotencyKey;
+      if (!inputOptions.idempotencyKey) inputOptions.idempotencyKey = this.defaultIdempotencyKey();
+      headers[this.idempotencyHeader] = inputOptions.idempotencyKey;
     }
 
     const reqHeaders = this.buildHeaders({ options, headers, contentLength, retryCount });
@@ -323,7 +347,7 @@ export abstract class APIClient {
       signal: options.signal ?? null,
     };
 
-    return { req, url, timeout };
+    return { req, url, timeout: options.timeout };
   }
 
   private buildHeaders({
@@ -351,15 +375,22 @@ export abstract class APIClient {
       delete reqHeaders['content-type'];
     }
 
-    // Don't set the retry count header if it was already set or removed through default headers or by the
-    // caller. We check `defaultHeaders` and `headers`, which can contain nulls, instead of `reqHeaders` to
-    // account for the removal case.
+    // Don't set theses headers if they were already set or removed through default headers or by the caller.
+    // We check `defaultHeaders` and `headers`, which can contain nulls, instead of `reqHeaders` to account
+    // for the removal case.
     if (
       getHeader(defaultHeaders, 'x-stainless-retry-count') === undefined &&
       getHeader(headers, 'x-stainless-retry-count') === undefined
     ) {
       reqHeaders['x-stainless-retry-count'] = String(retryCount);
     }
+    if (
+      getHeader(defaultHeaders, 'x-stainless-timeout') === undefined &&
+      getHeader(headers, 'x-stainless-timeout') === undefined &&
+      options.timeout
+    ) {
+      reqHeaders['x-stainless-timeout'] = String(Math.trunc(options.timeout / 1000));
+    }
 
     this.validateHeaders(reqHeaders, headers);
 
@@ -387,7 +418,7 @@ export abstract class APIClient {
       !headers ? {}
       : Symbol.iterator in headers ?
         Object.fromEntries(Array.from(headers as Iterable<string[]>).map((header) => [...header]))
-      : { ...headers }
+      : { ...(headers as any as Record<string, string>) }
     );
   }
 
@@ -476,11 +507,12 @@ export abstract class APIClient {
     return new PagePromise<PageClass, Item>(this, request, Page);
   }
 
-  buildURL<Req>(path: string, query: Req | null | undefined): string {
+  buildURL<Req>(path: string, query: Req | null | undefined, defaultBaseURL?: string | undefined): string {
+    const baseURL = (!this.#baseURLOverridden && defaultBaseURL) || this.baseURL;
     const url =
       isAbsoluteURL(path) ?
         new URL(path)
-      : new URL(this.baseURL + (this.baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
+      : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
     if (!isEmptyObj(defaultQuery)) {
@@ -765,6 +797,7 @@ export type RequestOptions<
   query?: Req | undefined;
   body?: Req | null | undefined;
   headers?: Headers | undefined;
+  defaultBaseURL?: string | undefined;
 
   maxRetries?: number;
   stream?: boolean | undefined;
@@ -786,6 +819,7 @@ const requestOptionsKeys: KeysEnum<RequestOptions> = {
   query: true,
   body: true,
   headers: true,
+  defaultBaseURL: true,
 
   maxRetries: true,
   stream: true,

package/src/index.ts

@@ -42,8 +42,10 @@ export interface ClientOptions {
    *
    * 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.
+   *
+   * @unit milliseconds
    */
-  timeout?: number;
+  timeout?: number | undefined;
 
   /**
    * An HTTP agent used to manage HTTP(S) connections.
@@ -51,7 +53,7 @@ export interface ClientOptions {
    * If not provided, an agent will be constructed by default in the Node.js environment,
    * otherwise no agent is used.
    */
-  httpAgent?: Agent;
+  httpAgent?: Agent | undefined;
 
   /**
    * Specify a custom `fetch` function implementation.
@@ -67,7 +69,7 @@ export interface ClientOptions {
    *
    * @default 2
    */
-  maxRetries?: number;
+  maxRetries?: number | undefined;
 
   /**
    * Default headers to include with every request to the API.
@@ -75,7 +77,7 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * header to `undefined` or `null` in request options.
    */
-  defaultHeaders?: Core.Headers;
+  defaultHeaders?: Core.Headers | undefined;
 
   /**
    * Default query parameters to include with every request to the API.
@@ -83,7 +85,7 @@ export interface ClientOptions {
    * These can be removed in individual requests by explicitly setting the
    * param to `undefined` in request options.
    */
-  defaultQuery?: Core.DefaultQuery;
+  defaultQuery?: Core.DefaultQuery | undefined;
 }
 
 /**
@@ -119,6 +121,7 @@ export class Openlayer extends Core.APIClient {
 
     super({
       baseURL: options.baseURL!,
+      baseURLOverridden: baseURL ? baseURL !== 'https://api.openlayer.com/v1' : false,
       timeout: options.timeout ?? 60000 /* 1 minute */,
       httpAgent: options.httpAgent,
       maxRetries: options.maxRetries,
@@ -135,6 +138,13 @@ export class Openlayer extends Core.APIClient {
   inferencePipelines: API.InferencePipelines = new API.InferencePipelines(this);
   storage: API.Storage = new API.Storage(this);
 
+  /**
+   * Check whether the base URL is set to its default.
+   */
+  #baseURLOverridden(): boolean {
+    return this.baseURL !== 'https://api.openlayer.com/v1';
+  }
+
   protected override defaultQuery(): Core.DefaultQuery | undefined {
     return this._options.defaultQuery;
   }

package/src/resource.ts

@@ -2,7 +2,7 @@
 
 import type { Openlayer } from './index';
 
-export class APIResource {
+export abstract class APIResource {
   protected _client: Openlayer;
 
   constructor(client: Openlayer) {

package/src/resources/commits/test-results.ts

@@ -140,7 +140,48 @@ export namespace TestResultListResponse {
       /**
        * The test subtype.
        */
-      subtype: string;
+      subtype:
+        | 'anomalousColumnCount'
+        | 'characterLength'
+        | 'classImbalanceRatio'
+        | 'expectColumnAToBeInColumnB'
+        | 'columnAverage'
+        | 'columnDrift'
+        | 'columnStatistic'
+        | 'columnValuesMatch'
+        | 'conflictingLabelRowCount'
+        | 'containsPii'
+        | 'containsValidUrl'
+        | 'correlatedFeatureCount'
+        | 'customMetricThreshold'
+        | 'duplicateRowCount'
+        | 'emptyFeature'
+        | 'emptyFeatureCount'
+        | 'driftedFeatureCount'
+        | 'featureMissingValues'
+        | 'featureValueValidation'
+        | 'greatExpectations'
+        | 'groupByColumnStatsCheck'
+        | 'illFormedRowCount'
+        | 'isCode'
+        | 'isJson'
+        | 'llmRubricThresholdV2'
+        | 'labelDrift'
+        | 'metricThreshold'
+        | 'newCategoryCount'
+        | 'newLabelCount'
+        | 'nullRowCount'
+        | 'rowCount'
+        | 'ppScoreValueValidation'
+        | 'quasiConstantFeature'
+        | 'quasiConstantFeatureCount'
+        | 'sqlQuery'
+        | 'dtypeValidation'
+        | 'sentenceLength'
+        | 'sizeRatio'
+        | 'specialCharactersRatio'
+        | 'stringValidation'
+        | 'trainValLeakageRowCount';
 
       /**
        * Whether the test is suggested or user-created.
@@ -152,7 +193,7 @@ export namespace TestResultListResponse {
       /**
        * The test type.
        */
-      type: string;
+      type: 'integrity' | 'consistency' | 'performance';
 
       /**
        * Whether the test is archived.
@@ -201,9 +242,48 @@ export namespace TestResultListResponse {
         /**
          * The insight name to be evaluated.
          */
-        insightName?: string;
+        insightName?:
+          | 'characterLength'
+          | 'classImbalance'
+          | 'expectColumnAToBeInColumnB'
+          | 'columnAverage'
+          | 'columnDrift'
+          | 'columnValuesMatch'
+          | 'confidenceDistribution'
+          | 'conflictingLabelRowCount'
+          | 'containsPii'
+          | 'containsValidUrl'
+          | 'correlatedFeatures'
+          | 'customMetric'
+          | 'duplicateRowCount'
+          | 'emptyFeatures'
+          | 'featureDrift'
+          | 'featureProfile'
+          | 'greatExpectations'
+          | 'groupByColumnStatsCheck'
+          | 'illFormedRowCount'
+          | 'isCode'
+          | 'isJson'
+          | 'llmRubricV2'
+          | 'labelDrift'
+          | 'metrics'
+          | 'newCategories'
+          | 'newLabels'
+          | 'nullRowCount'
+          | 'ppScore'
+          | 'quasiConstantFeatures'
+          | 'sentenceLength'
+          | 'sizeRatio'
+          | 'specialCharacters'
+          | 'stringValidation'
+          | 'trainValLeakageRowCount';
 
-        insightParameters?: Array<unknown>;
+        /**
+         * The insight parameters. Required only for some test subtypes. For example, for
+         * tests that require a column name, the insight parameters will be [{'name':
+         * 'column_name', 'value': 'Age'}]
+         */
+        insightParameters?: Array<Threshold.InsightParameter> | null;
 
         /**
          * The measurement to be evaluated.
@@ -213,20 +293,36 @@ export namespace TestResultListResponse {
         /**
          * The operator to be used for the evaluation.
          */
-        operator?: string;
+        operator?: 'is' | '>' | '>=' | '<' | '<=' | '!=';
+
+        /**
+         * Whether to use automatic anomaly detection or manual thresholds
+         */
+        thresholdMode?: 'automatic' | 'manual';
 
         /**
          * The value to be compared.
          */
         value?: number | boolean | string | Array<string>;
       }
+
+      export namespace Threshold {
+        export interface InsightParameter {
+          /**
+           * The name of the insight filter.
+           */
+          name: string;
+
+          value: unknown;
+        }
+      }
     }
   }
 }
 
 export interface TestResultListParams {
   /**
-   * Include archived goals.
+   * Filter for archived tests.
    */
   includeArchived?: boolean;
 

package/src/resources/inference-pipelines/data.ts

@@ -6,6 +6,26 @@ import * as Core from '../../core';
 export class Data extends APIResource {
   /**
    * Publish an inference data point to an inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.inferencePipelines.data.stream(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       config: { outputColumnName: 'output' },
+   *       rows: [
+   *         {
+   *           user_query: 'bar',
+   *           output: 'bar',
+   *           tokens: 'bar',
+   *           cost: 'bar',
+   *           timestamp: 'bar',
+   *         },
+   *       ],
+   *     },
+   *   );
+   * ```
    */
   stream(
     inferencePipelineId: string,
@@ -34,7 +54,7 @@ export interface DataStreamParams {
   /**
    * A list of inference data points with inputs and outputs
    */
-  rows: Array<Record<string, unknown>>;
+  rows: Array<{ [key: string]: unknown }>;
 }
 
 export namespace DataStreamParams {

package/src/resources/inference-pipelines/inference-pipelines.ts

@@ -17,6 +17,14 @@ export class InferencePipelines extends APIResource {
 
   /**
    * Retrieve inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const inferencePipeline =
+   *   await client.inferencePipelines.retrieve(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   retrieve(
     inferencePipelineId: string,
@@ -40,6 +48,14 @@ export class InferencePipelines extends APIResource {
 
   /**
    * Update inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const inferencePipeline =
+   *   await client.inferencePipelines.update(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   update(
     inferencePipelineId: string,
@@ -63,6 +79,13 @@ export class InferencePipelines extends APIResource {
 
   /**
    * Delete inference pipeline.
+   *
+   * @example
+   * ```ts
+   * await client.inferencePipelines.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   delete(inferencePipelineId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/inference-pipelines/${inferencePipelineId}`, {
@@ -275,26 +298,59 @@ export namespace InferencePipelineRetrieveResponse {
   }
 
   export interface Workspace {
+    /**
+     * The workspace id.
+     */
     id: string;
 
+    /**
+     * The workspace creator id.
+     */
     creatorId: string | null;
 
+    /**
+     * The workspace creation date.
+     */
     dateCreated: string;
 
+    /**
+     * The workspace last updated date.
+     */
     dateUpdated: string;
 
+    /**
+     * The number of invites in the workspace.
+     */
     inviteCount: number;
 
+    /**
+     * The number of members in the workspace.
+     */
     memberCount: number;
 
+    /**
+     * The workspace name.
+     */
     name: string;
 
+    /**
+     * The end date of the current billing period.
+     */
     periodEndDate: string | null;
 
+    /**
+     * The start date of the current billing period.
+     */
     periodStartDate: string | null;
 
+    /**
+     * The number of projects in the workspace.
+     */
     projectCount: number;
 
+    /**
+     * The workspace slug.
+     */
     slug: string;
 
     status:
@@ -309,6 +365,9 @@ export namespace InferencePipelineRetrieveResponse {
 
     monthlyUsage?: Array<Workspace.MonthlyUsage>;
 
+    /**
+     * Whether the workspace only allows SAML authentication.
+     */
     samlOnlyAccess?: boolean;
 
     wildcardDomains?: Array<string>;
@@ -528,26 +587,59 @@ export namespace InferencePipelineUpdateResponse {
   }
 
   export interface Workspace {
+    /**
+     * The workspace id.
+     */
     id: string;
 
+    /**
+     * The workspace creator id.
+     */
     creatorId: string | null;
 
+    /**
+     * The workspace creation date.
+     */
     dateCreated: string;
 
+    /**
+     * The workspace last updated date.
+     */
     dateUpdated: string;
 
+    /**
+     * The number of invites in the workspace.
+     */
     inviteCount: number;
 
+    /**
+     * The number of members in the workspace.
+     */
     memberCount: number;
 
+    /**
+     * The workspace name.
+     */
     name: string;
 
+    /**
+     * The end date of the current billing period.
+     */
     periodEndDate: string | null;
 
+    /**
+     * The start date of the current billing period.
+     */
     periodStartDate: string | null;
 
+    /**
+     * The number of projects in the workspace.
+     */
     projectCount: number;
 
+    /**
+     * The workspace slug.
+     */
     slug: string;
 
     status:
@@ -562,6 +654,9 @@ export namespace InferencePipelineUpdateResponse {
 
     monthlyUsage?: Array<Workspace.MonthlyUsage>;
 
+    /**
+     * Whether the workspace only allows SAML authentication.
+     */
     samlOnlyAccess?: boolean;
 
     wildcardDomains?: Array<string>;

package/src/resources/inference-pipelines/rows.ts

@@ -6,6 +6,14 @@ import * as Core from '../../core';
 export class Rows extends APIResource {
   /**
    * Update an inference data point in an inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const row = await client.inferencePipelines.rows.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { inferenceId: 'inferenceId', row: {} },
+   * );
+   * ```
    */
   update(
     inferencePipelineId: string,