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

Add tests for embedding function #10

Merged
merged 2 commits into from
Nov 5, 2024
Merged

Add tests for embedding function #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f95944
Add tests for embedding function
BlackyDrum Nov 5, 2024
477106c
Untabify lines
BlackyDrum Nov 5, 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: 2 additions & 0 deletions .github/workflows/tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ on:
jobs:
build:
runs-on: ubuntu-latest
env:
JINA_API_KEY: ${{ secrets.JINA_API_KEY }}

services:
chroma-no-auth:
Expand Down
222 changes: 221 additions & 1 deletion tests/test_client.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,23 @@

#include "ChromaDB/ChromaDB.h"

#include <cstdlib>

#pragma warning(disable: 4996)

using namespace chromadb;

class ClientTest : public ::testing::Test {
protected:
Client* client;

std::string jinaApiKey;
protected:
void SetUp() override
{
client = new Client("http", "localhost", "8080", "test_database", "test_tenant", "");

jinaApiKey = GetEnvVar("JINA_API_KEY");
}

void TearDown() override
Expand All @@ -22,6 +30,12 @@ class ClientTest : public ::testing::Test {

delete client;
}
private:
std::string GetEnvVar(const std::string& name)
{
const char* value = std::getenv(name.c_str());
return value == nullptr ? "" : std::string(value);
}
};

TEST_F(ClientTest, ConstructorInitializesCorrectly)
Expand Down Expand Up @@ -1508,4 +1522,210 @@ TEST_F(ClientTest, ThrowsIfEmptyIdForAdd)
std::vector<std::unordered_map<std::string, std::string>> metadatas = { { {"key1", "value1"} }, { {"key1", "value2"} }, { {"key1", "value3"} } };

EXPECT_THROW(client->AddEmbeddings(collection, ids, embeddings, metadatas, documents), ChromaInvalidArgumentException);
}
}

TEST_F(ClientTest, CanAddEmbeddingsUsingEmbeddingFunctionWithManualGeneration)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>(jinaApiKey, "jina-embeddings-v3");

chromadb::Collection collection = client->CreateCollection("test_collection", {}, embeddingFunction);

std::vector<std::string> ids = { "ID1", "ID2", "ID3" };
std::vector<std::string> documents = { "document1", "document2", "document3" };
auto embeddings = embeddingFunction->Generate(documents);

EXPECT_EQ(embeddings.size(), 3);
EXPECT_EQ(embeddings[0].size(), 1024);
EXPECT_EQ(embeddings[1].size(), 1024);
EXPECT_EQ(embeddings[2].size(), 1024);

client->AddEmbeddings(collection, ids, embeddings, {}, documents);

auto queryResponse = client->GetEmbeddings(collection, ids, { "embeddings", "documents" }, {}, {});
EXPECT_EQ(queryResponse.size(), 3);

EXPECT_EQ(queryResponse[0].id, "ID1");
EXPECT_EQ(queryResponse[0].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[0].document, "document1");

EXPECT_EQ(queryResponse[1].id, "ID2");
EXPECT_EQ(queryResponse[1].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[1].document, "document2");

EXPECT_EQ(queryResponse[2].id, "ID3");
EXPECT_EQ(queryResponse[2].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[2].document, "document3");
}

TEST_F(ClientTest, CanAddEmbeddingsUsingEmbeddingFunctionWithAutoGeneration)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>(jinaApiKey, "jina-embeddings-v3");

chromadb::Collection collection = client->CreateCollection("test_collection", {}, embeddingFunction);

std::vector<std::string> ids = { "ID1", "ID2", "ID3" };
std::vector<std::string> documents = { "document1", "document2", "document3" };

client->AddEmbeddings(collection, ids, {}, {}, documents);

auto queryResponse = client->GetEmbeddings(collection, ids, { "embeddings", "documents" }, {}, {});
EXPECT_EQ(queryResponse.size(), 3);

EXPECT_EQ(queryResponse[0].id, "ID1");
EXPECT_EQ(queryResponse[0].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[0].document, "document1");

EXPECT_EQ(queryResponse[1].id, "ID2");
EXPECT_EQ(queryResponse[1].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[1].document, "document2");

EXPECT_EQ(queryResponse[2].id, "ID3");
EXPECT_EQ(queryResponse[2].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[2].document, "document3");
}

TEST_F(ClientTest, CanAddEmbeddingsUsingEmbeddingFunctionWithManuallySettingEmbeddingFunction)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>(jinaApiKey, "jina-embeddings-v3");

chromadb::Collection collection = client->CreateCollection("test_collection", {});
collection.SetEmbeddingFunction(embeddingFunction);

std::vector<std::string> ids = { "ID1", "ID2", "ID3" };
std::vector<std::string> documents = { "document1", "document2", "document3" };

client->AddEmbeddings(collection, ids, {}, {}, documents);

auto queryResponse = client->GetEmbeddings(collection, ids, { "embeddings", "documents" }, {}, {});
EXPECT_EQ(queryResponse.size(), 3);

EXPECT_EQ(queryResponse[0].id, "ID1");
EXPECT_EQ(queryResponse[0].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[0].document, "document1");

EXPECT_EQ(queryResponse[1].id, "ID2");
EXPECT_EQ(queryResponse[1].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[1].document, "document2");

EXPECT_EQ(queryResponse[2].id, "ID3");
EXPECT_EQ(queryResponse[2].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[2].document, "document3");
}

TEST_F(ClientTest, CanAddEmbeddingsUsingEmbeddingFunctionWithAutoGenerationAndMetadata)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>(jinaApiKey, "jina-embeddings-v3");

chromadb::Collection collection = client->CreateCollection("test_collection", {}, embeddingFunction);

