Skip to content

Commit

Permalink
modify reference
Browse files Browse the repository at this point in the history
  • Loading branch information
spikechroma committed Aug 24, 2024
1 parent 476cadc commit 55da033
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/docs.trychroma.com/pages/reference/js-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const response = await collection.add({
| `params` | `Object` | The parameters for the query. |
| `params.documents?` | `string` \| `Documents` | Optional documents of the items to add. |
| `params.embeddings?` | `Embedding` \| `Embeddings` | Optional embeddings of the items to add. |
| `params.ids` | `string` \| `IDs` | IDs of the items to add. |
| `params.ids` | `string` \| `IDs` | Optional IDs of the items to add. |
| `params.metadatas?` | `Metadata` \| `Metadatas` | Optional metadata of the items to add. |

#### Returns
Expand Down
8 changes: 4 additions & 4 deletions docs/docs.trychroma.com/pages/reference/py-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,25 @@ The total number of embeddings added to the database
### add

```python
def add(ids: OneOrMany[ID],
def add(ids: Optiona[OneOrMany[ID]] = None,
embeddings: Optional[OneOrMany[Embedding]] = None,
metadatas: Optional[OneOrMany[Metadata]] = None,
documents: Optional[OneOrMany[Document]] = None) -> None
documents: Optional[OneOrMany[Document]] = None) -> AddResult
```

Add embeddings to the data store.

**Arguments**:

- `ids` - The ids of the embeddings you wish to add
- `ids` - The ids of the embeddings you wish to add. If None, Chroma will generate IDs using uuid v4.
- `embeddings` - The embeddings to add. If None, embeddings will be computed based on the documents using the embedding_function set for the Collection. Optional.
- `metadatas` - The metadata to associate with the embeddings. When querying, you can filter on this metadata. Optional.
- `documents` - The documents to associate with the embeddings. Optional.


**Returns**:

None
- `AddResult` - An AddResult object containing IDs.


**Raises**:
Expand Down

0 comments on commit 55da033

Please sign in to comment.