chromadb 2.4.6 → 3.0.1-alpha.0

package/LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

package/README.md

@@ -1,98 +1,43 @@
-# ChromaDB JavaScript Client
+## 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 includes all embedding libraries as bundled dependencies**, providing a simple installation experience without worrying about dependency management. For a thin client, install `chromadb-client`
+This package gives you a JS/TS interface to talk to a backend Chroma DB over REST.
 
-## Features
+[Learn more about Chroma](https://github.com/chroma-core/chroma)
 
-- ✅ Complete TypeScript support
-- ✅ All embedding libraries included as bundled dependencies
-- ✅ Works in both Node.js and browser environments
-- ✅ Simple installation with no peer dependency requirements
-
-## Installation
-
-```bash
-# npm
-npm install chromadb
-
-# pnpm
-pnpm add chromadb
+- [💬 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/)
 
-# yarn
-yarn add chromadb
-```
+## Getting started
 
-## 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.
 
-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";
-
-// Initialize the client
 const chroma = new ChromaClient({ path: "http://localhost:8000" });
-
-// Create a collection
-const collection = await chroma.createCollection({ name: "my-collection" });
-
-// Add documents to the collection
-await collection.add({
-  ids: ["id1", "id2"],
-  embeddings: [
-    [1.1, 2.3, 3.2],
-    [4.5, 6.9, 4.4],
-  ],
-  metadatas: [{ source: "doc1" }, { source: "doc2" }],
-  documents: ["Document 1 content", "Document 2 content"],
-});
-
-// Query the collection
-const results = await collection.query({
-  queryEmbeddings: [1.1, 2.3, 3.2],
-  nResults: 2,
+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"],
 });
 ```
 
-## Using Embedding Functions
-
-This package includes all embedding libraries as bundled dependencies, so you can use them directly:
-
-```js
-import { ChromaClient, OpenAIEmbeddingFunction } from "chromadb";
+## Local development
 
-const embedder = new OpenAIEmbeddingFunction({
-  openai_api_key: "your-api-key",
-  model_name: "text-embedding-ada-002",
-});
-
-const chroma = new ChromaClient({ path: "http://localhost:8000" });
-const collection = await chroma.createCollection({
-  name: "my-collection",
-  embeddingFunction: embedder,
-});
-
-// Now you can add documents without providing embeddings
-await collection.add({
-  ids: ["id1"],
-  documents: ["Document content"],
-});
-
-// And query with text
-const results = await collection.query({
-  queryTexts: ["similar document"],
-  nResults: 2,
-});
-```
-
-## Additional Resources
-
-- [📖 Documentation](https://docs.trychroma.com/)
-- [💬 Community Discord](https://discord.gg/MMeYNTmh3x)
-- [🏠 Homepage](https://www.trychroma.com/)
-- [GitHub Repository](https://github.com/chroma-core/chroma)
+[View the Development Readme](./DEVELOP.md)
 
 ## License
 
-Apache 2.0
+Apache 2.0