openlayer 0.18.0 → 0.20.0

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

@@ -122,8 +122,27 @@ export interface InferencePipelineCreateResponse {
    */
   totalGoalCount: number;
 
+  dataBackend?:
+    | InferencePipelineCreateResponse.UnionMember0
+    | InferencePipelineCreateResponse.BackendType
+    | InferencePipelineCreateResponse.UnionMember2
+    | InferencePipelineCreateResponse.UnionMember3
+    | InferencePipelineCreateResponse.UnionMember4
+    | InferencePipelineCreateResponse.UnionMember5
+    | null;
+
+  /**
+   * The last time the data was polled.
+   */
+  dateLastPolled?: string | null;
+
   project?: InferencePipelineCreateResponse.Project | null;
 
+  /**
+   * The total number of records in the data backend.
+   */
+  totalRecordsCount?: number | null;
+
   workspace?: InferencePipelineCreateResponse.Workspace | null;
 
   /**
@@ -137,6 +156,66 @@ export namespace InferencePipelineCreateResponse {
     app: string;
   }
 
+  export interface UnionMember0 {
+    backendType: 'bigquery';
+
+    bigqueryConnectionId: string | null;
+
+    datasetId: string;
+
+    projectId: string;
+
+    tableId: string | null;
+
+    partitionType?: 'DAY' | 'MONTH' | 'YEAR' | null;
+  }
+
+  export interface BackendType {
+    backendType: 'default';
+  }
+
+  export interface UnionMember2 {
+    backendType: 'snowflake';
+
+    database: string;
+
+    schema: string;
+
+    snowflakeConnectionId: string | null;
+
+    table: string | null;
+  }
+
+  export interface UnionMember3 {
+    backendType: 'databricks_dtl';
+
+    databricksDtlConnectionId: string | null;
+
+    tableId: string | null;
+  }
+
+  export interface UnionMember4 {
+    backendType: 'redshift';
+
+    redshiftConnectionId: string | null;
+
+    schemaName: string;
+
+    tableName: string;
+  }
+
+  export interface UnionMember5 {
+    backendType: 'postgres';
+
+    database: string;
+
+    postgresConnectionId: string | null;
+
+    schema: string;
+
+    table: string | null;
+  }
+
   export interface Project {
     /**
      * The project id.
@@ -416,8 +495,27 @@ export namespace InferencePipelineListResponse {
      */
     totalGoalCount: number;
 
+    dataBackend?:
+      | Item.UnionMember0
+      | Item.BackendType
+      | Item.UnionMember2
+      | Item.UnionMember3
+      | Item.UnionMember4
+      | Item.UnionMember5
+      | null;
+
+    /**
+     * The last time the data was polled.
+     */
+    dateLastPolled?: string | null;
+
     project?: Item.Project | null;
 
+    /**
+     * The total number of records in the data backend.
+     */
+    totalRecordsCount?: number | null;
+
     workspace?: Item.Workspace | null;
 
     /**
@@ -431,6 +529,66 @@ export namespace InferencePipelineListResponse {
       app: string;
     }
 
+    export interface UnionMember0 {
+      backendType: 'bigquery';
+
+      bigqueryConnectionId: string | null;
+
+      datasetId: string;
+
+      projectId: string;
+
+      tableId: string | null;
+
+      partitionType?: 'DAY' | 'MONTH' | 'YEAR' | null;
+    }
+
+    export interface BackendType {
+      backendType: 'default';
+    }
+
+    export interface UnionMember2 {
+      backendType: 'snowflake';
+
+      database: string;
+
+      schema: string;
+
+      snowflakeConnectionId: string | null;
+
+      table: string | null;
+    }
+
+    export interface UnionMember3 {
+      backendType: 'databricks_dtl';
+
+      databricksDtlConnectionId: string | null;
+
+      tableId: string | null;
+    }
+
+    export interface UnionMember4 {
+      backendType: 'redshift';
+
+      redshiftConnectionId: string | null;
+
+      schemaName: string;
+
+      tableName: string;
+    }
+
+    export interface UnionMember5 {
+      backendType: 'postgres';
+
+      database: string;
+
+      postgresConnectionId: string | null;
+
+      schema: string;
+
+      table: string | null;
+    }
+
     export interface Project {
       /**
        * The project id.
@@ -644,12 +802,251 @@ export interface InferencePipelineCreateParams {
    */
   name: string;
 
+  dataBackend?:
+    | InferencePipelineCreateParams.UnionMember0
+    | InferencePipelineCreateParams.BackendType
+    | InferencePipelineCreateParams.UnionMember2
+    | InferencePipelineCreateParams.UnionMember3
+    | InferencePipelineCreateParams.UnionMember4
+    | InferencePipelineCreateParams.UnionMember5
+    | null;
+
   project?: InferencePipelineCreateParams.Project | null;
 
   workspace?: InferencePipelineCreateParams.Workspace | null;
 }
 
 export namespace InferencePipelineCreateParams {
+  export interface UnionMember0 {
+    backendType: 'bigquery';
+
+    bigqueryConnectionId: string | null;
+
+    config: UnionMember0.Config;
+
+    datasetId: string;
+
+    projectId: string;
+
+    tableId: string | null;
+
+    partitionType?: 'DAY' | 'MONTH' | 'YEAR' | null;
+  }
+
+  export namespace UnionMember0 {
+    export interface Config {
+      /**
+       * Name of the column with the ground truths.
+       */
+      groundTruthColumnName?: string | null;
+
+      /**
+       * Name of the column with human feedback.
+       */
+      humanFeedbackColumnName?: string | null;
+
+      /**
+       * Name of the column with the inference ids. This is useful if you want to update
+       * rows at a later point in time. If not provided, a unique id is generated by
+       * Openlayer.
+       */
+      inferenceIdColumnName?: string | null;
+
+      /**
+       * Name of the column with the latencies.
+       */
+      latencyColumnName?: string | null;
+
+      /**
+       * Name of the column with the timestamps. Timestamps must be in UNIX sec format.
+       * If not provided, the upload timestamp is used.
+       */
+      timestampColumnName?: string | null;
+    }
+  }
+
+  export interface BackendType {
+    backendType: 'default';
+  }
+
+  export interface UnionMember2 {
+    backendType: 'snowflake';
+
+    config: UnionMember2.Config;
+
+    database: string;
+
+    schema: string;
+
+    snowflakeConnectionId: string | null;
+
+    table: string | null;
+  }
+
+  export namespace UnionMember2 {
+    export interface Config {
+      /**
+       * Name of the column with the ground truths.
+       */
+      groundTruthColumnName?: string | null;
+
+      /**
+       * Name of the column with human feedback.
+       */
+      humanFeedbackColumnName?: string | null;
+
+      /**
+       * Name of the column with the inference ids. This is useful if you want to update
+       * rows at a later point in time. If not provided, a unique id is generated by
+       * Openlayer.
+       */
+      inferenceIdColumnName?: string | null;
+
+      /**
+       * Name of the column with the latencies.
+       */
+      latencyColumnName?: string | null;
+
+      /**
+       * Name of the column with the timestamps. Timestamps must be in UNIX sec format.
+       * If not provided, the upload timestamp is used.
+       */
+      timestampColumnName?: string | null;
+    }
+  }
+
+  export interface UnionMember3 {
+    backendType: 'databricks_dtl';
+
+    config: UnionMember3.Config;
+
+    databricksDtlConnectionId: string | null;
+
+    tableId: string | null;
+  }
+
+  export namespace UnionMember3 {
+    export interface Config {
+      /**
+       * Name of the column with the ground truths.
+       */
+      groundTruthColumnName?: string | null;
+
+      /**
+       * Name of the column with human feedback.
+       */
+      humanFeedbackColumnName?: string | null;
+
+      /**
+       * Name of the column with the inference ids. This is useful if you want to update
+       * rows at a later point in time. If not provided, a unique id is generated by
+       * Openlayer.
+       */
+      inferenceIdColumnName?: string | null;
+
+      /**
+       * Name of the column with the latencies.
+       */
+      latencyColumnName?: string | null;
+
+      /**
+       * Name of the column with the timestamps. Timestamps must be in UNIX sec format.
+       * If not provided, the upload timestamp is used.
+       */
+      timestampColumnName?: string | null;
+    }
+  }
+
+  export interface UnionMember4 {
+    backendType: 'redshift';
+
+    config: UnionMember4.Config;
+
+    redshiftConnectionId: string | null;
+
+    schemaName: string;
+
+    tableName: string;
+  }
+
+  export namespace UnionMember4 {
+    export interface Config {
+      /**
+       * Name of the column with the ground truths.
+       */
+      groundTruthColumnName?: string | null;
+
+      /**
+       * Name of the column with human feedback.
+       */
+      humanFeedbackColumnName?: string | null;
+
+      /**
+       * Name of the column with the inference ids. This is useful if you want to update
+       * rows at a later point in time. If not provided, a unique id is generated by
+       * Openlayer.
+       */
+      inferenceIdColumnName?: string | null;
+
+      /**
+       * Name of the column with the latencies.
+       */
+      latencyColumnName?: string | null;
+
+      /**
+       * Name of the column with the timestamps. Timestamps must be in UNIX sec format.
+       * If not provided, the upload timestamp is used.
+       */
+      timestampColumnName?: string | null;
+    }
+  }
+
+  export interface UnionMember5 {
+    backendType: 'postgres';
+
+    config: UnionMember5.Config;
+
+    database: string;
+
+    postgresConnectionId: string | null;
+
+    schema: string;
+
+    table: string | null;
+  }
+
+  export namespace UnionMember5 {
+    export interface Config {
+      /**
+       * Name of the column with the ground truths.
+       */
+      groundTruthColumnName?: string | null;
+
+      /**
+       * Name of the column with human feedback.
+       */
+      humanFeedbackColumnName?: string | null;
+
+      /**
+       * Name of the column with the inference ids. This is useful if you want to update
+       * rows at a later point in time. If not provided, a unique id is generated by
+       * Openlayer.
+       */
+      inferenceIdColumnName?: string | null;
+
+      /**
+       * Name of the column with the latencies.
+       */
+      latencyColumnName?: string | null;
+
+      /**
+       * Name of the column with the timestamps. Timestamps must be in UNIX sec format.
+       * If not provided, the upload timestamp is used.
+       */
+      timestampColumnName?: string | null;
+    }
+  }
+
   export interface Project {
     /**
      * The project name.

package/src/resources/projects/tests.ts

@@ -188,6 +188,12 @@ export interface TestCreateResponse {
    */
   archived?: boolean;
 
+  /**
+   * Whether to apply the test to all pipelines (data sources) or to a specific set
+   * of pipelines. Only applies to tests that use production data.
+   */
+  defaultToAllPipelines?: boolean | null;
+
   /**
    * The delay window in seconds. Only applies to tests that use production data.
    */
@@ -199,6 +205,24 @@ export interface TestCreateResponse {
    */
   evaluationWindow?: number | null;
 
+  /**
+   * Array of pipelines (data sources) to which the test should not be applied. Only
+   * applies to tests that use production data.
+   */
+  excludePipelines?: Array<string> | null;
+
+  /**
+   * Whether to include historical data in the test result. Only applies to tests
+   * that use production data.
+   */
+  includeHistoricalData?: boolean | null;
+
+  /**
+   * Array of pipelines (data sources) to which the test should be applied. Only
+   * applies to tests that use production data.
+   */
+  includePipelines?: Array<string> | null;
+
   /**
    * Whether the test uses an ML model.
    */
@@ -431,6 +455,12 @@ export namespace TestListResponse {
      */
     archived?: boolean;
 
+    /**
+     * Whether to apply the test to all pipelines (data sources) or to a specific set
+     * of pipelines. Only applies to tests that use production data.
+     */
+    defaultToAllPipelines?: boolean | null;
+
     /**
      * The delay window in seconds. Only applies to tests that use production data.
      */
@@ -442,6 +472,24 @@ export namespace TestListResponse {
      */
     evaluationWindow?: number | null;
 
+    /**
+     * Array of pipelines (data sources) to which the test should not be applied. Only
+     * applies to tests that use production data.
+     */
+    excludePipelines?: Array<string> | null;
+
+    /**
+     * Whether to include historical data in the test result. Only applies to tests
+     * that use production data.
+     */
+    includeHistoricalData?: boolean | null;
+
+    /**
+     * Array of pipelines (data sources) to which the test should be applied. Only
+     * applies to tests that use production data.
+     */
+    includePipelines?: Array<string> | null;
+
     /**
      * Whether the test uses an ML model.
      */
@@ -619,6 +667,12 @@ export interface TestCreateParams {
    */
   archived?: boolean;
 
+  /**
+   * Whether to apply the test to all pipelines (data sources) or to a specific set
+   * of pipelines. Only applies to tests that use production data.
+   */
+  defaultToAllPipelines?: boolean | null;
+
   /**
    * The delay window in seconds. Only applies to tests that use production data.
    */
@@ -630,6 +684,24 @@ export interface TestCreateParams {
    */
   evaluationWindow?: number | null;
 
+  /**
+   * Array of pipelines (data sources) to which the test should not be applied. Only
+   * applies to tests that use production data.
+   */
+  excludePipelines?: Array<string> | null;
+
+  /**
+   * Whether to include historical data in the test result. Only applies to tests
+   * that use production data.
+   */
+  includeHistoricalData?: boolean | null;
+
+  /**
+   * Array of pipelines (data sources) to which the test should be applied. Only
+   * applies to tests that use production data.
+   */
+  includePipelines?: Array<string> | null;
+
   /**
    * Whether the test uses an ML model.
    */

package/src/resources/tests.ts

@@ -0,0 +1,100 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Tests extends APIResource {
+  /**
+   * Triggers one-off evaluation of a specific monitoring test for a custom timestamp
+   * range. This allows evaluating tests for historical data or custom time periods
+   * outside the regular evaluation window schedule. It also allows overwriting the
+   * existing test results.
+   *
+   * @example
+   * ```ts
+   * const response = await client.tests.evaluate(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { endTimestamp: 1700006400, startTimestamp: 1699920000 },
+   * );
+   * ```
+   */
+  evaluate(
+    testID: string,
+    body: TestEvaluateParams,
+    options?: RequestOptions,
+  ): APIPromise<TestEvaluateResponse> {
+    return this._client.post(path`/tests/${testID}/evaluate`, { body, ...options });
+  }
+}
+
+export interface TestEvaluateResponse {
+  message: string;
+
+  /**
+   * Number of inference pipelines the test was queued for evaluation on
+   */
+  pipelineCount: number;
+
+  /**
+   * The end timestamp you requested (in seconds)
+   */
+  requestedEndTimestamp: number;
+
+  /**
+   * The start timestamp you requested (in seconds)
+   */
+  requestedStartTimestamp: number;
+
+  /**
+   * Array of background task information for each pipeline evaluation
+   */
+  tasks: Array<TestEvaluateResponse.Task>;
+}
+
+export namespace TestEvaluateResponse {
+  export interface Task {
+    /**
+     * ID of the inference pipeline this task is for
+     */
+    pipelineId: string;
+
+    /**
+     * ID of the background task
+     */
+    taskResultId: string;
+
+    /**
+     * URL to check the status of this background task
+     */
+    taskResultUrl: string;
+  }
+}
+
+export interface TestEvaluateParams {
+  /**
+   * End timestamp in seconds (Unix epoch)
+   */
+  endTimestamp: number;
+
+  /**
+   * Start timestamp in seconds (Unix epoch)
+   */
+  startTimestamp: number;
+
+  /**
+   * ID of the inference pipeline to evaluate. If not provided, all inference
+   * pipelines the test applies to will be evaluated.
+   */
+  inferencePipelineId?: string;
+
+  /**
+   * Whether to overwrite existing test results
+   */
+  overwriteResults?: boolean;
+}
+
+export declare namespace Tests {
+  export { type TestEvaluateResponse as TestEvaluateResponse, type TestEvaluateParams as TestEvaluateParams };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.18.0'; // x-release-please-version
+export const VERSION = '0.20.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.18.0";
+export declare const VERSION = "0.20.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.18.0";
+export declare const VERSION = "0.20.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.18.0'; // x-release-please-version
+exports.VERSION = '0.20.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.18.0'; // x-release-please-version
+export const VERSION = '0.20.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map