Hierarchy

Implements

Constructors

Properties

batchSize: number = 512

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

modelName: string = "text-embedding-ada-002"

The model name to provide as part of this embeddings request. Not applicable to Azure OpenAI, where deployment information should be included in the Azure resource URI that's connected to.

stripNewLines: boolean = true

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

azureOpenAIApiKey?: string

API key to use when making requests to Azure OpenAI.

azureOpenAIEmbeddingsApiDeploymentName?: string
azureOpenAIEndpoint?: string

Endpoint to use when making requests to Azure OpenAI

timeout?: number

Timeout to use when making requests to OpenAI.

user?: string

An identifier for the caller or end user of the operation. This may be used for tracking or rate-limiting purposes.

Methods

Generated using TypeDoc