Interface InsertOneOptions

Options for the insertOne command.

Field

vector - The vector to use for the document.

See

Collection.insertOne

interface InsertOneOptions {
    maxTimeMS?: number;
    vector?: number[];
    vectorize?: string;
}

Hierarchy (view full)

Properties

maxTimeMS?: number

The maximum time to wait for a response from the server, in milliseconds.

vector?: number[]

An optional vector to use for the document, if using a vector-enabled collection.

This is purely for the user's convenience and intuitiveness—it is equivalent to setting the $vector field on the document itself. The two are interchangeable, but mutually exclusive.

NB. Setting this field will cause a shallow copy of the document to be made. If performance is a concern, it is recommended to directly set the $vector field on the document itself.

If the document already has a $vector field, and this is set, the $vector field will be overwritten. It is up to the user to ensure that both fields are not set at once.

Deprecated

  • Prefer to set the $vector field in the doc directly
vectorize?: string

NOTE: This feature is under current development.

Deprecated

  • Prefer to set the $vectorize field in the doc directly