From ceab208e8888eb8f210a08c075b8946612373e2a Mon Sep 17 00:00:00 2001 From: Trayan Azarov Date: Tue, 9 Jul 2024 21:22:13 +0300 Subject: [PATCH] fix: Fixed a typo in collection.modify parameter name for new collection name --- docs/core/collections.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/core/collections.md b/docs/core/collections.md index abf2e59..5268e1e 100644 --- a/docs/core/collections.md +++ b/docs/core/collections.md @@ -9,7 +9,7 @@ Collections are the grouping mechanism for embeddings, documents, and metadata. Each collection is characterized by the following properties: - `name`: The name of the collection. The name can be changed as long as it is unique within the database ( - use `collection.modify(new_name="new_name")` to change the name of the collection + use `collection.modify(name="new_name")` to change the name of the collection - `metadata`: A dictionary of metadata associated with the collection. The metadata is a dictionary of key-value pairs. Keys can be strings, values can be strings, integers, floats, or booleans. Metadata can be changed using `collection.modify(new_metadata={"key": "value"})` (Note: Metadata is always overwritten when modified) @@ -161,7 +161,7 @@ Parameters: | Name | Description | Default Value | Type | |------------|------------------------------------------------------------------------|---------------|------------| -| `new_name` | The new name of the collection. Parameter is required | N/A | String | +| `name` | The new name of the collection. Parameter is required | N/A | String | | `metadata` | Metadata associated with the collection. This is an optional parameter | `None` | Dictionary | Both collection properties (`name` and `metadata`) can be modified, separately ot together.