Interface VoyageEmbeddingsParams

Interface that extends EmbeddingsParams and defines additional parameters specific to the VoyageEmbeddings class.

interface VoyageEmbeddingsParams {
    batchSize?: number;
    encodingFormat?: string;
    inputType?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    modelName: string;
    onFailedAttempt?: FailedAttemptHandler;
    outputDimension?: number;
    outputDtype?: string;
    truncation?: boolean;
}

Hierarchy

  • EmbeddingsParams
    • VoyageEmbeddingsParams

Implemented by

Properties

batchSize? encodingFormat? inputType? maxConcurrency? maxRetries? modelName onFailedAttempt? outputDimension? outputDtype? truncation?

Properties

OptionalbatchSize

batchSize?: number

The maximum number of documents to embed in a single request. This is limited by the Voyage AI API to a maximum of 8.

OptionalencodingFormat

encodingFormat?: string

The format of the output embeddings. Can be "float", "base64", or "ubinary".

OptionalinputType

inputType?: string

Input type for the embeddings request.

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.

modelName

modelName: string

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.

OptionaloutputDimension

outputDimension?: number

The desired dimension of the output embeddings.

OptionaloutputDtype

outputDtype?: string

The data type of the output embeddings. Can be "float" or "int8".

Optionaltruncation

truncation?: boolean

Whether to truncate the input texts to the maximum length allowed by the model.

Settings

Member Visibility

On This Page

Properties