# BAAI/bge-reranker-v2-m3

**BAAI/bge-reranker-v2-m3** é um modelo de reranking leve com fortes capacidades multilíngues. Ele é fácil de implementar e oferece inferência rápida.

## Detalhes do modelo

| Categoria | Detalhes |
|----------|---------|
| **Nome do modelo** | BAAI/bge-reranker-v2-m3 |
| **Versão** | Original |
| **Categoria do modelo** | Reranker |
| **Tamanho** | 568M parâmetros |
| **Modelo HuggingFace** | [BAAI/bge-reranker-v2-m3](https://huggingface.co/BAAI/bge-reranker-v2-m3) |
| **Licença** | [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/) |

## Capacidades

| Recurso | Detalhes |
|---------|--------|
  | Comprimento do contexto | 8k tokens |
| Suporta LoRA | ❌ |
| Dados de entrada | Texto |

## Uso 

### Exemplo de reranking

Este é um exemplo de uma requisição básica de reranking usando este modelo:

```ts
const modelResponse = await Azion.AI.run("baai-bge-reranker-v2-m3", {
  "query": "What is deep learning?",
  "documents": [
    "Deep learning is a subset of machine learning that uses neural networks with many layers",
    "The weather is nice today",
    "Deep learning enables computers to learn from large amounts of data",
    "I like pizza"
  ]
})
```

| Propriedade | Tipo | Descrição |
|------------|------|-------------|
| `query` | string | A consulta ou o prompt para ranquear os documentos. |
| `documents` | string[] | Um array de documentos a serem ranqueados com base na sua relevância para a consulta. |

### Exemplo de pontuação

Este é um exemplo de uma requisição básica de pontuação usando este modelo:

```ts
const modelResponse = await Azion.AI.run("baai-bge-reranker-v2-m3", {
  "text_1": "What is deep learning?",
  "text_2": [
    "Deep learning is a subset of machine learning that uses neural networks with many layers",
    "The weather is nice today",
    "Deep learning enables computers to learn from large amounts of data",
    "I like pizza"
  ]
})
```

| Propriedade | Tipo | Descrição |
|------------|------|-------------|
| `text_1` | string | O primeiro input de texto para o modelo processar. |
| `text_2` | string[] | Um array de inputs de texto para o modelo processar e dar uma pontuação. |

Exemplo de resposta:

```json
{
  "id": "rerank-356bf11f0e794f3c8f726bec7ba698bb",
  "model": "baai-bge-reranker-v2-m3",
  "usage": {
    "total_tokens": 78
  },
  "results": [
    {
      "index": 0,
      "document": {
        "text": "Deep learning is a subset of machine learning that uses neural networks with many layers"
      },
      "relevance_score": 0.99951171875
    },
    {
      "index": 2,
      "document": {
        "text": "Deep learning enables computers to learn from large amounts of data"
      },
      "relevance_score": 0.98291015625
    },
    {
      "index": 3,
      "document": {
        "text": "I like pizza"
      },
      "relevance_score": 0.00001621246337890625
    },
    {
      "index": 1,
      "document": {
        "text": "The weather is nice today"
      },
      "relevance_score": 0.000016033649444580078
    }
  ]
}
```

| Propriedade                   | Tipo   | Descrição                                                |
| --------------------------- | ------ | ---------------------------------------------------------- |
| `id`                        | string | Identificador único para a requisição de rerank.                |
| `model`                     | string | O nome do modelo usado para rerank.                  |
| `usage.total_tokens`        | number | O número total de tokens usados na requisição.            |
| `results[]`                   | object[] | Um array de resultado com os objetos reranqueados.                       |
| `results[].index`           | number | O índice do documento na lista de entrada.               |
| `results[].document`        | object | O objeto do documento contendo o texto.                   |
| `results[].document.text`   | string | O conteúdo textual do documento.                       |
| `results[].relevance_score` | number | A pontuação de relevância atribuída ao documento pelo modelo. |


## Schema JSON

```json
{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object",
    "required": [
        "query",
        "documents"
    ],
    "properties": {
        "query": {
            "type": "string"
        },
        "documents": {
            "type": "array",
            "items": {
                "type": "string"
            }
        },
        "top_n": {
            "type": "integer"
        },
        "max_tokens_per_doc": {
            "type": "integer"
        }
    }
}
```