openlayer 0.0.0 → 0.0.1-alpha.1

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

@@ -0,0 +1,284 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as TestResultsAPI from './test-results';
+
+export class TestResults extends APIResource {
+  /**
+   * List the test results under an inference pipeline.
+   */
+  list(
+    id: string,
+    query?: TestResultListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TestResultListResponse>;
+  list(id: string, options?: Core.RequestOptions): Core.APIPromise<TestResultListResponse>;
+  list(
+    id: string,
+    query: TestResultListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TestResultListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list(id, {}, query);
+    }
+    return this._client.get(`/inference-pipelines/${id}/results`, { query, ...options });
+  }
+}
+
+export interface TestResultListResponse {
+  _meta: TestResultListResponse._Meta;
+
+  items: Array<TestResultListResponse.Item>;
+}
+
+export namespace TestResultListResponse {
+  export interface _Meta {
+    /**
+     * The current page.
+     */
+    page: number;
+
+    /**
+     * The number of items per page.
+     */
+    perPage: number;
+
+    /**
+     * The total number of items.
+     */
+    totalItems: number;
+
+    /**
+     * The total number of pages.
+     */
+    totalPages: number;
+  }
+
+  export interface Item {
+    /**
+     * Project version (commit) id.
+     */
+    id: string;
+
+    /**
+     * The creation date.
+     */
+    dateCreated: string;
+
+    /**
+     * The data end date.
+     */
+    dateDataEnds: string | null;
+
+    /**
+     * The data start date.
+     */
+    dateDataStarts: string | null;
+
+    /**
+     * The last updated date.
+     */
+    dateUpdated: string;
+
+    /**
+     * The inference pipeline id.
+     */
+    inferencePipelineId: string | null;
+
+    /**
+     * The project version (commit) id.
+     */
+    projectVersionId: string | null;
+
+    /**
+     * The status of the test.
+     */
+    status: 'running' | 'passing' | 'failing' | 'skipped' | 'error';
+
+    /**
+     * The status message.
+     */
+    statusMessage: string | null;
+
+    goal?: Item.Goal;
+
+    /**
+     * The test id.
+     */
+    goalId?: string | null;
+  }
+
+  export namespace Item {
+    export interface Goal {
+      /**
+       * The test id.
+       */
+      id: string;
+
+      /**
+       * The number of comments on the test.
+       */
+      commentCount: number;
+
+      /**
+       * The test creator id.
+       */
+      creatorId: string | null;
+
+      /**
+       * The date the test was archived.
+       */
+      dateArchived: string | null;
+
+      /**
+       * The creation date.
+       */
+      dateCreated: string;
+
+      /**
+       * The last updated date.
+       */
+      dateUpdated: string;
+
+      /**
+       * The test description.
+       */
+      description: unknown | null;
+
+      /**
+       * The test name.
+       */
+      name: string;
+
+      /**
+       * The test number.
+       */
+      number: number;
+
+      /**
+       * The project version (commit) id where the test was created.
+       */
+      originProjectVersionId: string | null;
+
+      /**
+       * The test subtype.
+       */
+      subtype: string;
+
+      /**
+       * Whether the test is suggested or user-created.
+       */
+      suggested: boolean;
+
+      thresholds: Array<Goal.Threshold>;
+
+      /**
+       * The test type.
+       */
+      type: string;
+
+      /**
+       * Whether the test is archived.
+       */
+      archived?: boolean;
+
+      /**
+       * The delay window in seconds. Only applies to tests that use production data.
+       */
+      delayWindow?: number | null;
+
+      /**
+       * The evaluation window in seconds. Only applies to tests that use production
+       * data.
+       */
+      evaluationWindow?: number | null;
+
+      /**
+       * Whether the test uses an ML model.
+       */
+      usesMlModel?: boolean;
+
+      /**
+       * Whether the test uses production data (monitoring mode only).
+       */
+      usesProductionData?: boolean;
+
+      /**
+       * Whether the test uses a reference dataset (monitoring mode only).
+       */
+      usesReferenceDataset?: boolean;
+
+      /**
+       * Whether the test uses a training dataset.
+       */
+      usesTrainingDataset?: boolean;
+
+      /**
+       * Whether the test uses a validation dataset.
+       */
+      usesValidationDataset?: boolean;
+    }
+
+    export namespace Goal {
+      export interface Threshold {
+        /**
+         * The insight name to be evaluated.
+         */
+        insightName?: string;
+
+        insightParameters?: Array<unknown>;
+
+        /**
+         * The measurement to be evaluated.
+         */
+        measurement?: string;
+
+        /**
+         * The operator to be used for the evaluation.
+         */
+        operator?: string;
+
+        /**
+         * The value to be compared.
+         */
+        value?: number | boolean | string | Array<string>;
+      }
+    }
+  }
+}
+
+export interface TestResultListParams {
+  /**
+   * Include archived goals.
+   */
+  includeArchived?: boolean;
+
+  /**
+   * The page to return in a paginated query.
+   */
+  page?: number;
+
+  /**
+   * Maximum number of items to return per page.
+   */
+  perPage?: number;
+
+  /**
+   * Filter list of test results by status. Available statuses are `running`,
+   * `passing`, `failing`, `skipped`, and `error`.
+   */
+  status?: 'running' | 'passing' | 'failing' | 'skipped' | 'error';
+
+  /**
+   * Filter objects by test type. Available types are `integrity`, `consistency`,
+   * `performance`, `fairness`, and `robustness`.
+   */
+  type?: 'integrity' | 'consistency' | 'performance' | 'fairness' | 'robustness';
+}
+
+export namespace TestResults {
+  export import TestResultListResponse = TestResultsAPI.TestResultListResponse;
+  export import TestResultListParams = TestResultsAPI.TestResultListParams;
+}

