JS Collection

Class: Collection#

Properties#

id#

id: string


metadata#

metadata: undefined | CollectionMetadata


name#

name: string

Methods#

add#

add(params): Promise<AddResponse>

Add items to the collection

Example

javascript

Parameters#

NameTypeDescription
paramsObjectThe parameters for the query.
params.documents?string | DocumentsOptional documents of the items to add.
params.embeddings?Embedding | EmbeddingsOptional embeddings of the items to add.
params.idsstring | IDsIDs of the items to add.
params.metadatas?Metadata | MetadatasOptional metadata of the items to add.

Returns#

Promise<AddResponse>

  • The response from the API. True if successful.

count#

count(): Promise<number>

Count the number of items in the collection

Example

javascript

Returns#

Promise<number>

  • The response from the API.

delete#

delete(params?): Promise<string[]>

Deletes items from the collection.

Throws

If there is an issue deleting items from the collection.

Example

javascript

Parameters#

NameTypeDescription
paramsObjectThe parameters for deleting items from the collection.
params.ids?string | IDsOptional ID or array of IDs of items to delete.
params.where?WhereOptional query condition to filter items to delete based on metadata values.
params.whereDocument?WhereDocumentOptional query condition to filter items to delete based on document content.

Returns#

Promise<string[]>

A promise that resolves to the IDs of the deleted items.


get#

get(params?): Promise<GetResponse>

Get items from the collection

Example

javascript

Parameters#

NameTypeDescription
paramsObjectThe parameters for the query.
params.ids?string | IDsOptional IDs of the items to get.
params.include?IncludeEnum[]Optional list of items to include in the response.
params.limit?numberOptional limit on the number of items to get.
params.offset?numberOptional offset on the items to get.
params.where?WhereOptional where clause to filter items by.
params.whereDocument?WhereDocumentOptional where clause to filter items by.

Returns#

Promise<GetResponse>

  • The response from the server.

modify#

modify(params?): Promise<void>

Modify the collection name or metadata

Example

javascript

Parameters#

NameTypeDescription
paramsObjectThe parameters for the query.
params.metadata?CollectionMetadataOptional new metadata for the collection.
params.name?stringOptional new name for the collection.

Returns#

Promise<void>

  • The response from the API.

peek#

peek(params?): Promise<GetResponse>

Peek inside the collection

Throws

If there is an issue executing the query.

Example

javascript

Parameters#

NameTypeDescription
paramsObjectThe parameters for the query.
params.limit?numberOptional number of results to return (default is 10).

Returns#

Promise<GetResponse>

A promise that resolves to the query results.


query#

query(params): Promise<QueryResponse>

Performs a query on the collection using the specified parameters.

Throws

If there is an issue executing the query.

Example

javascript

Example

javascript

Parameters#

NameTypeDescription
paramsObjectThe parameters for the query.
params.include?IncludeEnum[]Optional array of fields to include in the result, such as "metadata" and "document".
params.nResults?numberOptional number of results to return (default is 10).
params.queryEmbeddings?Embedding | EmbeddingsOptional query embeddings to use for the search.
params.queryTexts?string | string[]Optional query text(s) to search for in the collection.
params.where?WhereOptional query condition to filter results based on metadata values.
params.whereDocument?WhereDocumentOptional query condition to filter results based on document content.

Returns#

Promise<QueryResponse>

A promise that resolves to the query results.


update#

update(params): Promise<boolean>

Update the embeddings, documents, and/or metadatas of existing items

Example

javascript

Parameters#

NameTypeDescription
paramsObjectThe parameters for the query.
params.documents?string | DocumentsOptional documents to update.
params.embeddings?Embedding | EmbeddingsOptional embeddings to update.
params.idsstring | IDsThe IDs of the items to update.
params.metadatas?Metadata | MetadatasOptional metadatas to update.

Returns#

Promise<boolean>

  • The API Response. True if successful. Else, error.

upsert#

upsert(params): Promise<boolean>

Upsert items to the collection

Example

javascript

Parameters#

NameTypeDescription
paramsObjectThe parameters for the query.
params.documents?string | DocumentsOptional documents of the items to add.
params.embeddings?Embedding | EmbeddingsOptional embeddings of the items to add.
params.idsstring | IDsIDs of the items to add.
params.metadatas?Metadata | MetadatasOptional metadata of the items to add.

Returns#

Promise<boolean>

  • The response from the API. True if successful.