openlayer 0.12.0 → 0.13.0

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

@@ -7,6 +7,14 @@ import * as Core from '../../core';
 export class TestResults extends APIResource {
   /**
    * List the latest test results for an inference pipeline.
+   *
+   * @example
+   * ```ts
+   * const testResults =
+   *   await client.inferencePipelines.testResults.list(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   list(
     inferencePipelineId: string,
@@ -140,7 +148,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 +201,7 @@ export namespace TestResultListResponse {
       /**
        * The test type.
        */
-      type: string;
+      type: 'integrity' | 'consistency' | 'performance';
 
       /**
        * Whether the test is archived.
@@ -201,9 +250,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,13 +301,29 @@ 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;
+        }
+      }
     }
   }
 }

package/src/resources/projects/commits.ts

@@ -7,6 +7,17 @@ import * as Core from '../../core';
 export class Commits extends APIResource {
   /**
    * Create a new commit (project version) in a project.
+   *
+   * @example
+   * ```ts
+   * const commit = await client.projects.commits.create(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   {
+   *     commit: { message: 'Updated the prompt.' },
+   *     storageUri: 's3://...',
+   *   },
+   * );
+   * ```
    */
   create(
     projectId: string,
@@ -18,6 +29,13 @@ export class Commits extends APIResource {
 
   /**
    * List the commits (project versions) in a project.
+   *
+   * @example
+   * ```ts
+   * const commits = await client.projects.commits.list(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   list(
     projectId: string,

package/src/resources/projects/index.ts

@@ -21,3 +21,12 @@ export {
   type ProjectCreateParams,
   type ProjectListParams,
 } from './projects';
+export {
+  Tests,
+  type TestCreateResponse,
+  type TestUpdateResponse,
+  type TestListResponse,
+  type TestCreateParams,
+  type TestUpdateParams,
+  type TestListParams,
+} from './tests';

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

@@ -7,6 +7,18 @@ import * as Core from '../../core';
 export class InferencePipelines extends APIResource {
   /**
    * Create an inference pipeline in a project.
+   *
+   * @example
+   * ```ts
+   * const inferencePipeline =
+   *   await client.projects.inferencePipelines.create(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *     {
+   *       description: 'This pipeline is used for production.',
+   *       name: 'production',
+   *     },
+   *   );
+   * ```
    */
   create(
     projectId: string,
@@ -18,6 +30,14 @@ export class InferencePipelines extends APIResource {
 
   /**
    * List the inference pipelines in a project.
+   *
+   * @example
+   * ```ts
+   * const inferencePipelines =
+   *   await client.projects.inferencePipelines.list(
+   *     '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   );
+   * ```
    */
   list(
     projectId: string,
@@ -240,26 +260,59 @@ export namespace InferencePipelineCreateResponse {
   }
 
   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:
@@ -274,6 +327,9 @@ export namespace InferencePipelineCreateResponse {
 
     monthlyUsage?: Array<Workspace.MonthlyUsage>;
 
+    /**
+     * Whether the workspace only allows SAML authentication.
+     */
     samlOnlyAccess?: boolean;
 
     wildcardDomains?: Array<string>;
@@ -498,26 +554,59 @@ export namespace InferencePipelineListResponse {
     }
 
     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:
@@ -532,6 +621,9 @@ export namespace InferencePipelineListResponse {
 
       monthlyUsage?: Array<Workspace.MonthlyUsage>;
 
+      /**
+       * Whether the workspace only allows SAML authentication.
+       */
       samlOnlyAccess?: boolean;
 
       wildcardDomains?: Array<string>;
@@ -584,12 +676,24 @@ export namespace InferencePipelineCreateParams {
   }
 
   export interface Workspace {
+    /**
+     * The workspace name.
+     */
     name: string;
 
+    /**
+     * The workspace slug.
+     */
     slug: string;
 
+    /**
+     * The workspace invite code.
+     */
     inviteCode?: string;
 
+    /**
+     * Whether the workspace only allows SAML authentication.
+     */
     samlOnlyAccess?: boolean;
 
     wildcardDomains?: Array<string>;

package/src/resources/projects/projects.ts

@@ -19,15 +19,34 @@ import {
   InferencePipelineListResponse,
   InferencePipelines,
 } from './inference-pipelines';
+import * as TestsAPI from './tests';
+import {
+  TestCreateParams,
+  TestCreateResponse,
+  TestListParams,
+  TestListResponse,
+  TestUpdateParams,
+  TestUpdateResponse,
+  Tests,
+} from './tests';
 
 export class Projects extends APIResource {
   commits: CommitsAPI.Commits = new CommitsAPI.Commits(this._client);
   inferencePipelines: InferencePipelinesAPI.InferencePipelines = new InferencePipelinesAPI.InferencePipelines(
     this._client,
   );
+  tests: TestsAPI.Tests = new TestsAPI.Tests(this._client);
 
   /**
    * Create a project in your workspace.
+   *
+   * @example
+   * ```ts
+   * const project = await client.projects.create({
+   *   name: 'My Project',
+   *   taskType: 'llm-base',
+   * });
+   * ```
    */
   create(body: ProjectCreateParams, options?: Core.RequestOptions): Core.APIPromise<ProjectCreateResponse> {
     return this._client.post('/projects', { body, ...options });
@@ -35,6 +54,11 @@ export class Projects extends APIResource {
 
   /**
    * List your workspace's projects.
+   *
+   * @example
+   * ```ts
+   * const projects = await client.projects.list();
+   * ```
    */
   list(query?: ProjectListParams, options?: Core.RequestOptions): Core.APIPromise<ProjectListResponse>;
   list(options?: Core.RequestOptions): Core.APIPromise<ProjectListResponse>;
@@ -324,6 +348,7 @@ export interface ProjectListParams {
 
 Projects.Commits = Commits;
 Projects.InferencePipelines = InferencePipelines;
+Projects.Tests = Tests;
 
 export declare namespace Projects {
   export {
@@ -348,4 +373,14 @@ export declare namespace Projects {
     type InferencePipelineCreateParams as InferencePipelineCreateParams,
     type InferencePipelineListParams as InferencePipelineListParams,
   };
+
+  export {
+    Tests as Tests,
+    type TestCreateResponse as TestCreateResponse,
+    type TestUpdateResponse as TestUpdateResponse,
+    type TestListResponse as TestListResponse,
+    type TestCreateParams as TestCreateParams,
+    type TestUpdateParams as TestUpdateParams,
+    type TestListParams as TestListParams,
+  };
 }