bge-reranker-v2-m3
BAAI:s flerspråkiga cross-encoder för att rangordna kandidatavsnitt mot en sökfråga. Den läser varje par av fråga och textavsnitt tillsammans och returnerar ett relevansvärde som förfinar ett begränsat sökurval utan att generera ett svar eller skapa dokumentinbäddningar.
Om modellen
Den här beskrivningen omfattar modellens förmågor. Tillgängliga indata, utdata och alternativ i Ailoot anges nedan för den valda metoden.
BGE Reranker v2 M3 är en flerspråkig relevansmodell byggd på BGE-M3. Den tar emot en fråga och ett kandidatavsnitt tillsammans och returnerar ett värde för deras relation. BAAI positionerar denna utgåva som en effektiv flerspråkig omrangordningsmodell, bland annat för informationssökning på kinesiska och engelska, där en sökapplikation behöver förfina en befintlig kandidatlista.
Relevans från ett par av fråga och textavsnitt
En cross-encoder bearbetar båda texterna gemensamt, vilket gör att deras innehåll kan samspela innan relevansvärdet produceras. Det skiljer sig från en inbäddningsmodell, som kodar texterna oberoende för återanvändbar vektorjämförelse. Omrangordningsmodellens utdata är ett skalärt värde för ett visst par, snarare än en dokumentvektor eller ett skriftligt svar.
Använd modellen efter att en inledande sökning har valt ut rimliga textavsnitt. Para ihop frågan med varje kandidat och ordna kandidaterna efter de resulterande värdena. Det koncentrerar den mer detaljerade jämförelsen till ett hanterbart urval i stället för att be en cross-encoder granska varje avsnitt i en stor samling.
Utgåvan v2 M3
Tillverkaren anger BGE-M3 som basmodell och listar flerspråkigt stöd som en huvudfunktion. Inom dess v2-familj av omrangordningsmodeller är M3 det effektiva flerspråkiga alternativet; de Gemma-baserade varianterna och varianterna med lagerval är skilda modeller med andra implementationsval. Namnet M3 betyder här inte att omrangordningsmodellen returnerar den ursprungliga inbäddningsmodellens täta, glesa och flervektorsinbäddningar.
Den skillnaden är viktig när du väljer vilket resultat applikationen behöver. Välj en inbäddningsmodell för att representera och söka i en dokumentsamling. Välj denna omrangordningsmodell när du redan har kandidattext och behöver avgöra vilket avsnitt som är mest relevant för den aktuella frågan.
Förbered kandidater som kan rangordnas på ett användbart sätt
Tillhandahåll den faktiska frågan och hela den kandidattext som behövs för att tolka den. Behåll rubriker eller närliggande definitioner när de avgör ett avsnitts betydelse. I det publicerade Transformers-exemplet tokeniseras frågan och avsnittet tillsammans med trunkering och max_length=512. Det är en exempelinställning snarare än en gräns för hela modellen. Håll frågan och nödvändiga belägg inom den valda budgeten för paret och kontrollera vad trunkeringen tar bort. Ett resultat som nämner samma produkt som frågan kan fortfarande vara irrelevant om det handlar om fel åtgärd eller villkor; förbered exempel som skiljer dessa fall åt när du utvärderar sökkvaliteten.
För en dokumentassistent, behåll kandidatidentifierare tillsammans med texten, poängsätt paren av fråga och avsnitt och skicka de utvalda originalavsnitten vidare till svarsteget. Svarsmodellen får då beläggen i stället för ett relevansvärde utan källa. Det är ett illustrativt sökflöde; själva omrangordningsmodellen söker varken i en extern samling eller skriver svaret.
Läs och normalisera värden
Tillverkaren returnerar råa relevansvärden, där ett högre värde anger en närmare matchning. Den dokumenterade valfria normaliseringen använder en sigmoidfunktion för att placera värdet mellan 0 och 1. Ett normaliserat värde har ett praktiskt intervall, men enbart den omvandlingen fastställer inte en kalibrerad sannolikhet för att kandidaten är korrekt.
Välj trösklar för rangordning eller filtrering med representativa par av fråga och textavsnitt från din arbetsbelastning. Inkludera avsnitt som delar nyckelord men besvarar en annan fråga, liksom relevanta avsnitt med andra formuleringar. Det gör den valda tröskeln meningsfull för samlingen som genomsöks.
För ett Ailoot API-projekt, definiera vad den slutliga kontexten ska innehålla och hur många kandidater som kan granskas effektivt. Det användbara resultatet är en bättre ordnad uppsättning belägg för applikationens nästa steg. Håll denna utgåvas relevansutdata åtskilda från dokumentinbäddningar, genererad prosa och de reglage för lagerval som dokumenteras för andra omrangordningsmodeller.
Ailoot Ultra · Omrangordning POST /v1/rerank bge-reranker-v2-m3
bge-reranker-v2-m3Start
BAAI:s flerspråkiga cross-encoder för att rangordna kandidatavsnitt mot en sökfråga. Den läser varje par av fråga och textavsnitt tillsammans och returnerar ett relevansvärde som förfinar ett begränsat sökurval utan att generera ett svar eller skapa dokumentinbäddningar.
- Godkända indata
- Text
- Resultat
- Rangordnade resultat
Tillgängligt i Ailoot · indata & metoder
Ailoot Ultra · Omrangordning POST /v1/rerank
- Indatatyper
text- Utdatatyper
rerank
| Fält | Typ | Krav | Värden & gränser | Standard |
|---|---|---|---|---|
Fältmodel | Typstring | KravObligatoriskt | Värden & gränser bge-reranker-v2-m3 | Standard— |
Fältquery | Typstring | KravValfritt | Värden & gränser | Standard— |
Fältdocuments | Typarray | KravObligatoriskt | Värden & gränser | Standard— |
Metodparametrar och livscykel
| Parameter | Avtal |
|---|---|
Parametercontent_type | Avtalapplication/json |
Parameterrequired | Avtalmodel, documents |
Parametermaterial_types | Avtaltext |
Parametermaterial_conditions | AvtalAnge din faktiska fråga och en icke-tom array med de ursprungliga textdokumenten. Resultatens index hänvisar till den ursprungliga arrayen. |
Livscykel: synchronous_result_then_owned_library
GET /v1/media/assets/{asset_id}/content
GET /v1/media/assets
GET /v1/media/assets/{asset_id}
Priser
Tariffuppgifter lägger inte till begäransalternativ. Parametrar som stöds anges för den valda metoden.
- Snabbt läge
- Ej angivet När snabbt läge är valt
- Flex-läge
- Ej angivet När läget flex är valt
- Högsta resonemangsnivå
- Ej angivet När den högsta resonemangsnivån använder standardjusteringen (default)
Ailoot-priser
Priser efter konfiguration
Matcha varje avgift mot de visade villkoren. Använd ett pris för varje uppsättning alternativa konfigurationer.
| Konfiguration | Prislista | Debiteringsenhet | Avgift |
|---|---|---|---|
| KonfigurationGrundpriser för token | PrislistaGrundpris | Debiteringsenhet— | Avgift Indata · Indatatoken — / 1K token Utdata · Utdatatoken — / 1K token Indata · Cacheläsning — / 1K token Indata · Skrivning till cache — / 1K token Indata · Skrivning till cache, 1 tim — / 1K token |
| Konfigurationtotalt antal token | Prislista— | Debiteringsenhet/ 1K token | Avgift Indata · totalt antal token $0.00004 / 1K token |
Ailoot reserverar ett uppskattat belopp före en begäran. Efter resultatet slutregleras avgiften utifrån uppmätt förbrukning. Slutreglering för strömning använder den slutliga förbrukningsposten. Så fungerar reservation och slutreglering →
Exempelbegäranden
Ailoot Ultra · Omrangordning
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.
Ta emot och spara resultat
Ailoot Ultra · Omrangordning
Hela det ursprungliga JSON-resultatet i leverantörens format med den konfigurerade svarsmodellen, ursprungliga dokumentindex, relevansvärden, dokumentsträngar och leverantörens tokenförbrukning. Behåll varje faktiskt resultat- och förbrukningsfält.
GET /v1/media/assets/{asset_id}/contentGET /v1/media/assetsGET /v1/media/assets/{asset_id}
Behåll alla färdiga resultat
Behåll varje fullständigt returnerat svar, fil och innehållsdel.
Spara hela svaret med headers, samtliga faktiska resultat, de ursprungliga returnerade identifierarna och alla användningsfält. Hämta den ursprungliga operationen utan att skicka skapandeförfrågan igen.
Om det ursprungliga svaret behöver kontrolleras
Behåll faktiskt X-Client-Request-ID och hela svaret. Läs de ursprungliga tillgångarna som du äger och deras exakta signerade innehållslänkar; skicka aldrig en osäker skapandebegäran igen.
Svarsfält
| Fält | Typ | Betydelse |
|---|---|---|
Fältmodel | Typstring | BetydelseExakt svarsmodell som krävs av den konfigurerade källkonsumenten. |
Fältresults[].index | Typinteger | BetydelseUnikt index för det ursprungliga indatadokumentet. |
Fältresults[].relevance_score | Typnumber | BetydelseÄndligt relevansvärde. |
Fältresults[].document | Typstring | BetydelseUrsprungligt textdokument som krävs av denna konfigurerade svarskonsument. |
Fältusage.total_tokens | Typinteger | BetydelseÄndligt, icke-negativt tokenantal i leverantörens format som krävs av den aktuella accepterade tariffen. |
Fel och nästa steg
| Svar | Villkor | Nästa steg |
|---|---|---|
Svar400 · invalid_request_error | VillkorJSON-kroppen eller det uttryckliga kanoniska modell-ID:t är ogiltigt. | Nästa stegBehåll svaret och korrigera det angivna fältet i begäran. |
Svar401 · authentication_error | VillkorAPI-nyckeln för Ailoot är ogiltig. | Nästa stegAnvänd din behöriga API-nyckel för Ailoot. |
Svar403 · permission_error | VillkorNyckelgruppen ger inte tillträde till denna metod. | Nästa stegBehåll de returnerade feluppgifterna. |
Svar404 · not_found_error | VillkorDen valda metoden har ingen tillåten rutt. | Nästa stegBehåll de returnerade feluppgifterna. |
Svar422 · price_unavailable | VillkorDen accepterade tariffen kan inte fastställa den mängd eller gräns för indata som krävs. | Nästa stegBehåll svaret; använd den representation av indata som den accepterade tariffen kräver. |
Svar503 · | VillkorNödvändig lagring, rutt, metodpris eller reservation är inte tillgänglig. | Nästa stegBehåll hela det ursprungliga svaret. En osäker reservation ger inte tillstånd att skicka in igen. |
Svar502 · billing_requires_check | VillkorDet ursprungliga resultatet, förbrukningen eller avräkningen kräver kontroll. | Nästa stegBehåll det faktiska begärans-ID:t och det ursprungliga svaret. Läs den befintliga posten som du äger; skicka inte skapandebegäran igen. |
Alias
Modellalias
Ailoot Ultra bge-reranker-v2-m3
Alias för metodsökvägar
Använd metodsökvägarna som visas ovan.
Relaterade anropar-ID:n
FAQ · bge-reranker-v2-m3
- Vilka indata och resultat finns?
POST /v1/rerank·bge-reranker-v2-m3:text→rerank- Vilka fält använder begäran?
POST /v1/rerank·bge-reranker-v2-m3:model,query,documents