Interface OpenAIEmbeddingsParams

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

interface OpenAIEmbeddingsParams {
    batchSize?: number;
    dimensions?: number;
    encodingFormat?: "base64" | "float";
    maxConcurrency?: number;
    maxRetries?: number;
    model: OpenAIEmbeddingModelId;
    modelName: OpenAIEmbeddingModelId;
    onFailedAttempt?: FailedAttemptHandler;
    stripNewLines?: boolean;
    timeout?: number;
}

Hierarchy

  • EmbeddingsParams
    • OpenAIEmbeddingsParams

Properties

batchSize? dimensions? encodingFormat? maxConcurrency? maxRetries? model modelName onFailedAttempt? stripNewLines? timeout?

Properties

OptionalbatchSize

batchSize?: number

The maximum number of documents to embed in a single request. This is limited by the OpenAI API to a maximum of 2048.

Optionaldimensions

dimensions?: number

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

OptionalencodingFormat

encodingFormat?: "base64" | "float"

The format to return the embeddings in. Can be either 'float' or 'base64'.

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.

model

model: OpenAIEmbeddingModelId

Model name to use

modelName

modelName: OpenAIEmbeddingModelId

Model name to use Alias for model

Deprecated

Use "model" instead.

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 by OpenAI for older models, but may not be suitable for all use cases. See: https://github.com/openai/openai-python/issues/418#issuecomment-1525939500

Optionaltimeout

timeout?: number

Timeout to use when making requests to OpenAI.

Settings

Member Visibility

On This Page

Properties