Interface OpenAIEmbeddingsParams

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

interface OpenAIEmbeddingsParams {
    model: string;
    modelName: string;
    batchSize?: number;
    dimensions?: number;
    stripNewLines?: boolean;
    timeout?: number;
}

Hierarchy

  • EmbeddingsParams
    • OpenAIEmbeddingsParams

Implemented by

Properties

model modelName batchSize? dimensions? stripNewLines? timeout?

Properties

model

model: string

Model name to use

modelName

modelName: string

Model name to use Alias for model

Optional batchSize

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.

Optional dimensions

dimensions?: number

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

Optional stripNewLines

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

Optional timeout

timeout?: number

Timeout to use when making requests to OpenAI.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc