Skip to content

Commit d6b9ca1

Browse files
devvratbhardwajskeptrunedev
authored andcommitted
1. Added AIMon reranker to Trieve search.
2. Updated the link to Cohere's official documentation. 3.Modified the BAAI bge-reranker section. 4. Capitalized c where applicable for Cohere
1 parent 27a4aa7 commit d6b9ca1

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

guides/searching-with-trieve.mdx

+34-6
Original file line numberDiff line numberDiff line change
@@ -301,15 +301,15 @@ After creating a dataset, you cannot change the embedding model. If you need to
301301

302302
Trieve supports multiple reranker models that can be used to rerank the search results.
303303

304-
Currently, Trieve supports `bge-reranker-large` and cohere's `rerank-v3.5` model.
304+
Currently, Trieve supports the BAAI `bge-reranker-large` model, AIMon's `aimon-rerank` model, and Cohere's `rerank-v3.5` model.
305305

306306
![](https://cdn.trieve.ai/docs/reranker-model-edit.png)
307307

308308
#### BAAI/bge-reranker-large
309309

310-
`bge-reranker-large` is a model by the Beijing Academy of Artificial Intelligence (BAAI) and is hosted by Trieve. This model does not require any additional configuration. and will be used by default on all `hybrid` searches.
310+
`bge-reranker-large` is a model by the Beijing Academy of Artificial Intelligence (BAAI) and is hosted by Trieve. This model does not require any additional configuration and will be used by default on all `hybrid` searches.
311311

312-
To switch your reranker model to cohere's `bge-reranker-large`, make a request to the [update dataset route](/api-reference/dataset/update-dataset-by-id-or-tracking-id). With the following Parameters
312+
To manually select the `bge-reranker-large` as your reranker model, make a request to the [update dataset route](/api-reference/dataset/update-dataset-by-id-or-tracking-id) with the following parameters:
313313

314314
```json
315315
curl --request POST \
@@ -328,11 +328,39 @@ curl --request POST \
328328
}'
329329
```
330330

331-
#### Cohere rerank-v3.5
331+
#### AIMon's aimon-rerank
332332

333-
`rerank-v3.5` is a model hosted by docs.cohere.com. To use this model, you must provide the `cohere_api_key` in the `server_configuration` field when creating a dataset.
333+
`aimon-rerank` is a model hosted by [AIMon](https://docs.aimon.ai/). To use this model, you must provide the `aimon_api_key` in the `server_configuration` field when creating a dataset.
334334

335-
To switch your reranker model to cohere's `rerank-v3.5`, make a request to the [update dataset route](/api-reference/dataset/update-dataset-by-id-or-tracking-id). With the following Parameters
335+
To switch your reranker model to AIMon's `aimon-rerank`, make a request to the [update dataset route](/api-reference/dataset/update-dataset-by-id-or-tracking-id) with the following parameters:
336+
337+
```json
338+
curl --request POST \
339+
--url https://api.trieve.ai/api/dataset \
340+
--header 'Authorization: <api-key>' \
341+
--header 'Content-Type: application/json' \
342+
--header 'TR-Organization: <tr-organization>' \
343+
--data '{
344+
"dataset_name": "New Dataset", // Replace with a name for your dataset
345+
"organization_id": "********-****-****-****-************",
346+
347+
// Update with the desired configurations for your dataset
348+
"server_configuration": {
349+
"RERANKER_BASE_URL":"https://pbe-api.aimon.ai/v1/rerank-icl",
350+
"RERANKER_MODEL_NAME":"aimon-rerank",
351+
"RERANKER_API_KEY":"<aimon_api_key>",
352+
"AIMON_RERANKER_TASK_DEFINITION": "<a_task_definition>"
353+
// A task definition can be used to specify the domain of the context documents for AIMon reranker.
354+
// example of a task definition: "Your task is to grade the relevance of context document(s) in the domain of music and arts."
355+
}
356+
}'
357+
```
358+
359+
#### Cohere's rerank-v3.5
360+
361+
`rerank-v3.5` is a model hosted by [Cohere](https://docs.cohere.com/cohere-documentation). To use this model, you must provide the `cohere_api_key` in the `server_configuration` field when creating a dataset.
362+
363+
To switch your reranker model to Cohere's `rerank-v3.5`, make a request to the [update dataset route](/api-reference/dataset/update-dataset-by-id-or-tracking-id) with the following parameters:
336364

337365
```json
338366
curl --request POST \

0 commit comments

Comments
 (0)