langchain.js
    Preparing search index...

    Interface OpenAIEmbeddingsParams

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

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

    Hierarchy (View Summary)

    Index

    Properties

    batchSize? dimensions? encodingFormat? model modelName stripNewLines? timeout?

    Properties

    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.

    dimensions?: number

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

    encodingFormat?: "float" | "base64"

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

    model: OpenAIEmbeddingModelId

    Model name to use

    modelName: OpenAIEmbeddingModelId

    Model name to use Alias for model

    Use "model" instead.

    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

    timeout?: number

    Timeout to use when making requests to OpenAI.

    Settings

    Member Visibility

    On This Page

    Properties