Interface NomicEmbeddingsParams

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

Hierarchy

Implemented by

Properties

apiKey?: string

The API key to use.

Default

{process.env.NOMIC_API_KEY}
batchSize?: number

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

Default

{400}
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.

maxConcurrency?: number

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

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.

modelName?: string

The name of the model to use.

Default

{"nomic-embed-text-v1"}
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.

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}

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

Default

{"search_document"}

Generated using TypeDoc