release: 0.3.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.2"
+  ".": "0.3.0"
 }

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.3.0 (2024-07-08)
+
+Full Changelog: [v0.2.2...v0.3.0](https://github.com/openlayer-ai/openlayer-ts/compare/v0.2.2...v0.3.0)
+
+### Features
+
+* **api:** OpenAPI spec update via Stainless API ([#23](https://github.com/openlayer-ai/openlayer-ts/issues/23)) ([5b4cd52](https://github.com/openlayer-ai/openlayer-ts/commit/5b4cd5246aed3ff1168fde683e56f53b4d4f5300))
+* **api:** OpenAPI spec update via Stainless API ([#24](https://github.com/openlayer-ai/openlayer-ts/issues/24)) ([66aedcb](https://github.com/openlayer-ai/openlayer-ts/commit/66aedcbcfa5a7684602da7b68cf680d48c337a95))
+* **api:** update via SDK Studio ([#20](https://github.com/openlayer-ai/openlayer-ts/issues/20)) ([2db48ab](https://github.com/openlayer-ai/openlayer-ts/commit/2db48ab38bead726c68039f679bd0fd601588ad9))
+* **api:** update via SDK Studio ([#25](https://github.com/openlayer-ai/openlayer-ts/issues/25)) ([b673070](https://github.com/openlayer-ai/openlayer-ts/commit/b6730709975f7f965e47d9cbff2ad18e01afe768))
+
+
+### Chores
+
+* go live ([#26](https://github.com/openlayer-ai/openlayer-ts/issues/26)) ([c8f17b6](https://github.com/openlayer-ai/openlayer-ts/commit/c8f17b649a5f2d3d134390d81c357f5e80bda83e))
+
 ## 0.2.2 (2024-07-05)
 
 Full Changelog: [v0.2.1...v0.2.2](https://github.com/openlayer-ai/openlayer-ts/compare/v0.2.1...v0.2.2)

api.md

@@ -18,7 +18,7 @@ Types:
 
 Methods:
 
-- <code title="get /projects/{id}/versions">client.projects.commits.<a href="./src/resources/projects/commits.ts">list</a>(id, { ...params }) -> CommitListResponse</code>
+- <code title="get /projects/{projectId}/versions">client.projects.commits.<a href="./src/resources/projects/commits.ts">list</a>(projectId, { ...params }) -> CommitListResponse</code>
 
 ## InferencePipelines
 
@@ -29,8 +29,8 @@ Types:
 
 Methods:
 
-- <code title="post /projects/{id}/inference-pipelines">client.projects.inferencePipelines.<a href="./src/resources/projects/inference-pipelines.ts">create</a>(id, { ...params }) -> InferencePipelineCreateResponse</code>
-- <code title="get /projects/{id}/inference-pipelines">client.projects.inferencePipelines.<a href="./src/resources/projects/inference-pipelines.ts">list</a>(id, { ...params }) -> InferencePipelineListResponse</code>
+- <code title="post /projects/{projectId}/inference-pipelines">client.projects.inferencePipelines.<a href="./src/resources/projects/inference-pipelines.ts">create</a>(projectId, { ...params }) -> InferencePipelineCreateResponse</code>
+- <code title="get /projects/{projectId}/inference-pipelines">client.projects.inferencePipelines.<a href="./src/resources/projects/inference-pipelines.ts">list</a>(projectId, { ...params }) -> InferencePipelineListResponse</code>
 
 # Commits
 
@@ -42,7 +42,7 @@ Types:
 
 Methods:
 
-- <code title="get /versions/{id}/results">client.commits.testResults.<a href="./src/resources/commits/test-results.ts">list</a>(id, { ...params }) -> TestResultListResponse</code>
+- <code title="get /versions/{projectVersionId}/results">client.commits.testResults.<a href="./src/resources/commits/test-results.ts">list</a>(projectVersionId, { ...params }) -> TestResultListResponse</code>
 
 # InferencePipelines
 
@@ -54,7 +54,7 @@ Types:
 
 Methods:
 
-- <code title="post /inference-pipelines/{id}/data-stream">client.inferencePipelines.data.<a href="./src/resources/inference-pipelines/data.ts">stream</a>(id, { ...params }) -> DataStreamResponse</code>
+- <code title="post /inference-pipelines/{inferencePipelineId}/data-stream">client.inferencePipelines.data.<a href="./src/resources/inference-pipelines/data.ts">stream</a>(inferencePipelineId, { ...params }) -> DataStreamResponse</code>
 
 ## TestResults
 
@@ -64,4 +64,4 @@ Types:
 
 Methods:
 
-- <code title="get /inference-pipelines/{id}/results">client.inferencePipelines.testResults.<a href="./src/resources/inference-pipelines/test-results.ts">list</a>(id, { ...params }) -> TestResultListResponse</code>
+- <code title="get /inference-pipelines/{inferencePipelineId}/results">client.inferencePipelines.testResults.<a href="./src/resources/inference-pipelines/test-results.ts">list</a>(inferencePipelineId, { ...params }) -> TestResultListResponse</code>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openlayer",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "The official TypeScript library for the Openlayer API",
   "author": "Openlayer <support@openlayer.com>",
   "types": "dist/index.d.ts",

src/resources/commits/test-results.ts

@@ -7,23 +7,23 @@ import * as TestResultsAPI from './test-results';
 
 export class TestResults extends APIResource {
   /**
-   * List the test results for a commit (project version).
+   * List the test results for a project commit (project version).
    */
   list(
-    id: string,
+    projectVersionId: string,
     query?: TestResultListParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<TestResultListResponse>;
-  list(id: string, options?: Core.RequestOptions): Core.APIPromise<TestResultListResponse>;
+  list(projectVersionId: string, options?: Core.RequestOptions): Core.APIPromise<TestResultListResponse>;
   list(
-    id: string,
+    projectVersionId: string,
     query: TestResultListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<TestResultListResponse> {
     if (isRequestOptions(query)) {
-      return this.list(id, {}, query);
+      return this.list(projectVersionId, {}, query);
     }
-    return this._client.get(`/versions/${id}/results`, { query, ...options });
+    return this._client.get(`/versions/${projectVersionId}/results`, { query, ...options });
   }
 }
 

src/resources/inference-pipelines/data.ts

@@ -6,14 +6,14 @@ import * as DataAPI from './data';
 
 export class Data extends APIResource {
   /**
-   * Stream production data to an inference pipeline in Openlayer.
+   * Stream production data to an inference pipeline.
    */
   stream(
-    id: string,
+    inferencePipelineId: string,
     body: DataStreamParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<DataStreamResponse> {
-    return this._client.post(`/inference-pipelines/${id}/data-stream`, { body, ...options });
+    return this._client.post(`/inference-pipelines/${inferencePipelineId}/data-stream`, { body, ...options });
   }
 }
 
@@ -128,7 +128,7 @@ export namespace DataStreamParams {
     classNames: Array<string>;
 
     /**
-     * Array with the names of all categorical features in the dataset. E.g. ["Gender",
+     * Array with the names of all categorical features in the dataset. E.g. ["Age",
      * "Geography"].
      */
     categoricalFeatureNames?: Array<string>;

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

@@ -7,23 +7,23 @@ import * as TestResultsAPI from './test-results';
 
 export class TestResults extends APIResource {
   /**
-   * List the test results under an inference pipeline.
+   * List the latest test results for an inference pipeline.
    */
   list(
-    id: string,
+    inferencePipelineId: string,
     query?: TestResultListParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<TestResultListResponse>;
-  list(id: string, options?: Core.RequestOptions): Core.APIPromise<TestResultListResponse>;
+  list(inferencePipelineId: string, options?: Core.RequestOptions): Core.APIPromise<TestResultListResponse>;
   list(
-    id: string,
+    inferencePipelineId: string,
     query: TestResultListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<TestResultListResponse> {
     if (isRequestOptions(query)) {
-      return this.list(id, {}, query);
+      return this.list(inferencePipelineId, {}, query);
     }
-    return this._client.get(`/inference-pipelines/${id}/results`, { query, ...options });
+    return this._client.get(`/inference-pipelines/${inferencePipelineId}/results`, { query, ...options });
   }
 }
 
@@ -250,11 +250,6 @@ export namespace TestResultListResponse {
 }
 
 export interface TestResultListParams {
-  /**
-   * Include archived goals.
-   */
-  includeArchived?: boolean;
-
   /**
    * The page to return in a paginated query.
    */

src/resources/projects/commits.ts

@@ -7,23 +7,23 @@ import * as CommitsAPI from './commits';
 
 export class Commits extends APIResource {
   /**
-   * List the commits (project versions) under a project.
+   * List the commits (project versions) in a project.
    */
   list(
-    id: string,
+    projectId: string,
     query?: CommitListParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<CommitListResponse>;
-  list(id: string, options?: Core.RequestOptions): Core.APIPromise<CommitListResponse>;
+  list(projectId: string, options?: Core.RequestOptions): Core.APIPromise<CommitListResponse>;
   list(
-    id: string,
+    projectId: string,
     query: CommitListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<CommitListResponse> {
     if (isRequestOptions(query)) {
-      return this.list(id, {}, query);
+      return this.list(projectId, {}, query);
     }
-    return this._client.get(`/projects/${id}/versions`, { query, ...options });
+    return this._client.get(`/projects/${projectId}/versions`, { query, ...options });
   }
 }
 

src/resources/projects/inference-pipelines.ts

@@ -7,34 +7,34 @@ import * as InferencePipelinesAPI from './inference-pipelines';
 
 export class InferencePipelines extends APIResource {
   /**
-   * Create an inference pipeline under a project.
+   * Create an inference pipeline in a project.
    */
   create(
-    id: string,
+    projectId: string,
     body: InferencePipelineCreateParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<InferencePipelineCreateResponse> {
-    return this._client.post(`/projects/${id}/inference-pipelines`, { body, ...options });
+    return this._client.post(`/projects/${projectId}/inference-pipelines`, { body, ...options });
   }
 
   /**
    * List the inference pipelines in a project.
    */
   list(
-    id: string,
+    projectId: string,
     query?: InferencePipelineListParams,
     options?: Core.RequestOptions,
   ): Core.APIPromise<InferencePipelineListResponse>;
-  list(id: string, options?: Core.RequestOptions): Core.APIPromise<InferencePipelineListResponse>;
+  list(projectId: string, options?: Core.RequestOptions): Core.APIPromise<InferencePipelineListResponse>;
   list(
-    id: string,
+    projectId: string,
     query: InferencePipelineListParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<InferencePipelineListResponse> {
     if (isRequestOptions(query)) {
-      return this.list(id, {}, query);
+      return this.list(projectId, {}, query);
     }
-    return this._client.get(`/projects/${id}/inference-pipelines`, { query, ...options });
+    return this._client.get(`/projects/${projectId}/inference-pipelines`, { query, ...options });
   }
 }
 
@@ -110,11 +110,6 @@ export interface InferencePipelineCreateResponse {
    * The total number of tests.
    */
   totalGoalCount: number;
-
-  /**
-   * The storage type.
-   */
-  storageType?: 'local' | 's3' | 'gcs' | 'azure';
 }
 
 export namespace InferencePipelineCreateResponse {
@@ -224,11 +219,6 @@ export namespace InferencePipelineListResponse {
      * The total number of tests.
      */
     totalGoalCount: number;
-
-    /**
-     * The storage type.
-     */
-    storageType?: 'local' | 's3' | 'gcs' | 'azure';
   }
 
   export namespace Item {
@@ -248,16 +238,6 @@ export interface InferencePipelineCreateParams {
    * The inference pipeline name.
    */
   name: string;
-
-  /**
-   * The reference dataset URI.
-   */
-  referenceDatasetUri?: string | null;
-
-  /**
-   * The storage type.
-   */
-  storageType?: 'local' | 's3' | 'gcs' | 'azure';
 }
 
 export interface InferencePipelineListParams {