package/src/resources/projects/commits.ts

@@ -0,0 +1,226 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as CommitsAPI from './commits';
+
+export class Commits extends APIResource {
+  /**
+   * List the commits (project versions) under a project.
+   */
+  list(
+    id: string,
+    query?: CommitListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CommitListResponse>;
+  list(id: string, options?: Core.RequestOptions): Core.APIPromise<CommitListResponse>;
+  list(
+    id: string,
+    query: CommitListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<CommitListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list(id, {}, query);
+    }
+    return this._client.get(`/projects/${id}/versions`, { query, ...options });
+  }
+}
+
+export interface CommitListResponse {
+  _meta: CommitListResponse._Meta;
+
+  items: Array<CommitListResponse.Item>;
+}
+
+export namespace CommitListResponse {
+  export interface _Meta {
+    /**
+     * The current page.
+     */
+    page: number;
+
+    /**
+     * The number of items per page.
+     */
+    perPage: number;
+
+    /**
+     * The total number of items.
+     */
+    totalItems: number;
+
+    /**
+     * The total number of pages.
+     */
+    totalPages: number;
+  }
+
+  export interface Item {
+    /**
+     * The project version (commit) id.
+     */
+    id: string;
+
+    /**
+     * The details of a commit (project version).
+     */
+    commit: Item.Commit;
+
+    /**
+     * The commit archive date.
+     */
+    dateArchived: string | null;
+
+    /**
+     * The project version (commit) creation date.
+     */
+    dateCreated: string;
+
+    /**
+     * The number of tests that are failing for the commit.
+     */
+    failingGoalCount: number;
+
+    /**
+     * The model id.
+     */
+    mlModelId: string | null;
+
+    /**
+     * The number of tests that are passing for the commit.
+     */
+    passingGoalCount: number;
+
+    /**
+     * The project id.
+     */
+    projectId: string;
+
+    /**
+     * The commit status. Initially, the commit is `queued`, then, it switches to
+     * `running`. Finally, it can be `paused`, `failed`, or `completed`.
+     */
+    status: 'queued' | 'running' | 'paused' | 'failed' | 'completed' | 'unknown';
+
+    /**
+     * The commit status message.
+     */
+    statusMessage: string | null;
+
+    /**
+     * The total number of tests for the commit.
+     */
+    totalGoalCount: number;
+
+    /**
+     * The training dataset id.
+     */
+    trainingDatasetId: string | null;
+
+    /**
+     * The validation dataset id.
+     */
+    validationDatasetId: string | null;
+
+    /**
+     * Whether the commit is archived.
+     */
+    archived?: boolean | null;
+
+    /**
+     * The deployment status associated with the commit's model.
+     */
+    deploymentStatus?: string;
+
+    links?: Item.Links;
+  }
+
+  export namespace Item {
+    /**
+     * The details of a commit (project version).
+     */
+    export interface Commit {
+      /**
+       * The commit id.
+       */
+      id: string;
+
+      /**
+       * The author id of the commit.
+       */
+      authorId: string;
+
+      /**
+       * The size of the commit bundle in bytes.
+       */
+      fileSize: number | null;
+
+      /**
+       * The commit message.
+       */
+      message: string;
+
+      /**
+       * The model id.
+       */
+      mlModelId: string | null;
+
+      /**
+       * The storage URI where the commit bundle is stored.
+       */
+      storageUri: string;
+
+      /**
+       * The training dataset id.
+       */
+      trainingDatasetId: string | null;
+
+      /**
+       * The validation dataset id.
+       */
+      validationDatasetId: string | null;
+
+      /**
+       * The commit creation date.
+       */
+      dateCreated?: string;
+
+      /**
+       * The ref of the corresponding git commit.
+       */
+      gitCommitRef?: string;
+
+      /**
+       * The SHA of the corresponding git commit.
+       */
+      gitCommitSha?: number;
+
+      /**
+       * The URL of the corresponding git commit.
+       */
+      gitCommitUrl?: string;
+    }
+
+    export interface Links {
+      app: string;
+    }
+  }
+}
+
+export interface CommitListParams {
+  /**
+   * The page to return in a paginated query.
+   */
+  page?: number;
+
+  /**
+   * Maximum number of items to return per page.
+   */
+  perPage?: number;
+}
+
+export namespace Commits {
+  export import CommitListResponse = CommitsAPI.CommitListResponse;
+  export import CommitListParams = CommitsAPI.CommitListParams;
+}

