Interface JinaEmbeddingsParams

Input parameters for the Jina embeddings

interface JinaEmbeddingsParams {
    apiKey?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    model?: string;
    onFailedAttempt?: FailedAttemptHandler;
}

Hierarchy

  • EmbeddingsParams
    • JinaEmbeddingsParams

Implemented by

Properties

apiKey? maxConcurrency? maxRetries? model? onFailedAttempt?

Properties

OptionalapiKey

apiKey?: string

The API key to use for authentication. If not provided, it will be read from the JINA_API_KEY environment variable.

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 model ID to use for generating embeddings. Default: jina-embeddings-v2-base-en

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.

Settings

Member Visibility

On This Page

Properties