bge-reranker-v2-m3
O codificador cruzado multilingue da BAAI para ordenar passagens candidatas face a uma consulta. Lê em conjunto cada par consulta–passagem e devolve uma pontuação de relevância, refinando uma lista restrita de pesquisa sem gerar uma resposta nem criar embeddings dos documentos.
Sobre o modelo
Esta descrição apresenta as capacidades do modelo. As entradas, saídas e opções disponíveis no Ailoot para o método selecionado estão indicadas abaixo.
BGE Reranker v2 M3 é um modelo de relevância multilingue baseado em BGE-M3. Recebe em conjunto uma consulta e uma passagem candidata e devolve uma pontuação para a relação entre elas. A BAAI posiciona esta edição como um reordenador multilingue eficiente, incluindo para recuperação em chinês e inglês, quando uma aplicação de pesquisa precisa de refinar uma lista de candidatos existente.
Relevância de um par consulta–passagem
Um codificador cruzado processa ambos os textos em conjunto, permitindo que os seus conteúdos interajam antes de produzir a pontuação de relevância. Isto difere de um modelo de embeddings, que codifica os textos de forma independente para comparação vetorial reutilizável. A saída do reordenador é uma pontuação escalar para um par específico, em vez de um vetor de documento ou de uma resposta escrita.
Utilize o modelo depois de uma pesquisa inicial selecionar passagens plausíveis. Associe a pergunta a cada candidato e ordene os candidatos pelas pontuações resultantes. Assim, a comparação mais detalhada concentra-se numa lista restrita gerível, em vez de pedir a um codificador cruzado que examine todas as passagens de uma coleção grande.
A edição v2 M3
O fabricante identifica BGE-M3 como modelo de base e indica o suporte multilingue como uma funcionalidade principal. Na família de reordenadores v2, M3 é a opção multilingue eficiente; as variantes baseadas em Gemma e com seleção de camadas são modelos distintos com opções de implementação diferentes. O nome M3 aqui não significa que o reordenador devolva os embeddings densos, esparsos e multivetoriais do modelo de embeddings original.
Esta distinção é relevante ao escolher o resultado de que a sua aplicação precisa. Selecione um modelo de embeddings para representar e pesquisar uma coleção de documentos. Selecione este reordenador quando já tem texto candidato e precisa de decidir qual a passagem mais relevante para a consulta atual.
Prepare candidatos que possam ser ordenados de forma útil
Forneça a pergunta real e o texto candidato completo necessário para a interpretar. Preserve cabeçalhos ou definições próximas quando determinarem o significado de uma passagem. No exemplo publicado de Transformers, a consulta e a passagem são tokenizadas em conjunto com truncamento e max_length=512. Trata-se de uma definição do exemplo, e não de um limite de todo o modelo. Mantenha a pergunta e os elementos necessários dentro do orçamento do par selecionado e verifique o que o truncamento remove. Um resultado que mencione o mesmo produto que uma consulta pode continuar a ser irrelevante se abordar a operação ou a condição errada; prepare exemplos que distingam esses casos ao avaliar a qualidade da recuperação.
Para um assistente documental, mantenha os identificadores dos candidatos junto do texto, pontue os pares pergunta–passagem e passe as passagens originais selecionadas para a etapa de resposta. O modelo de resposta recebe assim os elementos de prova, em vez de uma pontuação de relevância sem a respetiva fonte. Este é um fluxo de trabalho ilustrativo de recuperação; o próprio reordenador não pesquisa uma coleção externa nem escreve a resposta.
Leia e normalize as pontuações
O fabricante devolve pontuações de relevância em bruto, em que um valor mais elevado indica uma correspondência mais próxima. A normalização opcional documentada aplica uma função sigmoide para colocar a pontuação entre 0 e 1. Uma pontuação normalizada tem um intervalo conveniente, mas essa transformação, por si só, não estabelece uma probabilidade calibrada de o candidato estar correto.
Escolha limiares de ordenação ou filtragem com pares consulta–passagem representativos da sua carga de trabalho. Inclua passagens que partilhem palavras-chave mas respondam a uma pergunta diferente, bem como passagens relevantes com redação diferente. Isto torna o limiar selecionado significativo para a coleção pesquisada.
Num projeto com a API Ailoot, defina o conteúdo do contexto final e quantos candidatos podem ser examinados de forma eficiente. O resultado útil é um conjunto de provas melhor ordenado para a etapa seguinte da aplicação. Mantenha a saída de relevância desta edição separada dos embeddings de documentos, da prosa gerada e dos controlos de seleção de camadas documentados para outros reordenadores.
Ailoot Ultra · Reordenação POST /v1/rerank bge-reranker-v2-m3
bge-reranker-v2-m3Introdução
O codificador cruzado multilingue da BAAI para ordenar passagens candidatas face a uma consulta. Lê em conjunto cada par consulta–passagem e devolve uma pontuação de relevância, refinando uma lista restrita de pesquisa sem gerar uma resposta nem criar embeddings dos documentos.
- Entradas aceites
- Texto
- Resultados
- Resultados ordenados
Disponível no Ailoot · entradas e métodos
Ailoot Ultra · Reordenação POST /v1/rerank
- Entrada
text- Saída
rerank
| Campo | Tipo | Requisito | Valores e limites | Predefinição |
|---|---|---|---|---|
Campomodel | Tipostring | RequisitoObrigatório | Valores e limites bge-reranker-v2-m3 | Predefinição— |
Campoquery | Tipostring | RequisitoOpcional | Valores e limites | Predefinição— |
Campodocuments | Tipoarray | RequisitoObrigatório | Valores e limites | Predefinição— |
Parâmetros e ciclo de vida do método
| Parâmetro | Contrato |
|---|---|
Parâmetrocontent_type | Contratoapplication/json |
Parâmetrorequired | Contratomodel, documents |
Parâmetromaterial_types | Contratotext |
Parâmetromaterial_conditions | ContratoDefina a sua consulta real e uma matriz não vazia de documentos de texto originais. Os índices dos resultados referem-se a essa matriz original. |
Ciclo de vida: synchronous_result_then_owned_library
GET /v1/media/assets/{asset_id}/content
GET /v1/media/assets
GET /v1/media/assets/{asset_id}
Tarifários
As referências tarifárias não acrescentam opções ao pedido. Os parâmetros suportados constam do método selecionado.
- Modo rápido
- Não especificado Quando o modo rápido está selecionado
- Modo flex
- Não especificado Quando o modo flex está selecionado
- Esforço máximo de raciocínio
- Não especificado Quando o esforço máximo de raciocínio usa o ajuste predefinido (default)
Tarifas Ailoot
Preços por configuração
Associe cada custo às condições apresentadas. Use uma única tarifa para cada conjunto de configurações alternativas.
| Configuração | Tabela de tarifas | Unidade de faturação | Custo |
|---|---|---|---|
| ConfiguraçãoTarifas base por token | Tabela de tarifasTarifa base | Unidade de faturação— | Custo Entrada · Tokens de entrada — / 1K tokens Saída · Tokens de saída — / 1K tokens Entrada · Leitura da cache — / 1K tokens Entrada · Escrita na cache — / 1K tokens Entrada · Escrita na cache, 1 hora — / 1K tokens |
| Configuraçãotoken total | Tabela de tarifas— | Unidade de faturação/ 1K tokens | Custo Entrada · token total $0.00004 / 1K tokens |
O Ailoot reserva um montante estimado antes de um pedido. Após o resultado, liquida o custo final com base na utilização medida. No streaming, a liquidação usa o registo final de utilização. Como funcionam a reserva e a liquidação →
Exemplos de pedidos
Ailoot Ultra · Reordenação
set -eu
: "${AILOOT_API_KEY:?Set your Ailoot API key}"
: "${AILOOT_QUERY:?Set the actual documented input value}"
export AILOOT_QUERY
: "${AILOOT_DOCUMENTS_JSON:?Set the actual documented input value}"
export AILOOT_DOCUMENTS_JSON
python3 - <<'PY_REQUEST'
import json,os
from pathlib import Path
request={'model': 'bge-reranker-v2-m3', 'query': '${ACTUAL_QUERY}', 'documents': '${ACTUAL_DOCUMENTS}'}
request['query']=os.environ['AILOOT_QUERY']
request['documents']=json.loads(os.environ['AILOOT_DOCUMENTS_JSON'])
Path('request.json').write_text(json.dumps(request,ensure_ascii=False),encoding='utf-8')
PY_REQUEST
curl --fail-with-body --silent --show-error https://api.ailoot.ai/v1/rerank \
-H "Authorization: Bearer $AILOOT_API_KEY" -H 'Content-Type: application/json' \
--data-binary @request.json -D response-headers.txt -o response.bin
# Retain the complete response and headers, every actual output, original returned identifiers and all usage fields. Recover the original operation without submitting creation again.
Receber e guardar os resultados
Ailoot Ultra · Reordenação
Resultado JSON nativo original completo com o modelo de resposta configurado, os índices dos documentos originais, as pontuações de relevância, as cadeias de documentos e a utilização nativa de tokens. Conserve todos os campos reais de resultados e de utilização.
GET /v1/media/assets/{asset_id}/contentGET /v1/media/assetsGET /v1/media/assets/{asset_id}
Guardar todos os resultados concluídos
Guarde cada resposta, ficheiro e parte de conteúdo devolvidos na íntegra.
Conserve a resposta completa e os cabeçalhos, todos os resultados efetivamente produzidos, os identificadores originais devolvidos e todos os campos de utilização. Recupere a operação original sem voltar a enviar o pedido de criação.
Se for necessário verificar a resposta original
Conserve o X-Client-Request-ID real e a resposta completa. Consulte os recursos originais pertencentes ao utilizador e os respetivos URLs assinados exatos de conteúdo; nunca volte a enviar uma criação incerta.
Campos da resposta
| Campo | Tipo | Significado |
|---|---|---|
Campomodel | Tipostring | SignificadoModelo exato de resposta exigido pelo consumidor configurado da origem. |
Camporesults[].index | Tipointeger | SignificadoÍndice único do documento de entrada original. |
Camporesults[].relevance_score | Tiponumber | SignificadoPontuação finita de relevância. |
Camporesults[].document | Tipostring | SignificadoDocumento de texto original exigido por este consumidor de respostas configurado. |
Campousage.total_tokens | Tipointeger | SignificadoContagem nativa de tokens finita e não negativa exigida pelo tarifário atualmente aceite. |
Erros e passos seguintes
| Resposta | Condição | Passo seguinte |
|---|---|---|
Resposta400 · invalid_request_error | CondiçãoO corpo JSON ou o ID canónico explícito do modelo é inválido. | Passo seguinteConserve a resposta e corrija o campo indicado no pedido. |
Resposta401 · authentication_error | CondiçãoA chave API da Ailoot é inválida. | Passo seguinteUtilize a sua chave API autorizada da Ailoot. |
Resposta403 · permission_error | CondiçãoO grupo da chave não permite este método. | Passo seguinteConserve os detalhes do erro devolvido. |
Resposta404 · not_found_error | CondiçãoO método selecionado não tem uma rota autorizada. | Passo seguinteConserve os detalhes do erro devolvido. |
Resposta422 · price_unavailable | CondiçãoO tarifário aceite não consegue obter a quantidade de entrada ou o limite de que necessita. | Passo seguinteConserve a resposta; utilize a representação da entrada exigida pelo tarifário aceite. |
Resposta503 · | CondiçãoO armazenamento, a rota, o preço do método ou a reserva de que necessita não está disponível. | Passo seguinteConserve a resposta original completa. Uma reserva incerta não autoriza o reenvio. |
Resposta502 · billing_requires_check | CondiçãoO resultado, a utilização ou a liquidação original requer verificação. | Passo seguinteConserve o ID real do pedido e a resposta original. Consulte o registo existente pertencente ao utilizador; não volte a enviar o pedido de criação. |
Aliases
Aliases do modelo
Ailoot Ultra bge-reranker-v2-m3
Aliases dos caminhos dos métodos
Use os caminhos dos métodos indicados acima.
IDs de chamada relacionados
FAQ · bge-reranker-v2-m3
- Que entradas e resultados estão disponíveis?
POST /v1/rerank·bge-reranker-v2-m3:text→rerank- Que campos utiliza o pedido?
POST /v1/rerank·bge-reranker-v2-m3:model,query,documents