std::vector<std::string> ids = { "ID1", "ID2", "ID3" };
std::vector<std::string> documents = { "document1", "document2", "document3" };
std::vector<std::unordered_map<std::string, std::string>> metadatas = { { {"key1", "value1"} }, { {"key1", "value2"} }, { {"key1", "value3"} } };

client->AddEmbeddings(collection, ids, {}, metadatas, documents);

auto queryResponse = client->GetEmbeddings(collection, ids, { "embeddings", "documents", "metadatas" }, {}, {});
EXPECT_EQ(queryResponse.size(), 3);

EXPECT_EQ(queryResponse[0].id, "ID1");
EXPECT_EQ(queryResponse[0].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[0].document, "document1");
EXPECT_EQ(queryResponse[0].metadata->size(), 1);
EXPECT_EQ(queryResponse[0].metadata->at("key1"), "value1");

EXPECT_EQ(queryResponse[1].id, "ID2");
EXPECT_EQ(queryResponse[1].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[1].document, "document2");
EXPECT_EQ(queryResponse[1].metadata->size(), 1);
EXPECT_EQ(queryResponse[1].metadata->at("key1"), "value2");

EXPECT_EQ(queryResponse[2].id, "ID3");
EXPECT_EQ(queryResponse[2].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[2].document, "document3");
EXPECT_EQ(queryResponse[2].metadata->size(), 1);
EXPECT_EQ(queryResponse[2].metadata->at("key1"), "value3");
}

TEST_F(ClientTest, CanAddEmbeddingsUsingEmbeddingFunctionWithManualGenerationAndMetadata)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>(jinaApiKey, "jina-embeddings-v3");

chromadb::Collection collection = client->CreateCollection("test_collection", {}, embeddingFunction);

std::vector<std::string> ids = { "ID1", "ID2", "ID3" };
std::vector<std::string> documents = { "document1", "document2", "document3" };
auto embeddings = embeddingFunction->Generate(documents);
std::vector<std::unordered_map<std::string, std::string>> metadatas = { { {"key1", "value1"} }, { {"key1", "value2"} }, { {"key1", "value3"} } };

client->AddEmbeddings(collection, ids, embeddings, metadatas, documents);

auto queryResponse = client->GetEmbeddings(collection, ids, { "embeddings", "documents", "metadatas" }, {}, {});
EXPECT_EQ(queryResponse.size(), 3);

EXPECT_EQ(queryResponse[0].id, "ID1");
EXPECT_EQ(queryResponse[0].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[0].document, "document1");
EXPECT_EQ(queryResponse[0].metadata->size(), 1);
EXPECT_EQ(queryResponse[0].metadata->at("key1"), "value1");

EXPECT_EQ(queryResponse[1].id, "ID2");
EXPECT_EQ(queryResponse[1].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[1].document, "document2");
EXPECT_EQ(queryResponse[1].metadata->size(), 1);
EXPECT_EQ(queryResponse[1].metadata->at("key1"), "value2");

EXPECT_EQ(queryResponse[2].id, "ID3");
EXPECT_EQ(queryResponse[2].embeddings->size(), 1024);
EXPECT_EQ(*queryResponse[2].document, "document3");
EXPECT_EQ(queryResponse[2].metadata->size(), 1);
EXPECT_EQ(queryResponse[2].metadata->at("key1"), "value3");
}

TEST_F(ClientTest, ThrowsIfWrongApiKeyForEmbeddingFunction)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>("wrong-api-key", "jina-embeddings-v3");

chromadb::Collection collection = client->CreateCollection("test_collection", {}, embeddingFunction);

std::vector<std::string> ids = { "ID1", "ID2", "ID3" };
std::vector<std::string> documents = { "document1", "document2", "document3" };

EXPECT_THROW(client->AddEmbeddings(collection, ids, {}, {}, documents), EmbeddingProviderRequestException);
}

TEST_F(ClientTest, ThrowsIfWrongEmbeddingModelNameForEmbeddingFunction)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>(jinaApiKey, "wrong-embedding-model");

chromadb::Collection collection = client->CreateCollection("test_collection", {}, embeddingFunction);

std::vector<std::string> ids = { "ID1", "ID2", "ID3" };
std::vector<std::string> documents = { "document1", "document2", "document3" };

EXPECT_THROW(client->AddEmbeddings(collection, ids, {}, {}, documents), EmbeddingProviderRequestException);
}

TEST_F(ClientTest, ThrowsIfWrongHostForEmbeddingFunction)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>(jinaApiKey, "jina-embeddings-v3", "wrong-host");

chromadb::Collection collection = client->CreateCollection("test_collection", {}, embeddingFunction);

std::vector<std::string> ids = { "ID1", "ID2", "ID3" };
std::vector<std::string> documents = { "document1", "document2", "document3" };

EXPECT_THROW(client->AddEmbeddings(collection, ids, {}, {}, documents), EmbeddingProviderConnectionException);
}

TEST_F(ClientTest, CanGetRequestMetadataFromEmbeddingFunction)
{
std::shared_ptr<EmbeddingFunction> embeddingFunction = std::make_shared<JinaEmbeddingFunction>(jinaApiKey, "jina-embeddings-v3");
auto embeddings = embeddingFunction->Generate({ "document1", "document2", "document3" });

auto requestMetadata = embeddingFunction->GetRequestMetadata();

EXPECT_EQ(requestMetadata["model"], "jina-embeddings-v3");
EXPECT_EQ(requestMetadata["object"], "list");
EXPECT_GT(requestMetadata["usage"]["prompt_tokens"], 0);
EXPECT_GT(requestMetadata["usage"]["total_tokens"], 0);
}
Loading