Interface OpenAIEmbeddingsParams

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

Hierarchy

  • EmbeddingsParams
    • OpenAIEmbeddingsParams

Implemented by

Properties

modelName batchSize? stripNewLines? timeout?

Properties

modelName

modelName: string

Model name to use

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 stripNewLines

stripNewLines?: boolean

Whether to strip new lines from the input text. This is recommended by OpenAI, but may not be suitable for all use cases.

Optional timeout

timeout?: number

Timeout to use when making requests to OpenAI.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc