mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-18 01:10:14 +01:00
83 lines
2.6 KiB
JavaScript
83 lines
2.6 KiB
JavaScript
|
const multer = require('multer');
|
||
|
|
const express = require('express');
|
||
|
|
const v1 = require('~/server/controllers/assistants/v1');
|
||
|
|
const v2 = require('~/server/controllers/assistants/v2');
|
||
|
|
const actions = require('./actions');
|
||
|
|
const tools = require('./tools');
|
||
|
|
|
||
|
|
const upload = multer();
|
||
|
|
const router = express.Router();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Assistant actions route.
|
||
|
|
* @route GET|POST /assistants/actions
|
||
|
|
*/
|
||
|
|
router.use('/actions', actions);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create an assistant.
|
||
|
|
* @route GET /assistants/tools
|
||
|
|
* @returns {TPlugin[]} 200 - application/json
|
||
|
|
*/
|
||
|
|
router.use('/tools', tools);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Create an assistant.
|
||
|
|
* @route POST /assistants
|
||
|
|
* @param {AssistantCreateParams} req.body - The assistant creation parameters.
|
||
|
|
* @returns {Assistant} 201 - success response - application/json
|
||
|
|
*/
|
||
|
|
router.post('/', v2.createAssistant);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Retrieves an assistant.
|
||
|
|
* @route GET /assistants/:id
|
||
|
|
* @param {string} req.params.id - Assistant identifier.
|
||
|
|
* @returns {Assistant} 200 - success response - application/json
|
||
|
|
*/
|
||
|
|
router.get('/:id', v1.retrieveAssistant);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Modifies an assistant.
|
||
|
|
* @route PATCH /assistants/:id
|
||
|
|
* @param {string} req.params.id - Assistant identifier.
|
||
|
|
* @param {AssistantUpdateParams} req.body - The assistant update parameters.
|
||
|
|
* @returns {Assistant} 200 - success response - application/json
|
||
|
|
*/
|
||
|
|
router.patch('/:id', v2.patchAssistant);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Deletes an assistant.
|
||
|
|
* @route DELETE /assistants/:id
|
||
|
|
* @param {string} req.params.id - Assistant identifier.
|
||
|
|
* @returns {Assistant} 200 - success response - application/json
|
||
|
|
*/
|
||
|
|
router.delete('/:id', v1.deleteAssistant);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a list of assistants.
|
||
|
|
* @route GET /assistants
|
||
|
|
* @param {AssistantListParams} req.query - The assistant list parameters for pagination and sorting.
|
||
|
|
* @returns {AssistantListResponse} 200 - success response - application/json
|
||
|
|
*/
|
||
|
|
router.get('/', v1.listAssistants);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a list of the user's assistant documents (metadata saved to database).
|
||
|
|
* @route GET /assistants/documents
|
||
|
|
* @returns {AssistantDocument[]} 200 - success response - application/json
|
||
|
|
*/
|
||
|
|
router.get('/documents', v1.getAssistantDocuments);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Uploads and updates an avatar for a specific assistant.
|
||
|
|
* @route POST /avatar/:assistant_id
|
||
|
|
* @param {string} req.params.assistant_id - The ID of the assistant.
|
||
|
|
* @param {Express.Multer.File} req.file - The avatar image file.
|
||
|
|
* @param {string} [req.body.metadata] - Optional metadata for the assistant's avatar.
|
||
|
|
* @returns {Object} 200 - success response - application/json
|
||
|
|
*/
|
||
|
|
router.post('/avatar/:assistant_id', upload.single('file'), v1.uploadAssistantAvatar);
|
||
|
|
|
||
|
|
module.exports = router;
|