Interface MinimaxEmbeddingsParams

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

interface MinimaxEmbeddingsParams {
    apiKey?: string;
    batchSize?: number;
    maxConcurrency?: number;
    maxRetries?: number;
    minimaxApiKey?: string;
    minimaxGroupId?: string;
    model: string;
    modelName: string;
    onFailedAttempt?: FailedAttemptHandler;
    stripNewLines?: boolean;
    type?: "query" | "db";
}

Hierarchy

  • EmbeddingsParams
    • MinimaxEmbeddingsParams

Implemented by

Properties

apiKey? batchSize? maxConcurrency? maxRetries? minimaxApiKey? minimaxGroupId? model modelName onFailedAttempt? stripNewLines? type?

Properties

OptionalapiKey

apiKey?: string

Secret key to use when making requests. Defaults to the value of MINIMAX_API_KEY environment variable.

OptionalbatchSize

batchSize?: number

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

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.

OptionalminimaxApiKey

minimaxApiKey?: string

Secret key to use when making requests. Defaults to the value of MINIMAX_API_KEY environment variable. Alias for apiKey

OptionalminimaxGroupId

minimaxGroupId?: string

API key to use when making requests. Defaults to the value of MINIMAX_GROUP_ID environment variable.

model

model: string

Model name to use

modelName

modelName: string

Model name to use Alias for model

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.

OptionalstripNewLines

stripNewLines?: boolean

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

Optionaltype

type?: "query" | "db"

The target use-case after generating the vector. When using embeddings, the vector of the target content is first generated through the db and stored in the vector database, and then the vector of the retrieval text is generated through the query. Note: For the parameters of the partial algorithm, we adopted a separate algorithm plan for query and db. Therefore, for a paragraph of text, if it is to be used as a retrieval text, it should use the db, and if it is used as a retrieval text, it should use the query.

Settings

Member Visibility

On This Page

Properties