Interface MixedbreadAIRerankParams

Interface extending RerankingRequestWithoutInput with additional parameters specific to the MixedbreadAIRerank class.

interface MixedbreadAIRerankParams {
    apiKey?: string;
    baseUrl?: string;
    maxRetries?: number;
    model?: string;
    rankFields?: string[];
    returnInput?: boolean;
    topK?: number;
}

Hierarchy

  • Omit<RerankingRequestWithoutInput, "model">
    • MixedbreadAIRerankParams

Properties

apiKey? baseUrl? maxRetries? model? rankFields? returnInput? topK?

Properties

OptionalapiKey

apiKey?: string

The API key to use.

Default

{process.env.MXBAI_API_KEY}

OptionalbaseUrl

baseUrl?: string

The base URL of the MixedbreadAI API.

OptionalmaxRetries

maxRetries?: number

The maximum number of retries to attempt.

Default

{3}

Optionalmodel

model?: string

The model to use for reranking. For example "default" or "mixedbread-ai/mxbai-rerank-large-v1".

Default

{"default"}

OptionalrankFields

rankFields?: string[]

The fields of the documents to rank.

OptionalreturnInput

returnInput?: boolean

Whether to return the documents.

OptionaltopK

topK?: number

The number of documents to return.

Settings

Member Visibility

On This Page

Properties