diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 949ce4c1..0ee8c012 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.2.2" + ".": "0.3.0" } diff --git a/CHANGELOG.md b/CHANGELOG.md index 935e1c09..a3a61834 100644 --- a/CHANGELOG.md +++ b/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) diff --git a/api.md b/api.md index 8e1c3f52..ec55a49d 100644 --- a/api.md +++ b/api.md @@ -18,7 +18,7 @@ Types: Methods: -- client.projects.commits.list(id, { ...params }) -> CommitListResponse +- client.projects.commits.list(projectId, { ...params }) -> CommitListResponse ## InferencePipelines @@ -29,8 +29,8 @@ Types: Methods: -- client.projects.inferencePipelines.create(id, { ...params }) -> InferencePipelineCreateResponse -- client.projects.inferencePipelines.list(id, { ...params }) -> InferencePipelineListResponse +- client.projects.inferencePipelines.create(projectId, { ...params }) -> InferencePipelineCreateResponse +- client.projects.inferencePipelines.list(projectId, { ...params }) -> InferencePipelineListResponse # Commits @@ -42,7 +42,7 @@ Types: Methods: -- client.commits.testResults.list(id, { ...params }) -> TestResultListResponse +- client.commits.testResults.list(projectVersionId, { ...params }) -> TestResultListResponse # InferencePipelines @@ -54,7 +54,7 @@ Types: Methods: -- client.inferencePipelines.data.stream(id, { ...params }) -> DataStreamResponse +- client.inferencePipelines.data.stream(inferencePipelineId, { ...params }) -> DataStreamResponse ## TestResults @@ -64,4 +64,4 @@ Types: Methods: -- client.inferencePipelines.testResults.list(id, { ...params }) -> TestResultListResponse +- client.inferencePipelines.testResults.list(inferencePipelineId, { ...params }) -> TestResultListResponse diff --git a/package-lock.json b/package-lock.json index 0490e212..a4bad97e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "openlayer", - "version": "0.2.2", + "version": "0.3.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "openlayer", - "version": "0.2.2", + "version": "0.3.0", "license": "ISC", "dependencies": { "@typescript-eslint/eslint-plugin": "^6.11.0", diff --git a/package.json b/package.json index ef0b7271..25b53440 100644 --- a/package.json +++ b/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 ", "types": "dist/index.d.ts", diff --git a/src/resources/commits/test-results.ts b/src/resources/commits/test-results.ts index d2b57740..e776e3c5 100644 --- a/src/resources/commits/test-results.ts +++ b/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; - list(id: string, options?: Core.RequestOptions): Core.APIPromise; + list(projectVersionId: string, options?: Core.RequestOptions): Core.APIPromise; list( - id: string, + projectVersionId: string, query: TestResultListParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { 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 }); } } diff --git a/src/resources/inference-pipelines/data.ts b/src/resources/inference-pipelines/data.ts index ffcb6e7d..41e52dbd 100644 --- a/src/resources/inference-pipelines/data.ts +++ b/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 { - 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; /** - * 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; diff --git a/src/resources/inference-pipelines/test-results.ts b/src/resources/inference-pipelines/test-results.ts index a8dd505a..083fe4f2 100644 --- a/src/resources/inference-pipelines/test-results.ts +++ b/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; - list(id: string, options?: Core.RequestOptions): Core.APIPromise; + list(inferencePipelineId: string, options?: Core.RequestOptions): Core.APIPromise; list( - id: string, + inferencePipelineId: string, query: TestResultListParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { 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. */ diff --git a/src/resources/projects/commits.ts b/src/resources/projects/commits.ts index fa18df33..e731e047 100644 --- a/src/resources/projects/commits.ts +++ b/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; - list(id: string, options?: Core.RequestOptions): Core.APIPromise; + list(projectId: string, options?: Core.RequestOptions): Core.APIPromise; list( - id: string, + projectId: string, query: CommitListParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { 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 }); } } diff --git a/src/resources/projects/inference-pipelines.ts b/src/resources/projects/inference-pipelines.ts index 28c51863..3640b427 100644 --- a/src/resources/projects/inference-pipelines.ts +++ b/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 { - 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; - list(id: string, options?: Core.RequestOptions): Core.APIPromise; + list(projectId: string, options?: Core.RequestOptions): Core.APIPromise; list( - id: string, + projectId: string, query: InferencePipelineListParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { 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 { diff --git a/src/resources/projects/projects.ts b/src/resources/projects/projects.ts index 3a6ad577..a32879cc 100644 --- a/src/resources/projects/projects.ts +++ b/src/resources/projects/projects.ts @@ -14,14 +14,14 @@ export class Projects extends APIResource { ); /** - * Create a project under the current workspace. + * Create a project in your workspace. */ create(body: ProjectCreateParams, options?: Core.RequestOptions): Core.APIPromise { return this._client.post('/projects', { body, ...options }); } /** - * List the projects in a user's workspace. + * List your workspace's projects. */ list(query?: ProjectListParams, options?: Core.RequestOptions): Core.APIPromise; list(options?: Core.RequestOptions): Core.APIPromise; @@ -87,11 +87,6 @@ export interface ProjectCreateResponse { */ name: string; - /** - * Whether the project is a sample project or a user-created project. - */ - sample: boolean; - /** * The source of the project. */ @@ -118,26 +113,6 @@ export interface ProjectCreateResponse { description?: string | null; gitRepo?: ProjectCreateResponse.GitRepo | null; - - /** - * The slack channel id connected to the project. - */ - slackChannelId?: string | null; - - /** - * The slack channel connected to the project. - */ - slackChannelName?: string | null; - - /** - * Whether slack channel notifications are enabled for the project. - */ - slackChannelNotificationsEnabled?: boolean; - - /** - * The number of unread notifications in the project. - */ - unreadNotificationCount?: number; } export namespace ProjectCreateResponse { @@ -255,11 +230,6 @@ export namespace ProjectListResponse { */ name: string; - /** - * Whether the project is a sample project or a user-created project. - */ - sample: boolean; - /** * The source of the project. */ @@ -286,26 +256,6 @@ export namespace ProjectListResponse { description?: string | null; gitRepo?: Item.GitRepo | null; - - /** - * The slack channel id connected to the project. - */ - slackChannelId?: string | null; - - /** - * The slack channel connected to the project. - */ - slackChannelName?: string | null; - - /** - * Whether slack channel notifications are enabled for the project. - */ - slackChannelNotificationsEnabled?: boolean; - - /** - * The number of unread notifications in the project. - */ - unreadNotificationCount?: number; } export namespace Item { @@ -359,35 +309,6 @@ export interface ProjectCreateParams { * The project description. */ description?: string | null; - - gitRepo?: ProjectCreateParams.GitRepo | null; - - /** - * The slack channel id connected to the project. - */ - slackChannelId?: string | null; - - /** - * The slack channel connected to the project. - */ - slackChannelName?: string | null; - - /** - * Whether slack channel notifications are enabled for the project. - */ - slackChannelNotificationsEnabled?: boolean; -} - -export namespace ProjectCreateParams { - export interface GitRepo { - gitAccountId: string; - - gitId: number; - - branch?: string; - - rootDir?: string; - } } export interface ProjectListParams { diff --git a/src/version.ts b/src/version.ts index bf2543cc..88f4d403 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '0.2.2'; // x-release-please-version +export const VERSION = '0.3.0'; // x-release-please-version diff --git a/tests/api-resources/inference-pipelines/test-results.test.ts b/tests/api-resources/inference-pipelines/test-results.test.ts index ec9ab377..ac3f4427 100644 --- a/tests/api-resources/inference-pipelines/test-results.test.ts +++ b/tests/api-resources/inference-pipelines/test-results.test.ts @@ -36,7 +36,7 @@ describe('resource testResults', () => { await expect( openlayer.inferencePipelines.testResults.list( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - { includeArchived: true, page: 1, perPage: 1, status: 'passing', type: 'integrity' }, + { page: 1, perPage: 1, status: 'passing', type: 'integrity' }, { path: '/_stainless_unknown_path' }, ), ).rejects.toThrow(Openlayer.NotFoundError); diff --git a/tests/api-resources/projects/inference-pipelines.test.ts b/tests/api-resources/projects/inference-pipelines.test.ts index 2b030a28..6b8f0bf0 100644 --- a/tests/api-resources/projects/inference-pipelines.test.ts +++ b/tests/api-resources/projects/inference-pipelines.test.ts @@ -26,12 +26,7 @@ describe('resource inferencePipelines', () => { test('create: required and optional params', async () => { const response = await openlayer.projects.inferencePipelines.create( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - { - description: 'This pipeline is used for production.', - name: 'production', - referenceDatasetUri: 's3://...', - storageType: 's3', - }, + { description: 'This pipeline is used for production.', name: 'production' }, ); }); diff --git a/tests/api-resources/projects/projects.test.ts b/tests/api-resources/projects/projects.test.ts index 87e2c7b5..1144bd50 100644 --- a/tests/api-resources/projects/projects.test.ts +++ b/tests/api-resources/projects/projects.test.ts @@ -25,15 +25,6 @@ describe('resource projects', () => { name: 'My Project', taskType: 'llm-base', description: 'My project description.', - gitRepo: { - gitId: 0, - branch: 'string', - rootDir: 'string', - gitAccountId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', - }, - slackChannelId: 'C01B2PZQX1Z', - slackChannelName: '#my-project', - slackChannelNotificationsEnabled: true, }); });