Interface AzureOpenAIEmbeddingsParams

interface AzureOpenAIEmbeddingsParams {
    batchSize?: number;
    model?: string;
    modelName?: string;
    stripNewLines?: boolean;
    timeout?: number;
    user?: string;
}

Hierarchy

  • EmbeddingsParams
    • AzureOpenAIEmbeddingsParams

Implemented by

Properties

batchSize? model? modelName? stripNewLines? timeout? user?

Properties

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 model

model?: string

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.

Optional modelName

modelName?: string

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. Alias for model

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.

Optional user

user?: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc