chromadb 3.0.0 → 3.0.1-alpha.0

package/README.md

@@ -0,0 +1,43 @@
+## chromadb
+
+Chroma is the open-source embedding database. Chroma makes it easy to build LLM apps by making knowledge, facts, and skills pluggable for LLMs.
+
+This package gives you a JS/TS interface to talk to a backend Chroma DB over REST.
+
+[Learn more about Chroma](https://github.com/chroma-core/chroma)
+
+- [💬 Community Discord](https://discord.gg/MMeYNTmh3x)
+- [📖 Documentation](https://docs.trychroma.com/)
+- [💡 Colab Example](https://colab.research.google.com/drive/1QEzFyqnoFxq7LUGyP1vzR4iLt9PpCDXv?usp=sharing)
+- [🏠 Homepage](https://www.trychroma.com/)
+
+## Getting started
+
+Chroma needs to be running in order for this client to talk to it. Please see the [🧪 Usage Guide](https://docs.trychroma.com/guides) to learn how to quickly stand this up.
+
+## Small example
+
+```js
+import { ChromaClient } from "chromadb";
+const chroma = new ChromaClient({ path: "http://localhost:8000" });
+const collection = await chroma.createCollection({ name: "test-from-js" });
+for (let i = 0; i < 20; i++) {
+  await collection.add({
+    ids: ["test-id-" + i.toString()],
+    embeddings: [[1, 2, 3, 4, 5]],
+    documents: ["test"],
+  });
+}
+const queryData = await collection.query({
+  queryEmbeddings: [[1, 2, 3, 4, 5]],
+  queryTexts: ["test"],
+});
+```
+
+## Local development
+
+[View the Development Readme](./DEVELOP.md)
+
+## License
+
+Apache 2.0