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;
    maxConcurrency?: number;
    maxRetries?: number;
    model?: string;
    modelName?: string;
    onFailedAttempt?: FailedAttemptHandler;
    stripNewLines?: boolean;
    taskType?: EmbeddingTaskType;
}

Hierarchy

  • EmbeddingsParams
    • NomicEmbeddingsParams

Implemented by

Properties

apiKey? batchSize? dimensionality? maxConcurrency? maxRetries? model? modelName? onFailedAttempt? stripNewLines? taskType?

Properties

OptionalapiKey

apiKey?: string

The API key to use.

Default

{process.env.NOMIC_API_KEY}

OptionalbatchSize

batchSize?: number

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

Default

{400}

Optionaldimensionality

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.

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

Optionalmodel

model?: string

The name of the model to use.

Default

{"nomic-embed-text-v1"}

OptionalmodelName

modelName?: string

The name of the model to use. Alias for model

Default

{"nomic-embed-text-v1"}

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

OptionalstripNewLines

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}

OptionaltaskType

taskType?: EmbeddingTaskType

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

Default

{"search_document"}

Settings

Member Visibility

On This Page

Properties