θΏ™ζ˜―indexlocζδΎ›ηš„ζœεŠ‘οΌŒδΈθ¦θΎ“ε…₯任何密码
Skip to content

Add additional embed API endpoints #3264

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

Merged
merged 5 commits into from
Feb 18, 2025
Merged

Add additional embed API endpoints #3264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
04cf317
wip embed dev api endpoints
shatfield4 Feb 15, 2025
d18c494
fix /v1/embed/new endpoint
shatfield4 Feb 18, 2025
569357a
add delete endpoint to embeds
shatfield4 Feb 18, 2025
29589b4
Merge branch 'master' into 3192-feat-add-additional-embed-api-endpoin…
shatfield4 Feb 18, 2025
4147fcc
linting
timothycarambat Feb 18, 2025
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
245 changes: 212 additions & 33 deletions server/endpoints/api/embed/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
const { EmbedConfig } = require("../../../models/embedConfig");
const { EmbedChats } = require("../../../models/embedChats");
const { validApiKey } = require("../../../utils/middleware/validApiKey");
const { reqBody } = require("../../../utils/http");
const { Workspace } = require("../../../models/workspace");

function apiEmbedEndpoints(app) {
if (!app) return;
Expand Down Expand Up @@ -40,7 +42,7 @@ function apiEmbedEndpoints(app) {
},
"chat_count": 10
}
]
]
}
}
}
Expand Down Expand Up @@ -124,21 +126,10 @@ function apiEmbedEndpoints(app) {
*/
try {
const { embedUuid } = request.params;
const embed = await EmbedConfig.get({ uuid: String(embedUuid) });
if (!embed) {
return response.status(404).json({ error: "Embed not found" });
}

const chats = await EmbedChats.where({ embed_id: embed.id });
const formattedChats = chats.map((chat) => ({
id: chat.id,
session_id: chat.session_id,
prompt: chat.prompt,
response: chat.response,
createdAt: chat.createdAt,
}));

response.status(200).json({ chats: formattedChats });
const chats = await EmbedChats.where({
embed_config: { uuid: String(embedUuid) },
});
response.status(200).json({ chats });
} catch (e) {
console.error(e.message, e);
response.sendStatus(500).end();
Expand Down Expand Up @@ -195,30 +186,218 @@ function apiEmbedEndpoints(app) {
*/
try {
const { embedUuid, sessionUuid } = request.params;
const embed = await EmbedConfig.get({ uuid: String(embedUuid) });
if (!embed) {
return response.status(404).json({ error: "Embed not found" });
}

const chats = await EmbedChats.where({
embed_id: embed.id,
embed_config: { uuid: String(embedUuid) },
session_id: String(sessionUuid),
});
response.status(200).json({ chats });
} catch (e) {
console.error(e.message, e);
response.sendStatus(500).end();
}
}
);

if (!chats || chats.length === 0) {
return response
.status(404)
.json({ error: "No chats found for this session" });
app.post("/v1/embed/new", [validApiKey], async (request, response) => {
/*
#swagger.tags = ['Embed']
#swagger.description = 'Create a new embed configuration'
#swagger.requestBody = {
description: 'JSON object containing embed configuration details',
required: true,
content: {
"application/json": {
schema: {
type: 'object',
example: {
"workspace_slug": "workspace-slug-1",
"chat_mode": "chat",
"allowlist_domains": ["example.com"],
"allow_model_override": false,
"allow_temperature_override": false,
"allow_prompt_override": false,
"max_chats_per_day": 100,
"max_chats_per_session": 10
}
}
}
}
}
#swagger.responses[200] = {
content: {
"application/json": {
schema: {
type: 'object',
example: {
"embed": {
"id": 1,
"uuid": "embed-uuid-1",
"enabled": true,
"chat_mode": "chat",
"allowlist_domains": ["example.com"],
"allow_model_override": false,
"allow_temperature_override": false,
"allow_prompt_override": false,
"max_chats_per_day": 100,
"max_chats_per_session": 10,
"createdAt": "2023-04-01T12:00:00Z",
"workspace_slug": "workspace-slug-1"
},
"error": null
}
}
}
}
}
#swagger.responses[403] = {
schema: {
"$ref": "#/definitions/InvalidAPIKey"
}
}
#swagger.responses[404] = {
description: "Workspace not found"
}
*/
try {
const data = reqBody(request);

if (!data.workspace_slug)
return response
.status(400)
.json({ error: "Workspace slug is required" });
const workspace = await Workspace.get({
slug: String(data.workspace_slug),
});

if (!workspace)
return response.status(404).json({ error: "Workspace not found" });

const formattedChats = chats.map((chat) => ({
id: chat.id,
prompt: chat.prompt,
response: chat.response,
createdAt: chat.createdAt,
}));
const { embed, message: error } = await EmbedConfig.new({
...data,
workspace_id: workspace.id,
});

response.status(200).json({ chats: formattedChats });
response.status(200).json({ embed, error });
} catch (e) {
console.error(e.message, e);
response.sendStatus(500).end();
}
});

app.post("/v1/embed/:embedUuid", [validApiKey], async (request, response) => {
/*
#swagger.tags = ['Embed']
#swagger.description = 'Update an existing embed configuration'
#swagger.parameters['embedUuid'] = {
in: 'path',
description: 'UUID of the embed to update',
required: true,
type: 'string'
}
#swagger.requestBody = {
description: 'JSON object containing embed configuration updates',
required: true,
content: {
"application/json": {
schema: {
type: 'object',
example: {
"enabled": true,
"chat_mode": "chat",
"allowlist_domains": ["example.com"],
"allow_model_override": false,
"allow_temperature_override": false,
"allow_prompt_override": false,
"max_chats_per_day": 100,
"max_chats_per_session": 10
}
}
}
}
}
#swagger.responses[200] = {
content: {
"application/json": {
schema: {
type: 'object',
example: {
"success": true,
"error": null
}
}
}
}
}
#swagger.responses[403] = {
schema: {
"$ref": "#/definitions/InvalidAPIKey"
}
}
#swagger.responses[404] = {
description: "Embed not found"
}
*/
try {
const { embedUuid } = request.params;
const data = reqBody(request);

const embed = await EmbedConfig.get({ uuid: String(embedUuid) });
if (!embed) {
return response.status(404).json({ error: "Embed not found" });
}

const { success, error } = await EmbedConfig.update(embed.id, data);
response.status(200).json({ success, error });
} catch (e) {
console.error(e.message, e);
response.sendStatus(500).end();
}
});

app.delete(
"/v1/embed/:embedUuid",
[validApiKey],
async (request, response) => {
/*
#swagger.tags = ['Embed']
#swagger.description = 'Delete an existing embed configuration'
#swagger.parameters['embedUuid'] = {
in: 'path',
description: 'UUID of the embed to delete',
required: true,
type: 'string'
}
#swagger.responses[200] = {
content: {
"application/json": {
schema: {
type: 'object',
example: {
"success": true,
"error": null
}
}
}
}
}
#swagger.responses[403] = {
schema: {
"$ref": "#/definitions/InvalidAPIKey"
}
}
#swagger.responses[404] = {
description: "Embed not found"
}
*/
try {
const { embedUuid } = request.params;
const embed = await EmbedConfig.get({ uuid: String(embedUuid) });
if (!embed)
return response.status(404).json({ error: "Embed not found" });
const success = await EmbedConfig.delete({ id: embed.id });
response
.status(200)
.json({ success, error: success ? null : "Failed to delete embed" });
} catch (e) {
console.error(e.message, e);
response.sendStatus(500).end();
Expand Down
Loading