package/src/resources/projects/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { CommitListResponse, CommitListParams, Commits } from './commits';
+export {
+  InferencePipelineListResponse,
+  InferencePipelineListParams,
+  InferencePipelines,
+} from './inference-pipelines';
+export { ProjectListResponse, ProjectListParams, Projects } from './projects';

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

@@ -0,0 +1,165 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import * as Core from '../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as InferencePipelinesAPI from './inference-pipelines';
+
+export class InferencePipelines extends APIResource {
+  /**
+   * List the inference pipelines in a project.
+   */
+  list(
+    id: string,
+    query?: InferencePipelineListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InferencePipelineListResponse>;
+  list(id: string, options?: Core.RequestOptions): Core.APIPromise<InferencePipelineListResponse>;
+  list(
+    id: string,
+    query: InferencePipelineListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<InferencePipelineListResponse> {
+    if (isRequestOptions(query)) {
+      return this.list(id, {}, query);
+    }
+    return this._client.get(`/projects/${id}/inference-pipelines`, { query, ...options });
+  }
+}
+
+export interface InferencePipelineListResponse {
+  _meta: InferencePipelineListResponse._Meta;
+
+  items: Array<InferencePipelineListResponse.Item>;
+}
+
+export namespace InferencePipelineListResponse {
+  export interface _Meta {
+    /**
+     * The current page.
+     */
+    page: number;
+
+    /**
+     * The number of items per page.
+     */
+    perPage: number;
+
+    /**
+     * The total number of items.
+     */
+    totalItems: number;
+
+    /**
+     * The total number of pages.
+     */
+    totalPages: number;
+  }
+
+  export interface Item {
+    /**
+     * The inference pipeline id.
+     */
+    id: string;
+
+    /**
+     * The creation date.
+     */
+    dateCreated: string;
+
+    /**
+     * The last test evaluation date.
+     */
+    dateLastEvaluated: string | null;
+
+    /**
+     * The last data sample received date.
+     */
+    dateLastSampleReceived: string | null;
+
+    /**
+     * The next test evaluation date.
+     */
+    dateOfNextEvaluation: string | null;
+
+    /**
+     * The last updated date.
+     */
+    dateUpdated: string;
+
+    /**
+     * The inference pipeline description.
+     */
+    description: string | null;
+
+    /**
+     * The number of tests failing.
+     */
+    failingGoalCount: number;
+
+    links: Item.Links;
+
+    /**
+     * The inference pipeline name.
+     */
+    name: string;
+
+    /**
+     * The number of tests passing.
+     */
+    passingGoalCount: number;
+
+    /**
+     * The project id.
+     */
+    projectId: string;
+
+    /**
+     * The status of test evaluation for the inference pipeline.
+     */
+    status: 'queued' | 'running' | 'paused' | 'failed' | 'completed' | 'unknown';
+
+    /**
+     * The status message of test evaluation for the inference pipeline.
+     */
+    statusMessage: string | null;
+
+    /**
+     * The total number of tests.
+     */
+    totalGoalCount: number;
+
+    /**
+     * The storage type.
+     */
+    storageType?: 'local' | 's3' | 'gcs' | 'azure';
+  }
+
+  export namespace Item {
+    export interface Links {
+      app: string;
+    }
+  }
+}
+
+export interface InferencePipelineListParams {
+  /**
+   * Filter list of items by name.
+   */
+  name?: string;
+
+  /**
+   * The page to return in a paginated query.
+   */
+  page?: number;
+
+  /**
+   * Maximum number of items to return per page.
+   */
+  perPage?: number;
+}
+
+export namespace InferencePipelines {
+  export import InferencePipelineListResponse = InferencePipelinesAPI.InferencePipelineListResponse;
+  export import InferencePipelineListParams = InferencePipelinesAPI.InferencePipelineListParams;
+}