Interface NomicEmbeddingsParams

Interface for NomicEmbeddings parameters. Extends EmbeddingsParams and defines additional parameters specific to the NomicEmbeddings class.

interface NomicEmbeddingsParams {
    apiKey?: string;
    batchSize?: number;
    dimensionality?: number;
    model?: string;
    modelName?: string;
    stripNewLines?: boolean;
    taskType?: "search_query" | "search_document" | "clustering" | "classification";
}

Hierarchy (view full)

Implemented by

Properties

apiKey? batchSize? dimensionality? model? modelName? stripNewLines? taskType?

Properties

Optional apiKey

apiKey?: string

The API key to use.

Default

{process.env.NOMIC_API_KEY}

Optional batchSize

batchSize?: number

The maximum number of documents to embed in a single request.

Default

{400}

Optional dimensionality

dimensionality?: number

The output size of the embedding model. Applicable only to models that support variable dimensionality and defaults to the models largest embedding size.

Optional model

model?: string

The name of the model to use.

Default

{"nomic-embed-text-v1"}

Optional modelName

modelName?: string

The name of the model to use. Alias for model

Default

{"nomic-embed-text-v1"}

Optional stripNewLines

stripNewLines?: boolean

Whether to strip new lines from the input text. This is recommended, but may not be suitable for all use cases.

Default

{true}

Optional taskType

taskType?: "search_query" | "search_document" | "clustering" | "classification"

The task your embeddings should be specialized for: search_query, search_document, clustering, classification.

Default

{"search_document"}

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc