Interface that extends EmbeddingsParams and defines additional parameters specific to the ZhipuAIEmbeddingsParams class.

interface ZhipuAIEmbeddingsParams {
    apiKey?: string;
    maxConcurrency?: number;
    maxRetries?: number;
    modelName?: "embedding-2";
    onFailedAttempt?: FailedAttemptHandler;
    stripNewLines?: boolean;
}

Hierarchy

  • EmbeddingsParams
    • ZhipuAIEmbeddingsParams

Implemented by

Properties

apiKey?: string

ZhipuAI API key to use

maxConcurrency?: number

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

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.

modelName?: "embedding-2"

Model Name to use

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.

stripNewLines?: boolean

Whether to strip new lines from the input text.