Skip to main content

Interface: MixedbreadAIRerankerParams

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

Extends​

  • Omit<RerankingRequestWithoutInput, "model">

Properties​

apiKey?​

optional apiKey: string

The API key to use.

Default​

{process.env.MXBAI_API_KEY}

Defined in​

packages/llamaindex/src/postprocessors/rerankers/MixedbreadAIReranker.ts:32

baseUrl?​

optional baseUrl: string

The base URL of the MixedbreadAI API.

Defined in​

packages/llamaindex/src/postprocessors/rerankers/MixedbreadAIReranker.ts:37

maxRetries?​

optional maxRetries: number

The maximum number of retries to attempt.

Default​

{3}

Defined in​

packages/llamaindex/src/postprocessors/rerankers/MixedbreadAIReranker.ts:43

model?​

optional model: string

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

Default​

{"default"}

Defined in​

packages/llamaindex/src/postprocessors/rerankers/MixedbreadAIReranker.ts:26

rankFields?​

optional rankFields: string[]

The fields of the documents to rank.

Inherited from​

Omit.rankFields

Defined in​

node_modules/.pnpm/@mixedbread-ai+sdk@2.2.11_encoding@0.1.13/node_modules/@mixedbread-ai/sdk/dist/api/client/requests/RerankingRequest.d.ts:21

returnInput?​

optional returnInput: boolean

Whether to return the documents.

Inherited from​

Omit.returnInput

Defined in​

node_modules/.pnpm/@mixedbread-ai+sdk@2.2.11_encoding@0.1.13/node_modules/@mixedbread-ai/sdk/dist/api/client/requests/RerankingRequest.d.ts:25

timeoutInSeconds?​

optional timeoutInSeconds: number

Timeouts for the request.

Defined in​

packages/llamaindex/src/postprocessors/rerankers/MixedbreadAIReranker.ts:48

topK?​

optional topK: number

The number of documents to return.

Inherited from​

Omit.topK

Defined in​

node_modules/.pnpm/@mixedbread-ai+sdk@2.2.11_encoding@0.1.13/node_modules/@mixedbread-ai/sdk/dist/api/client/requests/RerankingRequest.d.ts:23