Interface PremEmbeddingsParams

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

interface PremEmbeddingsParams {
    apiKey?: string;
    baseUrl?: string;
    batchSize?: number;
    encoding_format?: "base64" | "float";
    maxConcurrency?: number;
    maxRetries?: number;
    model: string;
    onFailedAttempt?: FailedAttemptHandler;
    project_id?: string | number;
}

Hierarchy

  • EmbeddingsParams
    • PremEmbeddingsParams

Implemented by

Properties

apiKey? baseUrl? batchSize? encoding_format? maxConcurrency? maxRetries? model onFailedAttempt? project_id?

Properties

OptionalapiKey

apiKey?: string

The Prem API key to use for requests.

Default

process.env.PREM_API_KEY

OptionalbaseUrl

baseUrl?: string

OptionalbatchSize

batchSize?: number

Optionalencoding_format

encoding_format?: "base64" | "float"

OptionalmaxConcurrency

maxConcurrency?: number

The maximum number of concurrent calls that can be made. Defaults to Infinity, which means no limit.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries that can be made for a single call, with an exponential backoff between each attempt. Defaults to 6.

model

model: string

The model to generate the embeddings.

OptionalonFailedAttempt

onFailedAttempt?: FailedAttemptHandler

Custom handler to handle failed attempts. Takes the originally thrown error object as input, and should itself throw an error if the input error is not retryable.

Optionalproject_id

project_id?: string | number

The ID of the project to use.

Settings

Member Visibility

On This Page

Properties