Skip to content

Commit 1d48fda

Browse files
chore: go live (#18)
1 parent b4f0632 commit 1d48fda

File tree

10 files changed

+394
-3
lines changed

10 files changed

+394
-3
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.prism.log
12
node_modules
23
yarn-error.log
34
codegen.log

.stats.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
configured_endpoints: 6
1+
configured_endpoints: 8

api.md

+4
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
Types:
44

5+
- <code><a href="./src/resources/projects/projects.ts">ProjectCreateResponse</a></code>
56
- <code><a href="./src/resources/projects/projects.ts">ProjectListResponse</a></code>
67

78
Methods:
89

10+
- <code title="post /projects">client.projects.<a href="./src/resources/projects/projects.ts">create</a>({ ...params }) -> ProjectCreateResponse</code>
911
- <code title="get /projects">client.projects.<a href="./src/resources/projects/projects.ts">list</a>({ ...params }) -> ProjectListResponse</code>
1012

1113
## Commits
@@ -22,10 +24,12 @@ Methods:
2224

2325
Types:
2426

27+
- <code><a href="./src/resources/projects/inference-pipelines.ts">InferencePipelineCreateResponse</a></code>
2528
- <code><a href="./src/resources/projects/inference-pipelines.ts">InferencePipelineListResponse</a></code>
2629

2730
Methods:
2831

32+
- <code title="post /projects/{id}/inference-pipelines">client.projects.inferencePipelines.<a href="./src/resources/projects/inference-pipelines.ts">create</a>(id, { ...params }) -> InferencePipelineCreateResponse</code>
2933
- <code title="get /projects/{id}/inference-pipelines">client.projects.inferencePipelines.<a href="./src/resources/projects/inference-pipelines.ts">list</a>(id, { ...params }) -> InferencePipelineListResponse</code>
3034

3135
# Commits

src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,9 @@ export namespace Openlayer {
191191
export import RequestOptions = Core.RequestOptions;
192192

193193
export import Projects = API.Projects;
194+
export import ProjectCreateResponse = API.ProjectCreateResponse;
194195
export import ProjectListResponse = API.ProjectListResponse;
196+
export import ProjectCreateParams = API.ProjectCreateParams;
195197
export import ProjectListParams = API.ProjectListParams;
196198

197199
export import Commits = API.Commits;

src/resources/index.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,10 @@
22

33
export { Commits } from './commits/commits';
44
export { InferencePipelines } from './inference-pipelines/inference-pipelines';
5-
export { ProjectListResponse, ProjectListParams, Projects } from './projects/projects';
5+
export {
6+
ProjectCreateResponse,
7+
ProjectListResponse,
8+
ProjectCreateParams,
9+
ProjectListParams,
10+
Projects,
11+
} from './projects/projects';

src/resources/projects/index.ts

+9-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,16 @@
22

33
export { CommitListResponse, CommitListParams, Commits } from './commits';
44
export {
5+
InferencePipelineCreateResponse,
56
InferencePipelineListResponse,
7+
InferencePipelineCreateParams,
68
InferencePipelineListParams,
79
InferencePipelines,
810
} from './inference-pipelines';
9-
export { ProjectListResponse, ProjectListParams, Projects } from './projects';
11+
export {
12+
ProjectCreateResponse,
13+
ProjectListResponse,
14+
ProjectCreateParams,
15+
ProjectListParams,
16+
Projects,
17+
} from './projects';

src/resources/projects/inference-pipelines.ts

+120
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,17 @@ import * as Core from '../../core';
66
import * as InferencePipelinesAPI from './inference-pipelines';
77

88
export class InferencePipelines extends APIResource {
9+
/**
10+
* Create an inference pipeline under a project.
11+
*/
12+
create(
13+
id: string,
14+
body: InferencePipelineCreateParams,
15+
options?: Core.RequestOptions,
16+
): Core.APIPromise<InferencePipelineCreateResponse> {
17+
return this._client.post(`/projects/${id}/inference-pipelines`, { body, ...options });
18+
}
19+
920
/**
1021
* List the inference pipelines in a project.
1122
*/
@@ -27,6 +38,91 @@ export class InferencePipelines extends APIResource {
2738
}
2839
}
2940

41+
export interface InferencePipelineCreateResponse {
42+
/**
43+
* The inference pipeline id.
44+
*/
45+
id: string;
46+
47+
/**
48+
* The creation date.
49+
*/
50+
dateCreated: string;
51+
52+
/**
53+
* The last test evaluation date.
54+
*/
55+
dateLastEvaluated: string | null;
56+
57+
/**
58+
* The last data sample received date.
59+
*/
60+
dateLastSampleReceived: string | null;
61+
62+
/**
63+
* The next test evaluation date.
64+
*/
65+
dateOfNextEvaluation: string | null;
66+
67+
/**
68+
* The last updated date.
69+
*/
70+
dateUpdated: string;
71+
72+
/**
73+
* The inference pipeline description.
74+
*/
75+
description: string | null;
76+
77+
/**
78+
* The number of tests failing.
79+
*/
80+
failingGoalCount: number;
81+
82+
links: InferencePipelineCreateResponse.Links;
83+
84+
/**
85+
* The inference pipeline name.
86+
*/
87+
name: string;
88+
89+
/**
90+
* The number of tests passing.
91+
*/
92+
passingGoalCount: number;
93+
94+
/**
95+
* The project id.
96+
*/
97+
projectId: string;
98+
99+
/**
100+
* The status of test evaluation for the inference pipeline.
101+
*/
102+
status: 'queued' | 'running' | 'paused' | 'failed' | 'completed' | 'unknown';
103+
104+
/**
105+
* The status message of test evaluation for the inference pipeline.
106+
*/
107+
statusMessage: string | null;
108+
109+
/**
110+
* The total number of tests.
111+
*/
112+
totalGoalCount: number;
113+
114+
/**
115+
* The storage type.
116+
*/
117+
storageType?: 'local' | 's3' | 'gcs' | 'azure';
118+
}
119+
120+
export namespace InferencePipelineCreateResponse {
121+
export interface Links {
122+
app: string;
123+
}
124+
}
125+
30126
export interface InferencePipelineListResponse {
31127
_meta: InferencePipelineListResponse._Meta;
32128

@@ -142,6 +238,28 @@ export namespace InferencePipelineListResponse {
142238
}
143239
}
144240

241+
export interface InferencePipelineCreateParams {
242+
/**
243+
* The inference pipeline description.
244+
*/
245+
description: string | null;
246+
247+
/**
248+
* The inference pipeline name.
249+
*/
250+
name: string;
251+
252+
/**
253+
* The reference dataset URI.
254+
*/
255+
referenceDatasetUri?: string | null;
256+
257+
/**
258+
* The storage type.
259+
*/
260+
storageType?: 'local' | 's3' | 'gcs' | 'azure';
261+
}
262+
145263
export interface InferencePipelineListParams {
146264
/**
147265
* Filter list of items by name.
@@ -160,6 +278,8 @@ export interface InferencePipelineListParams {
160278
}
161279

162280
export namespace InferencePipelines {
281+
export import InferencePipelineCreateResponse = InferencePipelinesAPI.InferencePipelineCreateResponse;
163282
export import InferencePipelineListResponse = InferencePipelinesAPI.InferencePipelineListResponse;
283+
export import InferencePipelineCreateParams = InferencePipelinesAPI.InferencePipelineCreateParams;
164284
export import InferencePipelineListParams = InferencePipelinesAPI.InferencePipelineListParams;
165285
}

0 commit comments

Comments
 (0)