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

Integrate python api #11

Closed
wants to merge 5 commits into from
Closed

Integrate python api #11

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
e735bc7
Remove supabase and add signup & signin with python api
gcharis Nov 27, 2023
a294bdf
Logout
gcharis Nov 27, 2023
e727d1e
Create api key
gcharis Nov 27, 2023
c428856
Show api key
gcharis Nov 27, 2023
e81694c
Merge branch 'preview' of github.com:squaredev-io/squaredev into inte…
gcharis Nov 29, 2023
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
249 changes: 0 additions & 249 deletions cypress/e2e/public-api.cy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,252 +1,3 @@
import { Chat } from 'openai/resources';
import { supabaseExecute } from '../../src/lib/public-api/database';
import {
DocumentsResponse,
CreateIndexResponse,
GetIndexesResponse,
ChatCompletionResponse,
RagCompletionResponse,
SimilarDocumentsResponse,
} from '../../src/lib/public-api/validation';
import { Project, Index } from '../../src/types/supabase-entities';

let state = {
project: null as Project | null,
index: null as Index | null,
};

const routes = {
getIndexes: '/api/indexes',
searchIndex: '/api/indexes/search',
postDocuments: '/api/documents',
getDocuments: '/api/documents',
searchDocuments: '/api/documents/search',
chat: '/api/chat/completions',
rag: '/api/chat/rag',
};

context('Test Public API', () => {
before(async () => {});

it('gets the project to be tested from database', () => {
const query = `select * from projects where name = 'Test project'`;
cy.task('supabaseExecute', query).then(({ data, error }: any) => {
expect(data[0].name).to.eq('Test project');
state.project = data[0];
});
});

context(`POST ${routes.getIndexes}`, () => {
it('should fail when there are no correct headers', () => {
cy.request({
method: 'POST',
url: routes.getIndexes,
failOnStatusCode: false,
}).then((response) => {
expect(response.status).to.eq(401);
});
});

it('should create a new index', () => {
const name = `Test index ${new Date().getTime()}`;
cy.request({
method: 'POST',
url: routes.getIndexes,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
body: {
name,
},
}).then((response) => {
expect(response.status).to.eq(200);
expect(response.body.name).to.eq(name);
CreateIndexResponse.parse(response.body);
});
});
});

context(`GET ${routes.getIndexes}`, () => {
it('should fail when there are no correct headers', () => {
cy.request({
method: 'GET',
url: routes.getIndexes,
failOnStatusCode: false,
}).then((response) => {
expect(response.status).to.eq(401);
});
});

it('should return the indexes', () => {
cy.request({
method: 'GET',
url: routes.getIndexes,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
}).then((response) => {
expect(response.status).to.eq(200);
expect(response.body.length).to.greaterThan(0);
GetIndexesResponse.parse(response.body);
state.index = response.body[0];
});
});
});

context(`POST ${routes.postDocuments}`, () => {
it('should load documents to an index along with metadata ', () => {
cy.request({
method: 'POST',
url: `${routes.postDocuments}?index_id=${state.index?.id}`,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
body: [
{
content: 'The name of the company is SquareDev.',
source: 'the founders',
metadata: { string: 'string' },
},
],
}).then((response) => {
expect(response.status).to.eq(200);
expect(response.body.length).to.greaterThan(0);
DocumentsResponse.parse(response.body);
});
});

it('should fail when there is no content in the document', () => {
cy.request({
failOnStatusCode: false,
method: 'POST',
url: `${routes.postDocuments}?index_id=${state.index?.id}`,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
body: [
{
source: 'string',
metadata: { string: 'string' },
},
],
}).then((response) => {
// TODO: This should be 400
expect(response.status).to.eq(500);
});
});
});

context(`POST ${routes.postDocuments}/upload`, () => {
it.skip('json', () => {});
it.skip('pdf', () => {});
});

context(`POST ${routes.postDocuments}/web`, () => {});

context(`GET ${routes.getDocuments}`, () => {
it('should get the documents of an index', () => {
cy.request({
method: 'GET',
url: `${routes.postDocuments}?index_id=${state.index?.id}`,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
}).then((response) => {
expect(response.status).to.eq(200);
expect(response.body.length).to.greaterThan(0);
DocumentsResponse.parse(response.body);
});
});

it.skip('return the correct error for wrong indexes', () => {});
});

context(`GET ${routes.searchIndex}`, () => {
it('should get the documents of an index that are contextually similar to the search term', () => {
cy.request({
method: 'GET',
url: `${routes.searchIndex}?index_id=${state.index?.id}&search=A random`,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
}).then((response) => {
expect(response.status).to.eq(200);
expect(response.body.length).to.greaterThan(0);
SimilarDocumentsResponse.parse(response.body);
});
});

it.skip('return the correct error for wrong indexes', () => {});
it.skip('return the correct error for no search term', () => {});
});

context(`POST /chat/completions`, () => {
it('should chat with the LLM, only completing the requested prompt', () => {
cy.request({
method: 'POST',
url: `/api/chat/completions?model=gpt-3.5-turbo`,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
body: {
model: 'gpt-3.5-turbo',
messages: {
system: 'Hello, how are you?',
user: 'I am fine, how are you?',
},
},
}).then((response) => {
expect(response.status).to.eq(200);
ChatCompletionResponse.parse(response.body);
});
});
});

context(`POST ${routes.rag}`, () => {
it('chats with RAG', () => {
cy.request({
method: 'POST',
url: `${routes.rag}?model=gpt-3.5-turbo`,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
body: {
model: 'gpt-3.5-turbo',
messages: {
system:
'You are a helpful assistant. Try to answer the question using the given context.',
user: 'Context: {context} \nQuestion: What is the name of the company?',
},
indexId: state.index?.id,
},
}).then((response) => {
expect(response.status).to.eq(200);
expect(response.body.message).to.include('SquareDev');
console.log(response.body);
RagCompletionResponse.parse(response.body);
});
});

it('returns an error if no {context} placeholder', () => {
cy.request({
method: 'POST',
url: `${routes.rag}`,
failOnStatusCode: false,
headers: {
authentication: `Bearer ${state.project?.api_key}`,
},
body: {
model: 'gpt-3.5-turbo',
messages: {
system:
'You are a helpful assistant. Try to answer the question using the given context.',
user: 'Context: no context placeholder \nQuestion: What is the name of the company?',
},
indexId: state.index?.id,
},
}).then((response) => {
expect(response.status).to.eq(400);
});
});
});
});
17 changes: 4 additions & 13 deletions next.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,9 @@
/** @type {import('next').NextConfig} */
const nextConfig = {
redirects() {
return [
{
source: '/',
destination: '/dashboard/projects',
permanent: true,
},
{
source: '/dashboard',
destination: '/dashboard/projects',
permanent: true,
},
];
experimental: {
serverActions: {
bodySizeLimit: '2mb',
},
},
};

Expand Down
Loading