Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the api desc #933

Merged
merged 2 commits into from
Jul 29, 2024
Merged

Update the api desc #933

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c821b4c
Update the api desc
irfanpena Jul 29, 2024
d3dd4ea
update per comment
irfanpena Jul 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cortex-js/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"build:dev:linux": "chmod +x ./dist/src/command.js"
},
"dependencies": {
"@cortexso/cortex.js": "^0.1.3",
"@huggingface/gguf": "^0.1.5",
"@huggingface/hub": "^0.15.1",
"@nestjs/axios": "^3.0.2",
Expand All @@ -55,7 +56,6 @@
"class-validator": "^0.14.1",
"cli-progress": "^3.12.0",
"cortex-cpp": "0.4.34",
"@cortexso/cortex.js": "^0.1.3",
"cpu-instructions": "^0.0.11",
"decompress": "^4.2.1",
"js-yaml": "^4.1.0",
Expand Down
20 changes: 4 additions & 16 deletions cortex-js/src/app.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,26 +57,14 @@ export const getApp = async () => {
'Embeddings',
'Endpoint for creating and retrieving embedding vectors from text inputs using specified models.',
)
.addTag(
'Status',
"Endpoint for actively querying the health status of the Cortex's API server.",
)
.addTag(
'Processes',
'Endpoint for terminating the Cortex API server processes.',
)
.addTag(
'Events',
'Endpoints for observing Cortex statuses through event notifications.',
)
.addTag(
'Configurations',
"Endpoints for customizing the Cortex's configurations.",
)
.addTag(
'Engines',
'Endpoints for managing the available engines within Cortex.',
)
.addTag(
'System',
'Endpoints for stopping the Cortex API server and retrieving the Cortex status.',
louis-jan marked this conversation as resolved.
Show resolved Hide resolved
)
.addServer('http://localhost:1337')
.build();
const document = SwaggerModule.createDocument(app, config);
Expand Down
2 changes: 1 addition & 1 deletion cortex-js/src/infrastructure/controllers/engines.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ export class EnginesController {
type: CommonResponseDto,
})
@ApiOperation({
summary: 'Update the engine',
summary: 'Update an engine',
description: 'Updates the engine with configurations.',
})
@ApiParam({
Expand Down
4 changes: 2 additions & 2 deletions cortex-js/src/infrastructure/controllers/models.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,9 @@ export class ModelsController {
type: CommonResponseDto,
})
@ApiOperation({
summary: 'Download a remote model',
summary: 'Pull a model',
description:
'Pulls a remote model template from cortex hub or huggingface and downloads it.',
'Pulls a model from cortex hub or huggingface and downloads it.',
})
@ApiParam({
name: 'modelId',
Expand Down
4 changes: 2 additions & 2 deletions cortex-js/src/infrastructure/controllers/system.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ export class SystemController {
) {}

@ApiOperation({
summary: 'Terminate api server',
description: 'Terminates the Cortex API endpoint server for the detached mode.',
summary: 'Stop api server',
description: 'Stops the Cortex API endpoint server for the detached mode.',
})
@Delete()
async delete() {
Expand Down
Loading